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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/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

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DataflowService

Returns a new instance of DataflowService.



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

def initialize
  super('https://dataflow.googleapis.com/', '',
        client_name: 'google-apis-dataflow_v1b3',
        client_version: Google::Apis::DataflowV1b3::GEM_VERSION)
  @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 'lib/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 'lib/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) (defaults to: nil) —

    The kind of filter to use.

  • location (String) (defaults to: nil) —

    The regional endpoint that contains this job.

  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • view (String) (defaults to: nil) —

    Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 371

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

#commit_catalog_template_template_version(name, commit_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::TemplateVersion

Creates a new TemplateVersion (Important: not new Template) entry in the spanner table. Requires project_id and display_name (template).

Parameters:

  • name (String) —

    The location of the template, name includes project_id and display_name. Commit using project_id(pid1) and display_name(tid1). Format: projects/pid1/ catalogTemplates/tid1

  • commit_template_version_request_object (Google::Apis::DataflowV1b3::CommitTemplateVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 145

def commit_catalog_template_template_version(name, commit_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1b3/{+name}:commit', options)
  command.request_representation = Google::Apis::DataflowV1b3::CommitTemplateVersionRequest::Representation
  command.request_object = commit_template_version_request_object
  command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
  command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1980

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1740

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) (defaults to: nil) —

    The regional endpoint that contains this job.

  • replace_job_id (String) (defaults to: nil) —

    Deprecated. This field is now in the Job message.

  • view (String) (defaults to: nil) —

    The level of information requested in response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 417

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) (defaults to: nil) —

    Deprecated. This field is now in the Job message.

  • view (String) (defaults to: nil) —

    The level of information requested in response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



967
968
969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 967

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

#create_template_version(parent, create_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::TemplateVersion

Creates a new Template with TemplateVersion. Requires project_id(projects) and template display_name(catalogTemplates). The template display_name is set by the user.

Parameters:

  • parent (String) —

    The parent project and template that the TemplateVersion will be created under. Create using project_id(pid1) and display_name(tid1). Format: projects/pid1/ catalogTemplates/tid1

  • create_template_version_request_object (Google::Apis::DataflowV1b3::CreateTemplateVersionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 324

def create_template_version(parent, create_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1b3/{+parent}/templateVersions', options)
  command.request_representation = Google::Apis::DataflowV1b3::CreateTemplateVersionRequest::Representation
  command.request_object = create_template_version_request_object
  command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
  command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_catalog_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Empty

Deletes an existing Template. Do nothing if Template does not exist.

Parameters:

  • name (String) —

    name includes project_id and display_name. Delete by project_id(pid1) and display_name(tid1). Format: projects/pid1/catalogTemplates/tid1

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



178
179
180
181
182
183
184
185
186
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 178

def delete_project_catalog_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1b3/{+name}', options)
  command.response_representation = Google::Apis::DataflowV1b3::Empty::Representation
  command.response_class = Google::Apis::DataflowV1b3::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1593

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) (defaults to: nil) —

    The location that contains this snapshot.

  • snapshot_id (String) (defaults to: nil) —

    The ID of the snapshot.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 76

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_catalog_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::TemplateVersion

Get TemplateVersion using project_id and display_name with an optional version_id field. Get latest (has tag "latest") TemplateVersion if version_id not set.

Parameters:

  • name (String) —

    Resource name includes project_id and display_name. version_id is optional. Get the latest TemplateVersion if version_id not set. Get by project_id(pid1) and display_name(tid1): Format: projects/pid1/catalogTemplates/tid1 Get by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/ pid1/catalogTemplates/tid1@vid

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



214
215
216
217
218
219
220
221
222
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 214

def get_project_catalog_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1b3/{+name}', options)
  command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
  command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) (defaults to: nil) —

    The regional endpoint that contains this job.

  • view (String) (defaults to: nil) —

    The level of information requested in response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 463

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 679

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 metrics for.

  • location (String) (defaults to: nil) —

    The regional endpoint that contains the job specified by job_id.

  • start_time (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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) (defaults to: nil) —

    The level of information requested in response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1013

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1282

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_execution_details(project_id, location, job_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobExecutionDetails

Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice.

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 execution details for.

  • page_size (Fixnum) (defaults to: nil) —

    If specified, determines the maximum number of stages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_project_location_job_execution_details(project_id, location, job_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails', options)
  command.response_representation = Google::Apis::DataflowV1b3::JobExecutionDetails::Representation
  command.response_class = Google::Apis::DataflowV1b3::JobExecutionDetails
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['location'] = location unless location.nil?
  command.params['jobId'] = job_id unless job_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

  • start_time (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::StageExecutionDetails

Request detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice.

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 execution details for.

  • stage_id (String) —

    The stage for which to fetch information.

  • end_time (String) (defaults to: nil) —

    Upper time bound of work items to include, by start time.

  • page_size (Fixnum) (defaults to: nil) —

    If specified, determines the maximum number of work items to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

  • page_token (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Lower time bound of work items to include, by start time.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1472

def get_project_location_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetails', options)
  command.response_representation = Google::Apis::DataflowV1b3::StageExecutionDetails::Representation
  command.response_class = Google::Apis::DataflowV1b3::StageExecutionDetails
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['location'] = location unless location.nil?
  command.params['jobId'] = job_id unless job_id.nil?
  command.params['stageId'] = stage_id unless stage_id.nil?
  command.query['endTime'] = end_time unless end_time.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startTime'] = start_time unless start_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1629

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) (defaults to: nil) —

    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) (defaults to: nil) —

    The view to retrieve. Defaults to METADATA_ONLY.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1781

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) (defaults to: nil) —

    The location that contains this snapshot.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1870

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) (defaults to: nil) —

    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) (defaults to: nil) —

    The regional endpoint to which to direct the request.

  • view (String) (defaults to: nil) —

    The view to retrieve. Defaults to METADATA_ONLY.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 2020

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

#label_project_catalog_template(name, modify_template_version_label_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse

Updates the label of the TemplateVersion. Label can be duplicated in Template, so either add or remove the label in the TemplateVersion.

Parameters:

  • name (String) —

    Resource name includes project_id, display_name, and version_id. Updates by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/ pid1/catalogTemplates/tid1@vid

  • modify_template_version_label_request_object (Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 248

def label_project_catalog_template(name, modify_template_version_label_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1b3/{+name}:label', options)
  command.request_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest::Representation
  command.request_object = modify_template_version_label_request_object
  command.response_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse::Representation
  command.response_class = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#launch_flex_template(project_id, location, launch_flex_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse

Launch a job with a FlexTemplate.

Parameters:

  • project_id (String) —

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

  • location (String) —

    Required. The regional endpoint to which to direct the request. E.g., us-central1, us-west1.

  • launch_flex_template_request_object (Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 923

def launch_flex_template(project_id, location, launch_flex_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch', options)
  command.request_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest::Representation
  command.request_object = launch_flex_template_request_object
  command.response_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse::Representation
  command.response_class = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['location'] = location unless location.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) (defaults to: nil) —

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

  • dynamic_template_staging_location (String) (defaults to: nil) —

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

  • gcs_path (String) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1829

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) (defaults to: nil) —

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

  • dynamic_template_staging_location (String) (defaults to: nil) —

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

  • gcs_path (String) (defaults to: nil) —

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

  • location (String) (defaults to: nil) —

    The regional endpoint to which to direct the request.

  • validate_only (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 2068

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1515

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 812

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) (defaults to: nil) —

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

  • location (String) (defaults to: nil) —

    The regional endpoint that contains the job specified by job_id.

  • minimum_importance (String) (defaults to: nil) —

    Filter to only get messages with importance >= level

  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 772

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.list 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) (defaults to: nil) —

    The kind of filter to use.

  • location (String) (defaults to: nil) —

    The regional endpoint that contains this job.

  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • view (String) (defaults to: nil) —

    Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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) (defaults to: nil) —

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

  • minimum_importance (String) (defaults to: nil) —

    Filter to only get messages with importance >= level

  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1380

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1421

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.list 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) (defaults to: nil) —

    The kind of filter to use.

  • page_size (Fixnum) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • view (String) (defaults to: nil) —

    Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1158

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) (defaults to: nil) —

    If specified, list snapshots created from this job.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1665

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) (defaults to: nil) —

    If specified, list snapshots created from this job.

  • location (String) (defaults to: nil) —

    The location to list snapshots in.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1906

def list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots', options)
  command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
  command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['jobId'] = job_id unless job_id.nil?
  command.query['location'] = location unless location.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_template_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListTemplateVersionsResponse

List TemplateVersions using project_id and an optional display_name field. List all the TemplateVersions in the Template if display set. List all the TemplateVersions in the Project if display_name not set.

Parameters:

  • parent (String) —

    parent includes project_id, and display_name is optional. List by project_id( pid1) and display_name(tid1). Format: projects/pid1/catalogTemplates/tid1 List by project_id(pid1). Format: projects/pid1

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of TemplateVersions to return per page.

  • page_token (String) (defaults to: nil) —

    The page token, received from a previous ListTemplateVersions call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1947

def list_project_template_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1b3/{+parent}/templateVersions', options)
  command.response_representation = Google::Apis::DataflowV1b3::ListTemplateVersionsResponse::Representation
  command.response_class = Google::Apis::DataflowV1b3::ListTemplateVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1555

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 715

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1322

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 599

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1198

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

#tag_project_catalog_template(name, modify_template_version_tag_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse

Updates the tag of the TemplateVersion, and tag is unique in Template. If tag exists in another TemplateVersion in the Template, updates the tag to this TemplateVersion will remove it from the old TemplateVersion and add it to this TemplateVersion. If request is remove_only (remove_only = true), remove the tag from this TemplateVersion.

Parameters:

  • name (String) —

    Resource name includes project_id, display_name, and version_id. Updates by project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/ pid1/catalogTemplates/tid1@vid

  • modify_template_version_tag_request_object (Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def tag_project_catalog_template(name, modify_template_version_tag_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1b3/{+name}:tag', options)
  command.request_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest::Representation
  command.request_object = modify_template_version_tag_request_object
  command.response_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse::Representation
  command.response_class = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#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) (defaults to: nil) —

    The regional endpoint that contains this job.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1242

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) (defaults to: nil) —

    The sql query to validate.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1704

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 885

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 109

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