generated/google/apis/dataflow_v1b3/service.rb in google-api-client-0.10.1 vs generated/google/apis/dataflow_v1b3/service.rb in google-api-client-0.10.2
- old
+ new
@@ -48,15 +48,15 @@
# 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -65,118 +65,36 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
- execute_or_queue_command(command, &block)
- end
-
- # Creates a Cloud Dataflow job.
- # @param [String] project_id
- # The ID of the Cloud Platform project that the job belongs to.
- # @param [String] location
- # The location that contains this job.
- # @param [Google::Apis::DataflowV1b3::Job] job_object
- # @param [String] view
- # The level of information requested in response.
- # @param [String] replace_job_id
- # Deprecated. This field is now in the Job message.
- # @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 [String] fields
- # Selector specifying which fields to include in a partial response.
- # @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, view: nil, replace_job_id: nil, quota_user: nil, fields: 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['view'] = view unless view.nil?
- command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
- command.query['fields'] = fields unless fields.nil?
execute_or_queue_command(command, &block)
end
- # Request the job status.
- # @param [String] project_id
- # A project id.
- # @param [String] location
- # The location which contains the job specified by job_id.
- # @param [String] job_id
- # The job to get messages 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] 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 [String] fields
- # Selector specifying which fields to include in a partial response.
- # @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, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
- command.query['fields'] = fields unless fields.nil?
- execute_or_queue_command(command, &block)
- end
-
# Gets the state of the specified Cloud Dataflow job.
# @param [String] project_id
# The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# The location 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -185,44 +103,44 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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['quotaUser'] = quota_user unless quota_user.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.
# @param [String] project_id
# The project which owns the jobs.
# @param [String] location
# The location that contains this job.
- # @param [String] filter
- # The kind of filter to use.
# @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 [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] view
# Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
+ # @param [String] filter
+ # The kind of filter to use.
+ # @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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -231,22 +149,22 @@
# @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_token: nil, page_size: nil, view: nil, quota_user: nil, fields: nil, options: nil, &block)
+ def list_project_location_jobs(project_id, location, page_token: nil, page_size: nil, view: nil, filter: 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['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['view'] = view unless view.nil?
- command.query['quotaUser'] = quota_user unless quota_user.nil?
+ command.query['filter'] = filter unless filter.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.
# @param [String] project_id
@@ -254,15 +172,15 @@
# @param [String] location
# The location 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -271,78 +189,103 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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
+
+ # Creates a Cloud Dataflow job.
+ # @param [String] project_id
+ # The ID of the Cloud Platform project that the job belongs to.
+ # @param [String] location
+ # The location 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
# Request the job status.
# @param [String] project_id
# A project id.
# @param [String] location
# The location which contains the job specified by job_id.
# @param [String] job_id
- # The job to get messages about.
- # @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.
+ # The job to get messages for.
# @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 [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] minimum_importance
- # Filter to only get messages with importance >= level
- # @param [String] end_time
- # Return only messages with timestamps < end_time. The default is now
- # (i.e. return up to the latest messages available).
+ # 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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 result [Google::Apis::DataflowV1b3::JobMetrics] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
- # @return [Google::Apis::DataflowV1b3::ListJobMessagesResponse]
+ # @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 list_project_location_job_messages(project_id, location, job_id, page_token: nil, start_time: nil, page_size: nil, minimum_importance: nil, end_time: nil, quota_user: nil, fields: 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
+ 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['pageToken'] = page_token unless page_token.nil?
command.query['startTime'] = start_time unless start_time.nil?
- command.query['pageSize'] = page_size unless page_size.nil?
- command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil?
- command.query['endTime'] = end_time unless end_time.nil?
- command.query['quotaUser'] = quota_user unless quota_user.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
@@ -350,15 +293,15 @@
# @param [String] location
# The location which 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -367,21 +310,21 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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['quotaUser'] = quota_user unless quota_user.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
@@ -389,15 +332,15 @@
# @param [String] location
# The location which 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -406,54 +349,78 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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['quotaUser'] = quota_user unless quota_user.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.
+ # Request the job status.
# @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
+ # A project id.
+ # @param [String] location
+ # The location which 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] 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] 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 [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] minimum_importance
+ # Filter to only get messages with importance >= level
+ # @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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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 result [Google::Apis::DataflowV1b3::ListJobMessagesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
- # @return [Google::Apis::DataflowV1b3::Job]
+ # @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 create_job_from_template(project_id, create_job_from_template_request_object = nil, quota_user: nil, fields: 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
+ def list_project_location_job_messages(project_id, location, job_id, end_time: nil, start_time: nil, page_token: nil, page_size: nil, minimum_importance: 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.query['quotaUser'] = quota_user unless quota_user.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['startTime'] = start_time unless start_time.nil?
+ command.query['pageToken'] = page_token unless page_token.nil?
+ command.query['pageSize'] = page_size unless page_size.nil?
+ command.query['minimumImportance'] = minimum_importance unless minimum_importance.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
@@ -465,15 +432,15 @@
# Must be valid Cloud Storage URL, beginning with 'gs://'.
# @param [Boolean] dry_run
# Whether or not the job should actually be executed after
# validating parameters. Defaults to false. Validation errors do
# not cause the HTTP request to fail if true.
+ # @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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -482,21 +449,21 @@
# @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, gcs_path: nil, dry_run: nil, quota_user: nil, fields: nil, options: nil, &block)
+ def launch_project_template(project_id, launch_template_parameters_object = nil, gcs_path: nil, dry_run: 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['gcsPath'] = gcs_path unless gcs_path.nil?
command.query['dryRun'] = dry_run unless dry_run.nil?
- command.query['quotaUser'] = quota_user unless quota_user.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
@@ -505,15 +472,15 @@
# The view to retrieve. Defaults to METADATA_ONLY.
# @param [String] gcs_path
# Required. A Cloud Storage path to the template from which to
# create the job.
# Must be a valid Cloud Storage URL, beginning with `gs://`.
+ # @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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -522,19 +489,52 @@
# @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, view: nil, gcs_path: nil, quota_user: nil, fields: nil, options: nil, &block)
+ def get_project_template(project_id, view: nil, gcs_path: 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['view'] = view unless view.nil?
command.query['gcsPath'] = gcs_path unless gcs_path.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
# Request the job status.
# @param [String] project_id
@@ -544,15 +544,15 @@
# @param [String] location
# The location which 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -561,20 +561,20 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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['quotaUser'] = quota_user unless quota_user.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.
# @param [String] project_id
@@ -583,15 +583,15 @@
# The job ID.
# @param [String] view
# The level of information requested in response.
# @param [String] location
# The location 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -600,20 +600,20 @@
# @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, view: nil, location: nil, quota_user: nil, fields: nil, options: nil, &block)
+ def get_project_job(project_id, job_id, view: nil, location: 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['view'] = view unless view.nil?
command.query['location'] = location unless location.nil?
- command.query['quotaUser'] = quota_user unless quota_user.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.
# @param [String] project_id
@@ -629,15 +629,15 @@
# 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] view
# Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
+ # @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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -646,22 +646,22 @@
# @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_token: nil, page_size: nil, view: nil, quota_user: nil, fields: nil, options: nil, &block)
+ def list_project_jobs(project_id, filter: nil, location: nil, page_token: nil, page_size: 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['pageToken'] = page_token unless page_token.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['view'] = view unless view.nil?
- command.query['quotaUser'] = quota_user unless quota_user.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.
# @param [String] project_id
@@ -669,15 +669,15 @@
# @param [String] job_id
# The job ID.
# @param [Google::Apis::DataflowV1b3::Job] job_object
# @param [String] location
# The location 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -686,39 +686,39 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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['quotaUser'] = quota_user unless quota_user.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.
# @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] view
- # The level of information requested in response.
# @param [String] location
# The location 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -727,36 +727,36 @@
# @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, view: nil, location: nil, replace_job_id: nil, quota_user: nil, fields: nil, options: nil, &block)
+ 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['view'] = view unless view.nil?
command.query['location'] = location unless location.nil?
command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil?
- command.query['quotaUser'] = quota_user unless quota_user.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
# 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -765,34 +765,34 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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['quotaUser'] = quota_user unless quota_user.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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -801,105 +801,105 @@
# @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, quota_user: nil, fields: nil, options: nil, &block)
+ 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['quotaUser'] = quota_user unless quota_user.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.
+ # Leases a dataflow WorkItem to run.
# @param [String] project_id
- # The project which owns the WorkItem's job.
+ # Identifies the project this worker belongs to.
# @param [String] job_id
- # The job which the WorkItem is part of.
- # @param [Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest] report_work_item_status_request_object
+ # 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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 result [Google::Apis::DataflowV1b3::LeaseWorkItemResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
- # @return [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse]
+ # @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 report_project_job_work_item_status(project_id, job_id, report_work_item_status_request_object = nil, quota_user: nil, fields: 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
+ 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['quotaUser'] = quota_user unless quota_user.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.
+ # Reports the status of dataflow WorkItems leased by a worker.
# @param [String] project_id
- # Identifies the project this worker belongs to.
+ # The project which owns 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
+ # 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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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 result [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
- # @return [Google::Apis::DataflowV1b3::LeaseWorkItemResponse]
+ # @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 lease_project_work_item(project_id, job_id, lease_work_item_request_object = nil, quota_user: nil, fields: 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
+ 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['quotaUser'] = quota_user unless quota_user.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.
# @param [String] project_id
# A project id.
# @param [String] job_id
# The job to get messages about.
+ # @param [String] location
+ # The location which contains the job specified by job_id.
# @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 location which contains the job specified by job_id.
# @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
@@ -909,15 +909,15 @@
# 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] minimum_importance
# Filter to only get messages with importance >= level
+ # @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 [String] fields
- # Selector specifying which fields to include in a partial response.
# @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
@@ -926,23 +926,23 @@
# @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, page_token: nil, start_time: nil, page_size: nil, minimum_importance: nil, quota_user: nil, fields: nil, options: nil, &block)
+ def list_project_job_messages(project_id, job_id, location: nil, end_time: nil, page_token: nil, start_time: nil, page_size: nil, minimum_importance: 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['endTime'] = end_time unless end_time.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['startTime'] = start_time unless start_time.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil?
- command.query['quotaUser'] = quota_user unless quota_user.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