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 location 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:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 116

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:



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1140

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 location 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:



1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1020

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.

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 location 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:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 158

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.

Parameters:

  • project_id (String) —

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

  • location (String) —

    The location 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:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 603

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

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

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 location 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:



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 199

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:



362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 362

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.

Parameters:

  • project_id (String) —

    A project id.

  • job_id (String) —

    The job to get messages for.

  • location (String) —

    The location which 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:



239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 239

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.

Parameters:

  • project_id (String) —

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

  • location (String) —

    The location 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:



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

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 location which 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:



809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 809

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.

Parameters:

  • project_id (String) —

    A project id.

  • location (String) —

    The location which 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:



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

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_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 location 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 a 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:



1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1061

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_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 a valid Cloud Storage URL, beginning with gs://.

  • location (String) —

    The location 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:



1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1180

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, 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 location to which to direct the request.

  • launch_template_parameters_object (Google::Apis::DataflowV1b3::LaunchTemplateParameters) (defaults to: nil)
  • 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://'.

  • 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:



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1104

def launch_project_location_template(project_id, location, launch_template_parameters_object = 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['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, 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)
  • 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 location 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:



1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 1223

def launch_project_template(project_id, launch_template_parameters_object = 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['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 location which 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:



944
945
946
947
948
949
950
951
952
953
954
955
956
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 944

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:



491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 491

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.

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 location which 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:



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 451

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 in a given region.

Parameters:

  • project_id (String) —

    The project which owns the jobs.

  • filter (String) —

    The kind of filter to use.

  • location (String) —

    The location 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:



285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 285

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.

Parameters:

  • project_id (String) —

    A project id.

  • location (String) —

    The location which 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:



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 902

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_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 in a given region.

Parameters:

  • project_id (String) —

    The project which owns the jobs.

  • location (String) —

    The location 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:



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

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

#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:



527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 527

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 location which 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:



983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 983

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:



398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 398

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 location which 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:



848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 848

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

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

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 location 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:



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 325

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.

Parameters:

  • project_id (String) —

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

  • location (String) —

    The location 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:



770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 770

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

#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 location which 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:



563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 563

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:



71
72
73
74
75
76
77
78
79
80
81
 
# File 'generated/google/apis/dataflow_v1b3/service.rb', line 71

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