2021-01-01 03:01:13 +00:00
|
|
|
# Copyright 2020 Google LLC
|
|
|
|
|
#
|
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
|
#
|
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
#
|
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
|
|
|
|
require 'google/apis/core/base_service'
|
|
|
|
|
require 'google/apis/core/json_representation'
|
|
|
|
|
require 'google/apis/core/hashable'
|
|
|
|
|
require 'google/apis/errors'
|
|
|
|
|
|
|
|
|
|
module Google
|
|
|
|
|
module Apis
|
|
|
|
|
module DataflowV1b3
|
|
|
|
|
# Dataflow API
|
|
|
|
|
#
|
|
|
|
|
# Manages Google Cloud Dataflow projects on Google Cloud Platform.
|
|
|
|
|
#
|
|
|
|
|
# @example
|
|
|
|
|
# require 'google/apis/dataflow_v1b3'
|
|
|
|
|
#
|
|
|
|
|
# Dataflow = Google::Apis::DataflowV1b3 # Alias the module
|
|
|
|
|
# service = Dataflow::DataflowService.new
|
|
|
|
|
#
|
|
|
|
|
# @see https://cloud.google.com/dataflow
|
|
|
|
|
class DataflowService < Google::Apis::Core::BaseService
|
|
|
|
|
# @return [String]
|
|
|
|
|
# API key. Your API key identifies your project and provides you with API access,
|
|
|
|
|
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
|
|
|
|
attr_accessor :key
|
|
|
|
|
|
|
|
|
|
# @return [String]
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
attr_accessor :quota_user
|
|
|
|
|
|
|
|
|
|
def initialize
|
2021-01-01 17:40:59 +00:00
|
|
|
super('https://dataflow.googleapis.com/', '',
|
|
|
|
|
client_name: 'google-apis-dataflow_v1b3',
|
|
|
|
|
client_version: Google::Apis::DataflowV1b3::GEM_VERSION)
|
2021-01-01 03:01:13 +00:00
|
|
|
@batch_path = 'batch'
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes a snapshot.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the snapshot belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The location that contains this snapshot.
|
|
|
|
|
# @param [String] snapshot_id
|
|
|
|
|
# The ID of the snapshot.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::DeleteSnapshotResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_project_snapshots(project_id, location: nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:delete, 'v1b3/projects/{projectId}/snapshots', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['snapshotId'] = snapshot_id unless snapshot_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Send a worker_message to the service.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project to send the WorkerMessages to.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::SendWorkerMessagesRequest] send_worker_messages_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def worker_project_messages(project_id, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/WorkerMessages', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesRequest::Representation
|
|
|
|
|
command.request_object = send_worker_messages_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a new TemplateVersion (Important: not new Template) entry in the
|
|
|
|
|
# spanner table. Requires project_id and display_name (template).
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# The location of the template, name includes project_id and display_name.
|
|
|
|
|
# Commit using project_id(pid1) and display_name(tid1). Format: projects/`pid1`/
|
|
|
|
|
# catalogTemplates/`tid1`
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::CommitTemplateVersionRequest] commit_template_version_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::TemplateVersion]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def commit_catalog_template_template_version(name, commit_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/{+name}:commit', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::CommitTemplateVersionRequest::Representation
|
|
|
|
|
command.request_object = commit_template_version_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes an existing Template. Do nothing if Template does not exist.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# name includes project_id and display_name. Delete by project_id(pid1) and
|
|
|
|
|
# display_name(tid1). Format: projects/`pid1`/catalogTemplates/`tid1`
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_project_catalog_template(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:delete, 'v1b3/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Empty
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Get TemplateVersion using project_id and display_name with an optional
|
|
|
|
|
# version_id field. Get latest (has tag "latest") TemplateVersion if version_id
|
|
|
|
|
# not set.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Resource name includes project_id and display_name. version_id is optional.
|
|
|
|
|
# Get the latest TemplateVersion if version_id not set. Get by project_id(pid1)
|
|
|
|
|
# and display_name(tid1): Format: projects/`pid1`/catalogTemplates/`tid1` Get by
|
|
|
|
|
# project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
|
|
|
|
|
# pid1`/catalogTemplates/`tid1@vid`
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::TemplateVersion]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_catalog_template(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Updates the label of the TemplateVersion. Label can be duplicated in Template,
|
|
|
|
|
# so either add or remove the label in the TemplateVersion.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Resource name includes project_id, display_name, and version_id. Updates by
|
|
|
|
|
# project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
|
|
|
|
|
# pid1`/catalogTemplates/`tid1@vid`
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest] modify_template_version_label_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def label_project_catalog_template(name, modify_template_version_label_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/{+name}:label', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest::Representation
|
|
|
|
|
command.request_object = modify_template_version_label_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Updates the tag of the TemplateVersion, and tag is unique in Template. If tag
|
|
|
|
|
# exists in another TemplateVersion in the Template, updates the tag to this
|
|
|
|
|
# TemplateVersion will remove it from the old TemplateVersion and add it to this
|
|
|
|
|
# TemplateVersion. If request is remove_only (remove_only = true), remove the
|
|
|
|
|
# tag from this TemplateVersion.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Resource name includes project_id, display_name, and version_id. Updates by
|
|
|
|
|
# project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
|
|
|
|
|
# pid1`/catalogTemplates/`tid1@vid`
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest] modify_template_version_tag_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def tag_project_catalog_template(name, modify_template_version_tag_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/{+name}:tag', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest::Representation
|
|
|
|
|
command.request_object = modify_template_version_tag_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a new Template with TemplateVersion. Requires project_id(projects) and
|
|
|
|
|
# template display_name(catalogTemplates). The template display_name is set by
|
|
|
|
|
# the user.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# The parent project and template that the TemplateVersion will be created under.
|
|
|
|
|
# Create using project_id(pid1) and display_name(tid1). Format: projects/`pid1`/
|
|
|
|
|
# catalogTemplates/`tid1`
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::CreateTemplateVersionRequest] create_template_version_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::TemplateVersion]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def create_template_version(parent, create_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/{+parent}/templateVersions', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::CreateTemplateVersionRequest::Representation
|
|
|
|
|
command.request_object = create_template_version_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# List the jobs of a project across all regions.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project which owns the jobs.
|
|
|
|
|
# @param [String] filter
|
|
|
|
|
# The kind of filter to use.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# If there are many jobs, limit response to at most this many. The actual number
|
|
|
|
|
# of jobs returned will be the lesser of max_responses and an unspecified server-
|
|
|
|
|
# defined limit.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Set this to the 'next_page_token' field of a previous response to request
|
|
|
|
|
# additional results in a long list.
|
|
|
|
|
# @param [String] view
|
feat: Automated regeneration of dataflow v1b3 client (#2429)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2021-01-19 16:05:25,957 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-dataflow-v1b3
nothing to commit, working tree clean
2021-01-19 16:05:26,033 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dataflow v1b3
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dataflow v1b3
git clean -df
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Fetching minitest 5.14.3
Fetching public_suffix 4.0.6
Fetching zeitwerk 2.4.2
Installing zeitwerk 2.4.2
Installing minitest 5.14.3
Installing public_suffix 4.0.6
Installing concurrent-ruby 1.1.7
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.2.6
Fetching coderay 1.1.3
Fetching byebug 11.1.3
Installing coderay 1.1.3
Installing byebug 11.1.3 with native extensions
Fetching json 2.5.1
Installing json 2.5.1 with native extensions
Fetching docile 1.3.5
Installing docile 1.3.5
Fetching simplecov-html 0.10.2
Using sync 0.5.0
Fetching thor 1.0.1
Installing simplecov-html 0.10.2
Installing thor 1.0.1
Fetching rexml 3.2.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Installing rexml 3.2.4
Fetching declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing declarative-option 0.1.0
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching faraday-net_http 1.0.1
Installing faraday-net_http 1.0.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.4
Fetching gems 1.2.0
Installing ruby2_keywords 0.0.4
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Fetching multi_json 1.15.0
Installing memoist 0.16.2
Installing multi_json 1.15.0
Fetching os 0.9.6
Fetching httpclient 2.8.3
Installing os 0.9.6
Fetching mini_mime 1.0.2
Installing httpclient 2.8.3
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Installing hashdiff 1.0.1
Installing mime-types-data 3.2020.1104
Fetching rspec-support 3.10.1
Fetching little-plugger 1.1.4
Installing rspec-support 3.10.1
Installing little-plugger 1.1.4
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.20.1
Installing parallel 1.20.1
Fetching powerpack 0.1.3
Installing powerpack 0.1.3
Fetching yard 0.9.26
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Installing yard 0.9.26
Fetching redcarpet 3.5.1
Fetching redis 3.3.5
Installing redcarpet 3.5.1 with native extensions
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.11.0
Installing ruby-progressbar 1.11.0
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching parser 2.7.2.0
Fetching addressable 2.7.0
Installing addressable 2.7.0
Installing parser 2.7.2.0
Fetching i18n 1.8.7
Installing i18n 1.8.7
Fetching tzinfo 2.0.4
Fetching tins 1.28.0
Installing tins 1.28.0
Installing tzinfo 2.0.4
Fetching crack 0.4.5
Installing crack 0.4.5
Fetching faraday 1.3.0
Installing faraday 1.3.0
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching pry 0.13.1
Fetching rspec-core 3.10.1
Installing pry 0.13.1
Installing rspec-core 3.10.1
Fetching rspec-expectations 3.10.1
Installing rspec-expectations 3.10.1
Fetching rspec-mocks 3.10.1
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Installing rspec-mocks 3.10.1
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Fetching activesupport 6.1.1
Fetching signet 0.14.0
Installing signet 0.14.0
Installing activesupport 6.1.1
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching pry-doc 0.13.5
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Installing pry-doc 0.13.5
Fetching google-apis-core 0.2.0
Installing google-apis-core 0.2.0
Fetching google-apis-discovery_v1 0.1.0
Installing google-apis-discovery_v1 0.1.0
Using google-apis-generator 0.1.2 from source at `.`
Bundle complete! 25 Gemfile dependencies, 81 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen /workspace/generated --api=dataflow.v1b3 --names=/workspace/api_names.yaml --names-out=/workspace/api_names_out.yaml --spot-check
Loading dataflow, version v1b3 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/dataflow.v1b3.json
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/classes.rb
<ow_v1b3/classes.rb? (enter "h" for help) [Ynaqdhm] a
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/classes.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/representations.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/representations.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/service.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/service.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/gem_version.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/gem_version.rb
conflict google-apis-dataflow_v1b3/CHANGELOG.md
force google-apis-dataflow_v1b3/CHANGELOG.md
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Using rake 13.0.3
Using public_suffix 4.0.6
Using bundler 2.2.6
Using declarative 0.0.20
Using declarative-option 0.1.0
Using diff-lcs 1.4.4
Using faraday-net_http 1.0.1
Using multipart-post 2.1.1
Using ruby2_keywords 0.0.4
Using jwt 2.2.2
Using memoist 0.16.2
Using multi_json 1.15.0
Using httpclient 2.8.3
Using mini_mime 1.0.2
Using uber 0.1.0
Using retriable 3.1.2
Using rexml 3.2.4
Using opencensus 0.5.0
Using redcarpet 3.5.1
Using rspec-support 3.10.1
Using yard 0.9.26
Fetching os 1.1.1
Using addressable 2.7.0
Using representable 3.0.4
Using faraday 1.3.0
Using rspec-core 3.10.1
Using rspec-expectations 3.10.1
Using rspec-mocks 3.10.1
Using signet 0.14.0
Using rspec 3.10.0
Installing os 1.1.1
Using googleauth 0.14.0
Using google-apis-core 0.2.0
Using google-apis-dataflow_v1b3 0.2.0 from source at `.`
Bundle complete! 8 Gemfile dependencies, 33 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
/root/.rbenv/versions/2.6.6/bin/ruby -I/root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-core-3.10.1/lib:/root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-support-3.10.1/lib /root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-core-3.10.1/exe/rspec --pattern spec/\*\*\{,/\*/\*\*\}/\*_spec.rb
Google::Apis::DataflowV1b3
should load
Finished in 0.40996 seconds (files took 0.10982 seconds to load)
1 example, 0 failures
Files: 4
Modules: 3 ( 1 undocumented)
Classes: 171 ( 0 undocumented)
Constants: 8 ( 0 undocumented)
Attributes: 449 ( 0 undocumented)
Methods: 390 ( 0 undocumented)
99.90% documented
google-apis-dataflow_v1b3 0.2.0 built to pkg/google-apis-dataflow_v1b3-0.2.0.gem.
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2021-01-19 16:06:10,002 synthtool [DEBUG] > Wrote metadata to generated/google-apis-dataflow_v1b3/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google-apis-dataflow_v1b3/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/b9a73516-7203-45da-9706-97b9e64348be/targets
- [ ] To automatically regenerate this PR, check this box.
2021-01-20 00:26:03 +00:00
|
|
|
# Deprecated. ListJobs always returns summaries now. Use GetJob for other
|
|
|
|
|
# JobViews.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListJobsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def aggregated_project_job(project_id, filter: nil, location: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs:aggregated', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['filter'] = filter unless filter.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a Cloud Dataflow job. To create a job, we recommend using `projects.
|
|
|
|
|
# locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/
|
|
|
|
|
# dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is
|
|
|
|
|
# not recommended, as your job will always start in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::Job] job_object
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [String] replace_job_id
|
|
|
|
|
# Deprecated. This field is now in the Job message.
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The level of information requested in response.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Job]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def create_project_job(project_id, job_object = nil, location: nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.request_object = job_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Job
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Gets the state of the specified Cloud Dataflow job. To get the state of a job,
|
|
|
|
|
# we recommend using `projects.locations.jobs.get` with a [regional endpoint] (
|
|
|
|
|
# https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `
|
|
|
|
|
# projects.jobs.get` is not recommended, as you can only get the state of jobs
|
|
|
|
|
# that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job ID.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The level of information requested in response.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Job]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_job(project_id, job_id, location: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Job
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Request the job status. To request the status of a job, we recommend using `
|
|
|
|
|
# projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.
|
|
|
|
|
# google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.
|
|
|
|
|
# getMetrics` is not recommended, as you can only request the status of jobs
|
|
|
|
|
# that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# A project id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job to get metrics for.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job specified by job_id.
|
|
|
|
|
# @param [String] start_time
|
|
|
|
|
# Return only metric data that has changed since this time. Default is to return
|
|
|
|
|
# all information about all metrics for the job.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::JobMetrics] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::JobMetrics]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_job_metrics(project_id, job_id, location: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}/metrics', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::JobMetrics::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::JobMetrics
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['startTime'] = start_time unless start_time.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# List the jobs of a project. To list the jobs of a project in a region, we
|
|
|
|
|
# recommend using `projects.locations.jobs.list` with a [regional endpoint] (
|
|
|
|
|
# https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list
|
|
|
|
|
# the all jobs across all regions, use `projects.jobs.aggregated`. Using `
|
|
|
|
|
# projects.jobs.list` is not recommended, as you can only get the list of jobs
|
|
|
|
|
# that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project which owns the jobs.
|
|
|
|
|
# @param [String] filter
|
|
|
|
|
# The kind of filter to use.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# If there are many jobs, limit response to at most this many. The actual number
|
|
|
|
|
# of jobs returned will be the lesser of max_responses and an unspecified server-
|
|
|
|
|
# defined limit.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Set this to the 'next_page_token' field of a previous response to request
|
|
|
|
|
# additional results in a long list.
|
|
|
|
|
# @param [String] view
|
feat: Automated regeneration of dataflow v1b3 client (#2429)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2021-01-19 16:05:25,957 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-dataflow-v1b3
nothing to commit, working tree clean
2021-01-19 16:05:26,033 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dataflow v1b3
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dataflow v1b3
git clean -df
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Fetching minitest 5.14.3
Fetching public_suffix 4.0.6
Fetching zeitwerk 2.4.2
Installing zeitwerk 2.4.2
Installing minitest 5.14.3
Installing public_suffix 4.0.6
Installing concurrent-ruby 1.1.7
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.2.6
Fetching coderay 1.1.3
Fetching byebug 11.1.3
Installing coderay 1.1.3
Installing byebug 11.1.3 with native extensions
Fetching json 2.5.1
Installing json 2.5.1 with native extensions
Fetching docile 1.3.5
Installing docile 1.3.5
Fetching simplecov-html 0.10.2
Using sync 0.5.0
Fetching thor 1.0.1
Installing simplecov-html 0.10.2
Installing thor 1.0.1
Fetching rexml 3.2.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Installing rexml 3.2.4
Fetching declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing declarative-option 0.1.0
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching faraday-net_http 1.0.1
Installing faraday-net_http 1.0.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.4
Fetching gems 1.2.0
Installing ruby2_keywords 0.0.4
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Fetching multi_json 1.15.0
Installing memoist 0.16.2
Installing multi_json 1.15.0
Fetching os 0.9.6
Fetching httpclient 2.8.3
Installing os 0.9.6
Fetching mini_mime 1.0.2
Installing httpclient 2.8.3
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Installing hashdiff 1.0.1
Installing mime-types-data 3.2020.1104
Fetching rspec-support 3.10.1
Fetching little-plugger 1.1.4
Installing rspec-support 3.10.1
Installing little-plugger 1.1.4
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.20.1
Installing parallel 1.20.1
Fetching powerpack 0.1.3
Installing powerpack 0.1.3
Fetching yard 0.9.26
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Installing yard 0.9.26
Fetching redcarpet 3.5.1
Fetching redis 3.3.5
Installing redcarpet 3.5.1 with native extensions
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.11.0
Installing ruby-progressbar 1.11.0
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching parser 2.7.2.0
Fetching addressable 2.7.0
Installing addressable 2.7.0
Installing parser 2.7.2.0
Fetching i18n 1.8.7
Installing i18n 1.8.7
Fetching tzinfo 2.0.4
Fetching tins 1.28.0
Installing tins 1.28.0
Installing tzinfo 2.0.4
Fetching crack 0.4.5
Installing crack 0.4.5
Fetching faraday 1.3.0
Installing faraday 1.3.0
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching pry 0.13.1
Fetching rspec-core 3.10.1
Installing pry 0.13.1
Installing rspec-core 3.10.1
Fetching rspec-expectations 3.10.1
Installing rspec-expectations 3.10.1
Fetching rspec-mocks 3.10.1
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Installing rspec-mocks 3.10.1
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Fetching activesupport 6.1.1
Fetching signet 0.14.0
Installing signet 0.14.0
Installing activesupport 6.1.1
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching pry-doc 0.13.5
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Installing pry-doc 0.13.5
Fetching google-apis-core 0.2.0
Installing google-apis-core 0.2.0
Fetching google-apis-discovery_v1 0.1.0
Installing google-apis-discovery_v1 0.1.0
Using google-apis-generator 0.1.2 from source at `.`
Bundle complete! 25 Gemfile dependencies, 81 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen /workspace/generated --api=dataflow.v1b3 --names=/workspace/api_names.yaml --names-out=/workspace/api_names_out.yaml --spot-check
Loading dataflow, version v1b3 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/dataflow.v1b3.json
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/classes.rb
<ow_v1b3/classes.rb? (enter "h" for help) [Ynaqdhm] a
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/classes.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/representations.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/representations.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/service.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/service.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/gem_version.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/gem_version.rb
conflict google-apis-dataflow_v1b3/CHANGELOG.md
force google-apis-dataflow_v1b3/CHANGELOG.md
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Using rake 13.0.3
Using public_suffix 4.0.6
Using bundler 2.2.6
Using declarative 0.0.20
Using declarative-option 0.1.0
Using diff-lcs 1.4.4
Using faraday-net_http 1.0.1
Using multipart-post 2.1.1
Using ruby2_keywords 0.0.4
Using jwt 2.2.2
Using memoist 0.16.2
Using multi_json 1.15.0
Using httpclient 2.8.3
Using mini_mime 1.0.2
Using uber 0.1.0
Using retriable 3.1.2
Using rexml 3.2.4
Using opencensus 0.5.0
Using redcarpet 3.5.1
Using rspec-support 3.10.1
Using yard 0.9.26
Fetching os 1.1.1
Using addressable 2.7.0
Using representable 3.0.4
Using faraday 1.3.0
Using rspec-core 3.10.1
Using rspec-expectations 3.10.1
Using rspec-mocks 3.10.1
Using signet 0.14.0
Using rspec 3.10.0
Installing os 1.1.1
Using googleauth 0.14.0
Using google-apis-core 0.2.0
Using google-apis-dataflow_v1b3 0.2.0 from source at `.`
Bundle complete! 8 Gemfile dependencies, 33 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
/root/.rbenv/versions/2.6.6/bin/ruby -I/root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-core-3.10.1/lib:/root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-support-3.10.1/lib /root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-core-3.10.1/exe/rspec --pattern spec/\*\*\{,/\*/\*\*\}/\*_spec.rb
Google::Apis::DataflowV1b3
should load
Finished in 0.40996 seconds (files took 0.10982 seconds to load)
1 example, 0 failures
Files: 4
Modules: 3 ( 1 undocumented)
Classes: 171 ( 0 undocumented)
Constants: 8 ( 0 undocumented)
Attributes: 449 ( 0 undocumented)
Methods: 390 ( 0 undocumented)
99.90% documented
google-apis-dataflow_v1b3 0.2.0 built to pkg/google-apis-dataflow_v1b3-0.2.0.gem.
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2021-01-19 16:06:10,002 synthtool [DEBUG] > Wrote metadata to generated/google-apis-dataflow_v1b3/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google-apis-dataflow_v1b3/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/b9a73516-7203-45da-9706-97b9e64348be/targets
- [ ] To automatically regenerate this PR, check this box.
2021-01-20 00:26:03 +00:00
|
|
|
# Deprecated. ListJobs always returns summaries now. Use GetJob for other
|
|
|
|
|
# JobViews.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListJobsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_jobs(project_id, filter: nil, location: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['filter'] = filter unless filter.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Snapshot the state of a streaming job.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project which owns the job to be snapshotted.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job to be snapshotted.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::SnapshotJobRequest] snapshot_job_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Snapshot]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def snapshot_project_job(project_id, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}:snapshot', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation
|
|
|
|
|
command.request_object = snapshot_job_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Snapshot
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Updates the state of an existing Cloud Dataflow job. To update the state of an
|
|
|
|
|
# existing job, we recommend using `projects.locations.jobs.update` with a [
|
|
|
|
|
# regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
|
|
|
|
|
# endpoints). Using `projects.jobs.update` is not recommended, as you can only
|
|
|
|
|
# update the state of jobs that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job ID.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::Job] job_object
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Job]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def update_project_job(project_id, job_id, job_object = nil, location: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:put, 'v1b3/projects/{projectId}/jobs/{jobId}', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.request_object = job_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Job
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Get encoded debug configuration for component. Not cacheable.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job id.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::GetDebugConfigRequest] get_debug_config_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::GetDebugConfigResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::GetDebugConfigResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_job_debug_config(project_id, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::GetDebugConfigRequest::Representation
|
|
|
|
|
command.request_object = get_debug_config_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::GetDebugConfigResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::GetDebugConfigResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Send encoded debug capture data for component.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job id.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::SendDebugCaptureRequest] send_debug_capture_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::SendDebugCaptureResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::SendDebugCaptureResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def send_project_job_debug_capture(project_id, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::SendDebugCaptureRequest::Representation
|
|
|
|
|
command.request_object = send_debug_capture_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::SendDebugCaptureResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::SendDebugCaptureResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Request the job status. To request the status of a job, we recommend using `
|
|
|
|
|
# projects.locations.jobs.messages.list` with a [regional endpoint] (https://
|
|
|
|
|
# cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.
|
|
|
|
|
# jobs.messages.list` is not recommended, as you can only request the status of
|
|
|
|
|
# jobs that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# A project id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job to get messages about.
|
|
|
|
|
# @param [String] end_time
|
|
|
|
|
# Return only messages with timestamps < end_time. The default is now (i.e.
|
|
|
|
|
# return up to the latest messages available).
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job specified by job_id.
|
|
|
|
|
# @param [String] minimum_importance
|
|
|
|
|
# Filter to only get messages with importance >= level
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# If specified, determines the maximum number of messages to return. If
|
|
|
|
|
# unspecified, the service may choose an appropriate default, or may return an
|
|
|
|
|
# arbitrarily large number of results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# If supplied, this should be the value of next_page_token returned by an
|
|
|
|
|
# earlier call. This will cause the next page of results to be returned.
|
|
|
|
|
# @param [String] start_time
|
|
|
|
|
# If specified, return only messages with timestamps >= start_time. The default
|
|
|
|
|
# is the job creation time (i.e. beginning of messages).
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobMessagesResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListJobMessagesResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_job_messages(project_id, job_id, end_time: nil, location: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}/messages', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListJobMessagesResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListJobMessagesResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['endTime'] = end_time unless end_time.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['startTime'] = start_time unless start_time.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Leases a dataflow WorkItem to run.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Identifies the project this worker belongs to.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# Identifies the workflow job this worker belongs to.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::LeaseWorkItemRequest] lease_work_item_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::LeaseWorkItemResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::LeaseWorkItemResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def lease_project_work_item(project_id, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::LeaseWorkItemRequest::Representation
|
|
|
|
|
command.request_object = lease_work_item_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::LeaseWorkItemResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::LeaseWorkItemResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Reports the status of dataflow WorkItems leased by a worker.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project which owns the WorkItem's job.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job which the WorkItem is part of.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest] report_work_item_status_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def report_project_job_work_item_status(project_id, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest::Representation
|
|
|
|
|
command.request_object = report_work_item_status_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Send a worker_message to the service.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project to send the WorkerMessages to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::SendWorkerMessagesRequest] send_worker_messages_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def worker_project_location_messages(project_id, location, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/WorkerMessages', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesRequest::Representation
|
|
|
|
|
command.request_object = send_worker_messages_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Launch a job with a FlexTemplate.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Required. The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/
|
|
|
|
|
# concepts/regional-endpoints) to which to direct the request. E.g., us-central1,
|
|
|
|
|
# us-west1.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest] launch_flex_template_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def launch_flex_template(project_id, location, launch_flex_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest::Representation
|
|
|
|
|
command.request_object = launch_flex_template_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a Cloud Dataflow job. To create a job, we recommend using `projects.
|
|
|
|
|
# locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/
|
|
|
|
|
# dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is
|
|
|
|
|
# not recommended, as your job will always start in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::Job] job_object
|
|
|
|
|
# @param [String] replace_job_id
|
|
|
|
|
# Deprecated. This field is now in the Job message.
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The level of information requested in response.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Job]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def create_project_location_job(project_id, location, job_object = nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.request_object = job_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Job
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Gets the state of the specified Cloud Dataflow job. To get the state of a job,
|
|
|
|
|
# we recommend using `projects.locations.jobs.get` with a [regional endpoint] (
|
|
|
|
|
# https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `
|
|
|
|
|
# projects.jobs.get` is not recommended, as you can only get the state of jobs
|
|
|
|
|
# that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job ID.
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The level of information requested in response.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Job]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_job(project_id, location, job_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Job
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Request detailed information about the execution status of the job.
|
|
|
|
|
# EXPERIMENTAL. This API is subject to change or removal without notice.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# A project id.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job specified by job_id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job to get execution details for.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# If specified, determines the maximum number of stages to return. If
|
|
|
|
|
# unspecified, the service may choose an appropriate default, or may return an
|
|
|
|
|
# arbitrarily large number of results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# If supplied, this should be the value of next_page_token returned by an
|
|
|
|
|
# earlier call. This will cause the next page of results to be returned.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::JobExecutionDetails] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::JobExecutionDetails]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_job_execution_details(project_id, location, job_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::JobExecutionDetails::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::JobExecutionDetails
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Request the job status. To request the status of a job, we recommend using `
|
|
|
|
|
# projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.
|
|
|
|
|
# google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.
|
|
|
|
|
# getMetrics` is not recommended, as you can only request the status of jobs
|
|
|
|
|
# that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# A project id.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job specified by job_id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job to get metrics for.
|
|
|
|
|
# @param [String] start_time
|
|
|
|
|
# Return only metric data that has changed since this time. Default is to return
|
|
|
|
|
# all information about all metrics for the job.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::JobMetrics] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::JobMetrics]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_job_metrics(project_id, location, job_id, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::JobMetrics::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::JobMetrics
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['startTime'] = start_time unless start_time.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# List the jobs of a project. To list the jobs of a project in a region, we
|
|
|
|
|
# recommend using `projects.locations.jobs.list` with a [regional endpoint] (
|
|
|
|
|
# https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list
|
|
|
|
|
# the all jobs across all regions, use `projects.jobs.aggregated`. Using `
|
|
|
|
|
# projects.jobs.list` is not recommended, as you can only get the list of jobs
|
|
|
|
|
# that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project which owns the jobs.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [String] filter
|
|
|
|
|
# The kind of filter to use.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# If there are many jobs, limit response to at most this many. The actual number
|
|
|
|
|
# of jobs returned will be the lesser of max_responses and an unspecified server-
|
|
|
|
|
# defined limit.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Set this to the 'next_page_token' field of a previous response to request
|
|
|
|
|
# additional results in a long list.
|
|
|
|
|
# @param [String] view
|
feat: Automated regeneration of dataflow v1b3 client (#2429)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2021-01-19 16:05:25,957 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-dataflow-v1b3
nothing to commit, working tree clean
2021-01-19 16:05:26,033 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dataflow v1b3
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dataflow v1b3
git clean -df
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Fetching minitest 5.14.3
Fetching public_suffix 4.0.6
Fetching zeitwerk 2.4.2
Installing zeitwerk 2.4.2
Installing minitest 5.14.3
Installing public_suffix 4.0.6
Installing concurrent-ruby 1.1.7
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.2.6
Fetching coderay 1.1.3
Fetching byebug 11.1.3
Installing coderay 1.1.3
Installing byebug 11.1.3 with native extensions
Fetching json 2.5.1
Installing json 2.5.1 with native extensions
Fetching docile 1.3.5
Installing docile 1.3.5
Fetching simplecov-html 0.10.2
Using sync 0.5.0
Fetching thor 1.0.1
Installing simplecov-html 0.10.2
Installing thor 1.0.1
Fetching rexml 3.2.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Installing rexml 3.2.4
Fetching declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing declarative-option 0.1.0
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching faraday-net_http 1.0.1
Installing faraday-net_http 1.0.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.4
Fetching gems 1.2.0
Installing ruby2_keywords 0.0.4
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Fetching multi_json 1.15.0
Installing memoist 0.16.2
Installing multi_json 1.15.0
Fetching os 0.9.6
Fetching httpclient 2.8.3
Installing os 0.9.6
Fetching mini_mime 1.0.2
Installing httpclient 2.8.3
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Installing hashdiff 1.0.1
Installing mime-types-data 3.2020.1104
Fetching rspec-support 3.10.1
Fetching little-plugger 1.1.4
Installing rspec-support 3.10.1
Installing little-plugger 1.1.4
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.20.1
Installing parallel 1.20.1
Fetching powerpack 0.1.3
Installing powerpack 0.1.3
Fetching yard 0.9.26
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Installing yard 0.9.26
Fetching redcarpet 3.5.1
Fetching redis 3.3.5
Installing redcarpet 3.5.1 with native extensions
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.11.0
Installing ruby-progressbar 1.11.0
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching parser 2.7.2.0
Fetching addressable 2.7.0
Installing addressable 2.7.0
Installing parser 2.7.2.0
Fetching i18n 1.8.7
Installing i18n 1.8.7
Fetching tzinfo 2.0.4
Fetching tins 1.28.0
Installing tins 1.28.0
Installing tzinfo 2.0.4
Fetching crack 0.4.5
Installing crack 0.4.5
Fetching faraday 1.3.0
Installing faraday 1.3.0
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching pry 0.13.1
Fetching rspec-core 3.10.1
Installing pry 0.13.1
Installing rspec-core 3.10.1
Fetching rspec-expectations 3.10.1
Installing rspec-expectations 3.10.1
Fetching rspec-mocks 3.10.1
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Installing rspec-mocks 3.10.1
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Fetching activesupport 6.1.1
Fetching signet 0.14.0
Installing signet 0.14.0
Installing activesupport 6.1.1
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching pry-doc 0.13.5
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Installing pry-doc 0.13.5
Fetching google-apis-core 0.2.0
Installing google-apis-core 0.2.0
Fetching google-apis-discovery_v1 0.1.0
Installing google-apis-discovery_v1 0.1.0
Using google-apis-generator 0.1.2 from source at `.`
Bundle complete! 25 Gemfile dependencies, 81 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen /workspace/generated --api=dataflow.v1b3 --names=/workspace/api_names.yaml --names-out=/workspace/api_names_out.yaml --spot-check
Loading dataflow, version v1b3 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/dataflow.v1b3.json
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/classes.rb
<ow_v1b3/classes.rb? (enter "h" for help) [Ynaqdhm] a
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/classes.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/representations.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/representations.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/service.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/service.rb
conflict google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/gem_version.rb
force google-apis-dataflow_v1b3/lib/google/apis/dataflow_v1b3/gem_version.rb
conflict google-apis-dataflow_v1b3/CHANGELOG.md
force google-apis-dataflow_v1b3/CHANGELOG.md
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Using rake 13.0.3
Using public_suffix 4.0.6
Using bundler 2.2.6
Using declarative 0.0.20
Using declarative-option 0.1.0
Using diff-lcs 1.4.4
Using faraday-net_http 1.0.1
Using multipart-post 2.1.1
Using ruby2_keywords 0.0.4
Using jwt 2.2.2
Using memoist 0.16.2
Using multi_json 1.15.0
Using httpclient 2.8.3
Using mini_mime 1.0.2
Using uber 0.1.0
Using retriable 3.1.2
Using rexml 3.2.4
Using opencensus 0.5.0
Using redcarpet 3.5.1
Using rspec-support 3.10.1
Using yard 0.9.26
Fetching os 1.1.1
Using addressable 2.7.0
Using representable 3.0.4
Using faraday 1.3.0
Using rspec-core 3.10.1
Using rspec-expectations 3.10.1
Using rspec-mocks 3.10.1
Using signet 0.14.0
Using rspec 3.10.0
Installing os 1.1.1
Using googleauth 0.14.0
Using google-apis-core 0.2.0
Using google-apis-dataflow_v1b3 0.2.0 from source at `.`
Bundle complete! 8 Gemfile dependencies, 33 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
/root/.rbenv/versions/2.6.6/bin/ruby -I/root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-core-3.10.1/lib:/root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-support-3.10.1/lib /root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-core-3.10.1/exe/rspec --pattern spec/\*\*\{,/\*/\*\*\}/\*_spec.rb
Google::Apis::DataflowV1b3
should load
Finished in 0.40996 seconds (files took 0.10982 seconds to load)
1 example, 0 failures
Files: 4
Modules: 3 ( 1 undocumented)
Classes: 171 ( 0 undocumented)
Constants: 8 ( 0 undocumented)
Attributes: 449 ( 0 undocumented)
Methods: 390 ( 0 undocumented)
99.90% documented
google-apis-dataflow_v1b3 0.2.0 built to pkg/google-apis-dataflow_v1b3-0.2.0.gem.
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2021-01-19 16:06:10,002 synthtool [DEBUG] > Wrote metadata to generated/google-apis-dataflow_v1b3/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google-apis-dataflow_v1b3/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/b9a73516-7203-45da-9706-97b9e64348be/targets
- [ ] To automatically regenerate this PR, check this box.
2021-01-20 00:26:03 +00:00
|
|
|
# Deprecated. ListJobs always returns summaries now. Use GetJob for other
|
|
|
|
|
# JobViews.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListJobsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_location_jobs(project_id, location, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['filter'] = filter unless filter.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Snapshot the state of a streaming job.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project which owns the job to be snapshotted.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The location that contains this job.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job to be snapshotted.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::SnapshotJobRequest] snapshot_job_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Snapshot]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def snapshot_project_location_job(project_id, location, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation
|
|
|
|
|
command.request_object = snapshot_job_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Snapshot
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Updates the state of an existing Cloud Dataflow job. To update the state of an
|
|
|
|
|
# existing job, we recommend using `projects.locations.jobs.update` with a [
|
|
|
|
|
# regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
|
|
|
|
|
# endpoints). Using `projects.jobs.update` is not recommended, as you can only
|
|
|
|
|
# update the state of jobs that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains this job.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job ID.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::Job] job_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Job]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def update_project_location_job(project_id, location, job_id, job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:put, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.request_object = job_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Job
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Get encoded debug configuration for component. Not cacheable.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project id.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job specified by job_id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job id.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::GetDebugConfigRequest] get_debug_config_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::GetDebugConfigResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::GetDebugConfigResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_job_debug_config(project_id, location, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::GetDebugConfigRequest::Representation
|
|
|
|
|
command.request_object = get_debug_config_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::GetDebugConfigResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::GetDebugConfigResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Send encoded debug capture data for component.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project id.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job specified by job_id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job id.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::SendDebugCaptureRequest] send_debug_capture_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::SendDebugCaptureResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::SendDebugCaptureResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def send_project_location_job_debug_capture(project_id, location, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::SendDebugCaptureRequest::Representation
|
|
|
|
|
command.request_object = send_debug_capture_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::SendDebugCaptureResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::SendDebugCaptureResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Request the job status. To request the status of a job, we recommend using `
|
|
|
|
|
# projects.locations.jobs.messages.list` with a [regional endpoint] (https://
|
|
|
|
|
# cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.
|
|
|
|
|
# jobs.messages.list` is not recommended, as you can only request the status of
|
|
|
|
|
# jobs that are running in `us-central1`.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# A project id.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job specified by job_id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job to get messages about.
|
|
|
|
|
# @param [String] end_time
|
|
|
|
|
# Return only messages with timestamps < end_time. The default is now (i.e.
|
|
|
|
|
# return up to the latest messages available).
|
|
|
|
|
# @param [String] minimum_importance
|
|
|
|
|
# Filter to only get messages with importance >= level
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# If specified, determines the maximum number of messages to return. If
|
|
|
|
|
# unspecified, the service may choose an appropriate default, or may return an
|
|
|
|
|
# arbitrarily large number of results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# If supplied, this should be the value of next_page_token returned by an
|
|
|
|
|
# earlier call. This will cause the next page of results to be returned.
|
|
|
|
|
# @param [String] start_time
|
|
|
|
|
# If specified, return only messages with timestamps >= start_time. The default
|
|
|
|
|
# is the job creation time (i.e. beginning of messages).
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobMessagesResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListJobMessagesResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_location_job_messages(project_id, location, job_id, end_time: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListJobMessagesResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListJobMessagesResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['endTime'] = end_time unless end_time.nil?
|
|
|
|
|
command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['startTime'] = start_time unless start_time.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Lists snapshots.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project ID to list snapshots for.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The location to list snapshots in.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# If specified, list snapshots created from this job.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_location_job_snapshots(project_id, location, job_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Request detailed information about the execution status of a stage of the job.
|
|
|
|
|
# EXPERIMENTAL. This API is subject to change or removal without notice.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# A project id.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the job specified by job_id.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job to get execution details for.
|
|
|
|
|
# @param [String] stage_id
|
|
|
|
|
# The stage for which to fetch information.
|
|
|
|
|
# @param [String] end_time
|
|
|
|
|
# Upper time bound of work items to include, by start time.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# If specified, determines the maximum number of work items to return. If
|
|
|
|
|
# unspecified, the service may choose an appropriate default, or may return an
|
|
|
|
|
# arbitrarily large number of results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# If supplied, this should be the value of next_page_token returned by an
|
|
|
|
|
# earlier call. This will cause the next page of results to be returned.
|
|
|
|
|
# @param [String] start_time
|
|
|
|
|
# Lower time bound of work items to include, by start time.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::StageExecutionDetails] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::StageExecutionDetails]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetails', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::StageExecutionDetails::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::StageExecutionDetails
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.params['stageId'] = stage_id unless stage_id.nil?
|
|
|
|
|
command.query['endTime'] = end_time unless end_time.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['startTime'] = start_time unless start_time.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Leases a dataflow WorkItem to run.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Identifies the project this worker belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the WorkItem's job.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# Identifies the workflow job this worker belongs to.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::LeaseWorkItemRequest] lease_work_item_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::LeaseWorkItemResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::LeaseWorkItemResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def lease_project_location_work_item(project_id, location, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::LeaseWorkItemRequest::Representation
|
|
|
|
|
command.request_object = lease_work_item_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::LeaseWorkItemResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::LeaseWorkItemResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Reports the status of dataflow WorkItems leased by a worker.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project which owns the WorkItem's job.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) that contains the WorkItem's job.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# The job which the WorkItem is part of.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest] report_work_item_status_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def report_project_location_job_work_item_status(project_id, location, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest::Representation
|
|
|
|
|
command.request_object = report_work_item_status_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes a snapshot.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the snapshot belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The location that contains this snapshot.
|
|
|
|
|
# @param [String] snapshot_id
|
|
|
|
|
# The ID of the snapshot.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::DeleteSnapshotResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:delete, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Gets information about a snapshot.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the snapshot belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The location that contains this snapshot.
|
|
|
|
|
# @param [String] snapshot_id
|
|
|
|
|
# The ID of the snapshot.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Snapshot]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Snapshot
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Lists snapshots.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project ID to list snapshots for.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The location to list snapshots in.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# If specified, list snapshots created from this job.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_location_snapshots(project_id, location, job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the
|
|
|
|
|
# given query parses correctly, and if able to look up schema information from
|
|
|
|
|
# DataCatalog, will validate that the query analyzes properly as well.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Required. The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) to which to direct the request.
|
|
|
|
|
# @param [String] query
|
|
|
|
|
# The sql query to validate.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ValidateResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ValidateResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def validate_project_location_sql(project_id, location, query: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/sql:validate', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ValidateResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ValidateResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['query'] = query unless query.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a Cloud Dataflow job from a template.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Required. The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) to which to direct the request.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest] create_job_from_template_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Job]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def create_job_from_template_with_location(project_id, location, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/templates', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest::Representation
|
|
|
|
|
command.request_object = create_job_from_template_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Job
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Get the template associated with a template.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Required. The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) to which to direct the request.
|
|
|
|
|
# @param [String] gcs_path
|
|
|
|
|
# Required. A Cloud Storage path to the template from which to create the job.
|
|
|
|
|
# Must be valid Cloud Storage URL, beginning with 'gs://'.
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The view to retrieve. Defaults to METADATA_ONLY.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::GetTemplateResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::GetTemplateResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_template(project_id, location, gcs_path: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/templates:get', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::GetTemplateResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::GetTemplateResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['gcsPath'] = gcs_path unless gcs_path.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Launch a template.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Required. The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) to which to direct the request.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::LaunchTemplateParameters] launch_template_parameters_object
|
|
|
|
|
# @param [String] dynamic_template_gcs_path
|
|
|
|
|
# Path to dynamic template spec file on GCS. The file must be a Json serialized
|
|
|
|
|
# DynamicTemplateFieSpec object.
|
|
|
|
|
# @param [String] dynamic_template_staging_location
|
|
|
|
|
# Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL,
|
|
|
|
|
# beginning with `gs://`.
|
|
|
|
|
# @param [String] gcs_path
|
|
|
|
|
# A Cloud Storage path to the template from which to create the job. Must be
|
|
|
|
|
# valid Cloud Storage URL, beginning with 'gs://'.
|
|
|
|
|
# @param [Boolean] validate_only
|
|
|
|
|
# If true, the request is validated but not actually executed. Defaults to false.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::LaunchTemplateResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::LaunchTemplateResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def launch_project_location_template(project_id, location, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/templates:launch', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::LaunchTemplateParameters::Representation
|
|
|
|
|
command.request_object = launch_template_parameters_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::LaunchTemplateResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::LaunchTemplateResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['location'] = location unless location.nil?
|
|
|
|
|
command.query['dynamicTemplate.gcsPath'] = dynamic_template_gcs_path unless dynamic_template_gcs_path.nil?
|
|
|
|
|
command.query['dynamicTemplate.stagingLocation'] = dynamic_template_staging_location unless dynamic_template_staging_location.nil?
|
|
|
|
|
command.query['gcsPath'] = gcs_path unless gcs_path.nil?
|
|
|
|
|
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Gets information about a snapshot.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The ID of the Cloud Platform project that the snapshot belongs to.
|
|
|
|
|
# @param [String] snapshot_id
|
|
|
|
|
# The ID of the snapshot.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The location that contains this snapshot.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Snapshot]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_snapshot(project_id, snapshot_id, location: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots/{snapshotId}', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Snapshot
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Lists snapshots.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# The project ID to list snapshots for.
|
|
|
|
|
# @param [String] job_id
|
|
|
|
|
# If specified, list snapshots created from this job.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The location to list snapshots in.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['jobId'] = job_id unless job_id.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# List TemplateVersions using project_id and an optional display_name field.
|
|
|
|
|
# List all the TemplateVersions in the Template if display set. List all the
|
|
|
|
|
# TemplateVersions in the Project if display_name not set.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# parent includes project_id, and display_name is optional. List by project_id(
|
|
|
|
|
# pid1) and display_name(tid1). Format: projects/`pid1`/catalogTemplates/`tid1`
|
|
|
|
|
# List by project_id(pid1). Format: projects/`pid1`
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# The maximum number of TemplateVersions to return per page.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# The page token, received from a previous ListTemplateVersions call. Provide
|
|
|
|
|
# this to retrieve the subsequent page.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::ListTemplateVersionsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::ListTemplateVersionsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_template_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/{+parent}/templateVersions', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::ListTemplateVersionsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::ListTemplateVersionsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a Cloud Dataflow job from a template.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Required. The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest] create_job_from_template_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::Job]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def create_job_from_template(project_id, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/templates', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest::Representation
|
|
|
|
|
command.request_object = create_job_from_template_request_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::Job
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Get the template associated with a template.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Required. The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [String] gcs_path
|
|
|
|
|
# Required. A Cloud Storage path to the template from which to create the job.
|
|
|
|
|
# Must be valid Cloud Storage URL, beginning with 'gs://'.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) to which to direct the request.
|
|
|
|
|
# @param [String] view
|
|
|
|
|
# The view to retrieve. Defaults to METADATA_ONLY.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::GetTemplateResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::GetTemplateResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_template(project_id, gcs_path: nil, location: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1b3/projects/{projectId}/templates:get', options)
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::GetTemplateResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::GetTemplateResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['gcsPath'] = gcs_path unless gcs_path.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['view'] = view unless view.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Launch a template.
|
|
|
|
|
# @param [String] project_id
|
|
|
|
|
# Required. The ID of the Cloud Platform project that the job belongs to.
|
|
|
|
|
# @param [Google::Apis::DataflowV1b3::LaunchTemplateParameters] launch_template_parameters_object
|
|
|
|
|
# @param [String] dynamic_template_gcs_path
|
|
|
|
|
# Path to dynamic template spec file on GCS. The file must be a Json serialized
|
|
|
|
|
# DynamicTemplateFieSpec object.
|
|
|
|
|
# @param [String] dynamic_template_staging_location
|
|
|
|
|
# Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL,
|
|
|
|
|
# beginning with `gs://`.
|
|
|
|
|
# @param [String] gcs_path
|
|
|
|
|
# A Cloud Storage path to the template from which to create the job. Must be
|
|
|
|
|
# valid Cloud Storage URL, beginning with 'gs://'.
|
|
|
|
|
# @param [String] location
|
|
|
|
|
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
|
|
|
|
|
# regional-endpoints) to which to direct the request.
|
|
|
|
|
# @param [Boolean] validate_only
|
|
|
|
|
# If true, the request is validated but not actually executed. Defaults to false.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
|
|
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::DataflowV1b3::LaunchTemplateResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::DataflowV1b3::LaunchTemplateResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def launch_project_template(project_id, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, location: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1b3/projects/{projectId}/templates:launch', options)
|
|
|
|
|
command.request_representation = Google::Apis::DataflowV1b3::LaunchTemplateParameters::Representation
|
|
|
|
|
command.request_object = launch_template_parameters_object
|
|
|
|
|
command.response_representation = Google::Apis::DataflowV1b3::LaunchTemplateResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::DataflowV1b3::LaunchTemplateResponse
|
|
|
|
|
command.params['projectId'] = project_id unless project_id.nil?
|
|
|
|
|
command.query['dynamicTemplate.gcsPath'] = dynamic_template_gcs_path unless dynamic_template_gcs_path.nil?
|
|
|
|
|
command.query['dynamicTemplate.stagingLocation'] = dynamic_template_staging_location unless dynamic_template_staging_location.nil?
|
|
|
|
|
command.query['gcsPath'] = gcs_path unless gcs_path.nil?
|
|
|
|
|
command.query['location'] = location unless location.nil?
|
|
|
|
|
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
protected
|
|
|
|
|
|
|
|
|
|
def apply_command_defaults(command)
|
|
|
|
|
command.query['key'] = key unless key.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
