Class: Google::Apis::DataflowV1b3::DataflowService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/dataflow_v1b3/service.rb

Overview

Dataflow API

Manages Google Cloud Dataflow projects on Google Cloud Platform.

Examples:

require 'google/apis/dataflow_v1b3'

Dataflow = Google::Apis::DataflowV1b3 # Alias the module
service = Dataflow::DataflowService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ DataflowService

Returns a new instance of DataflowService



45
46
47
48
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 45

def initialize
  super('https://dataflow.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



38
39
40
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (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.



43
44
45
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#aggregated_project_job(project_id, filter: nil, location: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse

List the jobs of a project across all regions.

Parameters:

  • project_id (String) —

    The project which owns the jobs.

  • filter (String) —

    The kind of filter to use.

  • location (String) —

    The regional endpoint that contains this job.

  • page_size (Fixnum) —

    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.

  • page_token (String) —

    Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

  • view (String) —

    Level of information requested in response. Default is JOB_VIEW_SUMMARY.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 154

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

#create_job_from_template(project_id, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job

Creates a Cloud Dataflow job from a template.

Parameters:

  • project_id (String) —

    Required. The ID of the Cloud Platform project that the job belongs to.

  • create_job_from_template_request_object (Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1620

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

#create_job_from_template_with_location(project_id, location, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job

Creates a Cloud Dataflow job from a template.

Parameters:

  • project_id (String) —

    Required. The ID of the Cloud Platform project that the job belongs to.

  • location (String) —

    The regional endpoint to which to direct the request.

  • create_job_from_template_request_object (Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1416

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

#create_project_job(project_id, job_object = nil, location: nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job

Creates a Cloud Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a regional endpoint. Using projects.jobs.create is not recommended, as your job will always start in us-central1.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the job belongs to.

  • job_object (Google::Apis::DataflowV1b3::Job) (defaults to: nil)
  • location (String) —

    The regional endpoint that contains this job.

  • replace_job_id (String) —

    Deprecated. This field is now in the Job message.

  • view (String) —

    The level of information requested in response.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 203

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

#create_project_location_job(project_id, location, job_object = nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job

Creates a Cloud Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a regional endpoint. Using projects.jobs.create is not recommended, as your job will always start in us-central1.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the job belongs to.

  • location (String) —

    The regional endpoint that contains this job.

  • job_object (Google::Apis::DataflowV1b3::Job) (defaults to: nil)
  • replace_job_id (String) —

    Deprecated. This field is now in the Job message.

  • view (String) —

    The level of information requested in response.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 729

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

#delete_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::DeleteSnapshotResponse

Deletes a snapshot.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the snapshot belongs to.

  • location (String) —

    The location that contains this snapshot.

  • snapshot_id (String) —

    The ID of the snapshot.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1266

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

#delete_project_snapshots(project_id, location: nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::DeleteSnapshotResponse

Deletes a snapshot.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the snapshot belongs to.

  • location (String) —

    The location that contains this snapshot.

  • snapshot_id (String) —

    The ID of the snapshot.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



74
75
76
77
78
79
80
81
82
83
84
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 74

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

#get_project_job(project_id, job_id, location: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job

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. Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the job belongs to.

  • job_id (String) —

    The job ID.

  • location (String) —

    The regional endpoint that contains this job.

  • view (String) —

    The level of information requested in response.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 251

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

#get_project_job_debug_config(project_id, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetDebugConfigResponse

Get encoded debug configuration for component. Not cacheable.

Parameters:

  • project_id (String) —

    The project id.

  • job_id (String) —

    The job id.

  • get_debug_config_request_object (Google::Apis::DataflowV1b3::GetDebugConfigRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 472

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

#get_project_job_metrics(project_id, job_id, location: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobMetrics

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

Parameters:

  • project_id (String) —

    A project id.

  • job_id (String) —

    The job to get messages for.

  • location (String) —

    The regional endpoint that contains the job specified by job_id.

  • start_time (String) —

    Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 298

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

#get_project_location_job(project_id, location, job_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job

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. Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the job belongs to.

  • location (String) —

    The regional endpoint that contains this job.

  • job_id (String) —

    The job ID.

  • view (String) —

    The level of information requested in response.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 777

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

#get_project_location_job_debug_config(project_id, location, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetDebugConfigResponse

Get encoded debug configuration for component. Not cacheable.

Parameters:

  • project_id (String) —

    The project id.

  • location (String) —

    The regional endpoint that contains the job specified by job_id.

  • job_id (String) —

    The job id.

  • get_debug_config_request_object (Google::Apis::DataflowV1b3::GetDebugConfigRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1005

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

#get_project_location_job_metrics(project_id, location, job_id, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobMetrics

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.

Parameters:

  • project_id (String) —

    A project id.

  • location (String) —

    The regional endpoint that contains the job specified by job_id.

  • job_id (String) —

    The job to get messages for.

  • start_time (String) —

    Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 824

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

#get_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot

Gets information about a snapshot.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the snapshot belongs to.

  • location (String) —

    The location that contains this snapshot.

  • snapshot_id (String) —

    The ID of the snapshot.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1302

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

#get_project_location_template(project_id, location, gcs_path: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetTemplateResponse

Get the template associated with a template.

Parameters:

  • project_id (String) —

    Required. The ID of the Cloud Platform project that the job belongs to.

  • location (String) —

    The regional endpoint to which to direct the request.

  • gcs_path (String) —

    Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

  • view (String) —

    The view to retrieve. Defaults to METADATA_ONLY.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1459

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

#get_project_snapshot(project_id, snapshot_id, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot

Gets information about a snapshot.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the snapshot belongs to.

  • snapshot_id (String) —

    The ID of the snapshot.

  • location (String) —

    The location that contains this snapshot.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1551

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

#get_project_template(project_id, gcs_path: nil, location: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetTemplateResponse

Get the template associated with a template.

Parameters:

  • project_id (String) —

    Required. The ID of the Cloud Platform project that the job belongs to.

  • gcs_path (String) —

    Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

  • location (String) —

    The regional endpoint to which to direct the request.

  • view (String) —

    The view to retrieve. Defaults to METADATA_ONLY.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1662

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_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) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchTemplateResponse

Launch a template.

Parameters:

  • project_id (String) —

    Required. The ID of the Cloud Platform project that the job belongs to.

  • location (String) —

    The regional endpoint to which to direct the request.

  • launch_template_parameters_object (Google::Apis::DataflowV1b3::LaunchTemplateParameters) (defaults to: nil)
  • dynamic_template_gcs_path (String) —

    Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object.

  • dynamic_template_staging_location (String) —

    Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with gs://.

  • gcs_path (String) —

    A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

  • validate_only (Boolean) —

    If true, the request is validated but not actually executed. Defaults to false.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1510

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

#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) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchTemplateResponse

Launch a template.

Parameters:

  • project_id (String) —

    Required. The ID of the Cloud Platform project that the job belongs to.

  • launch_template_parameters_object (Google::Apis::DataflowV1b3::LaunchTemplateParameters) (defaults to: nil)
  • dynamic_template_gcs_path (String) —

    Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object.

  • dynamic_template_staging_location (String) —

    Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with gs://.

  • gcs_path (String) —

    A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

  • location (String) —

    The regional endpoint to which to direct the request.

  • validate_only (Boolean) —

    If true, the request is validated but not actually executed. Defaults to false.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1713

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

#lease_project_location_work_item(project_id, location, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LeaseWorkItemResponse

Leases a dataflow WorkItem to run.

Parameters:

  • project_id (String) —

    Identifies the project this worker belongs to.

  • location (String) —

    The regional endpoint that contains the WorkItem's job.

  • job_id (String) —

    Identifies the workflow job this worker belongs to.

  • lease_work_item_request_object (Google::Apis::DataflowV1b3::LeaseWorkItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1187

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

#lease_project_work_item(project_id, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LeaseWorkItemResponse

Leases a dataflow WorkItem to run.

Parameters:

  • project_id (String) —

    Identifies the project this worker belongs to.

  • job_id (String) —

    Identifies the workflow job this worker belongs to.

  • lease_work_item_request_object (Google::Apis::DataflowV1b3::LeaseWorkItemRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 608

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

#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) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobMessagesResponse

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

Parameters:

  • project_id (String) —

    A project id.

  • job_id (String) —

    The job to get messages about.

  • end_time (String) —

    Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

  • location (String) —

    The regional endpoint that contains the job specified by job_id.

  • minimum_importance (String) —

    Filter to only get messages with importance >= level

  • page_size (Fixnum) —

    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.

  • page_token (String) —

    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.

  • start_time (String) —

    If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 568

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

#list_project_jobs(project_id, filter: nil, location: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse

List the jobs of a project. To list the jobs of a project in a region, we recommend using projects.locations.jobs.get with a regional endpoint. 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.

Parameters:

  • project_id (String) —

    The project which owns the jobs.

  • filter (String) —

    The kind of filter to use.

  • location (String) —

    The regional endpoint that contains this job.

  • page_size (Fixnum) —

    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.

  • page_token (String) —

    Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

  • view (String) —

    Level of information requested in response. Default is JOB_VIEW_SUMMARY.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 352

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

#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) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobMessagesResponse

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

Parameters:

  • project_id (String) —

    A project id.

  • location (String) —

    The regional endpoint that contains the job specified by job_id.

  • job_id (String) —

    The job to get messages about.

  • end_time (String) —

    Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

  • minimum_importance (String) —

    Filter to only get messages with importance >= level

  • page_size (Fixnum) —

    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.

  • page_token (String) —

    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.

  • start_time (String) —

    If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1107

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

#list_project_location_job_snapshots(project_id, location, job_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse

Lists snapshots.

Parameters:

  • project_id (String) —

    The project ID to list snapshots for.

  • location (String) —

    The location to list snapshots in.

  • job_id (String) —

    If specified, list snapshots created from this job.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1148

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

#list_project_location_jobs(project_id, location, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse

List the jobs of a project. To list the jobs of a project in a region, we recommend using projects.locations.jobs.get with a regional endpoint. 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.

Parameters:

  • project_id (String) —

    The project which owns the jobs.

  • location (String) —

    The regional endpoint that contains this job.

  • filter (String) —

    The kind of filter to use.

  • page_size (Fixnum) —

    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.

  • page_token (String) —

    Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

  • view (String) —

    Level of information requested in response. Default is JOB_VIEW_SUMMARY.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 878

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

#list_project_location_snapshots(project_id, location, job_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse

Lists snapshots.

Parameters:

  • project_id (String) —

    The project ID to list snapshots for.

  • location (String) —

    The location to list snapshots in.

  • job_id (String) —

    If specified, list snapshots created from this job.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1338

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

#list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse

Lists snapshots.

Parameters:

  • project_id (String) —

    The project ID to list snapshots for.

  • job_id (String) —

    If specified, list snapshots created from this job.

  • location (String) —

    The location to list snapshots in.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1587

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

#report_project_job_work_item_status(project_id, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse

Reports the status of dataflow WorkItems leased by a worker.

Parameters:

  • project_id (String) —

    The project which owns the WorkItem's job.

  • job_id (String) —

    The job which the WorkItem is part of.

  • report_work_item_status_request_object (Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 644

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

#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) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse

Reports the status of dataflow WorkItems leased by a worker.

Parameters:

  • project_id (String) —

    The project which owns the WorkItem's job.

  • location (String) —

    The regional endpoint that contains the WorkItem's job.

  • job_id (String) —

    The job which the WorkItem is part of.

  • report_work_item_status_request_object (Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1228

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

#send_project_job_debug_capture(project_id, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendDebugCaptureResponse

Send encoded debug capture data for component.

Parameters:

  • project_id (String) —

    The project id.

  • job_id (String) —

    The job id.

  • send_debug_capture_request_object (Google::Apis::DataflowV1b3::SendDebugCaptureRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 508

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

#send_project_location_job_debug_capture(project_id, location, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendDebugCaptureResponse

Send encoded debug capture data for component.

Parameters:

  • project_id (String) —

    The project id.

  • location (String) —

    The regional endpoint that contains the job specified by job_id.

  • job_id (String) —

    The job id.

  • send_debug_capture_request_object (Google::Apis::DataflowV1b3::SendDebugCaptureRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1046

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

#snapshot_project_job(project_id, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot

Snapshot the state of a streaming job.

Parameters:

  • project_id (String) —

    The project which owns the job to be snapshotted.

  • job_id (String) —

    The job to be snapshotted.

  • snapshot_job_request_object (Google::Apis::DataflowV1b3::SnapshotJobRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 390

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

#snapshot_project_location_job(project_id, location, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot

Snapshot the state of a streaming job.

Parameters:

  • project_id (String) —

    The project which owns the job to be snapshotted.

  • location (String) —

    The location that contains this job.

  • job_id (String) —

    The job to be snapshotted.

  • snapshot_job_request_object (Google::Apis::DataflowV1b3::SnapshotJobRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 918

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

#update_project_job(project_id, job_id, job_object = nil, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job

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. Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the job belongs to.

  • job_id (String) —

    The job ID.

  • job_object (Google::Apis::DataflowV1b3::Job) (defaults to: nil)
  • location (String) —

    The regional endpoint that contains this job.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 435

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

#update_project_location_job(project_id, location, job_id, job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job

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. Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1.

Parameters:

  • project_id (String) —

    The ID of the Cloud Platform project that the job belongs to.

  • location (String) —

    The regional endpoint that contains this job.

  • job_id (String) —

    The job ID.

  • job_object (Google::Apis::DataflowV1b3::Job) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 964

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

#validate_project_location_sql(project_id, location, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ValidateResponse

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.

Parameters:

  • project_id (String) —

    Required. The ID of the Cloud Platform project that the job belongs to.

  • location (String) —

    The regional endpoint to which to direct the request.

  • query (String) —

    The sql query to validate.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1379

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

#worker_project_location_messages(project_id, location, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendWorkerMessagesResponse

Send a worker_message to the service.

Parameters:

  • project_id (String) —

    The project to send the WorkerMessages to.

  • location (String) —

    The regional endpoint that contains the job.

  • send_worker_messages_request_object (Google::Apis::DataflowV1b3::SendWorkerMessagesRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 682

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

#worker_project_messages(project_id, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendWorkerMessagesResponse

Send a worker_message to the service.

Parameters:

  • project_id (String) —

    The project to send the WorkerMessages to.

  • send_worker_messages_request_object (Google::Apis::DataflowV1b3::SendWorkerMessagesRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



107
108
109
110
111
112
113
114
115
116
117
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 107

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