Class: Google::Cloud::Dataproc::V1::JobControllerClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dataproc/v1/job_controller_client.rb

Overview

The JobController provides methods to manage jobs.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"dataproc.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ JobControllerClient

Returns a new instance of JobControllerClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 98

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/cloud/dataproc/v1/jobs_services_pb"

  credentials ||= Google::Cloud::Dataproc::V1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Dataproc::V1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-dataproc'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "job_controller_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.dataproc.v1.JobController",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @job_controller_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Dataproc::V1::JobController::Stub.method(:new)
  )

  @submit_job = Google::Gax.create_api_call(
    @job_controller_stub.method(:submit_job),
    defaults["submit_job"],
    exception_transformer: exception_transformer
  )
  @get_job = Google::Gax.create_api_call(
    @job_controller_stub.method(:get_job),
    defaults["get_job"],
    exception_transformer: exception_transformer
  )
  @list_jobs = Google::Gax.create_api_call(
    @job_controller_stub.method(:list_jobs),
    defaults["list_jobs"],
    exception_transformer: exception_transformer
  )
  @update_job = Google::Gax.create_api_call(
    @job_controller_stub.method(:update_job),
    defaults["update_job"],
    exception_transformer: exception_transformer
  )
  @cancel_job = Google::Gax.create_api_call(
    @job_controller_stub.method(:cancel_job),
    defaults["cancel_job"],
    exception_transformer: exception_transformer
  )
  @delete_job = Google::Gax.create_api_call(
    @job_controller_stub.method(:delete_job),
    defaults["delete_job"],
    exception_transformer: exception_transformer
  )
end

Instance Method Details

#cancel_job(project_id, region, job_id, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::Job

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

Examples:

require "google/cloud/dataproc"

job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)

# TODO: Initialize +project_id+:
project_id = ''

# TODO: Initialize +region+:
region = ''

# TODO: Initialize +job_id+:
job_id = ''
response = job_controller_client.cancel_job(project_id, region, job_id)

Parameters:

  • project_id (String) —

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

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 500

def cancel_job \
    project_id,
    region,
    job_id,
    options: nil,
    &block
  req = {
    project_id: project_id,
    region: region,
    job_id: job_id
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::CancelJobRequest)
  @cancel_job.call(req, options, &block)
end

#delete_job(project_id, region, job_id, options: nil) {|result, operation| ... } ⇒ Object

Deletes the job from the project. If the job is active, the delete fails, and the response returns +FAILED_PRECONDITION+.

Examples:

require "google/cloud/dataproc"

job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)

# TODO: Initialize +project_id+:
project_id = ''

# TODO: Initialize +region+:
region = ''

# TODO: Initialize +job_id+:
job_id = ''
job_controller_client.delete_job(project_id, region, job_id)

Parameters:

  • project_id (String) —

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

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 547

def delete_job \
    project_id,
    region,
    job_id,
    options: nil,
    &block
  req = {
    project_id: project_id,
    region: region,
    job_id: job_id
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::DeleteJobRequest)
  @delete_job.call(req, options, &block)
  nil
end

#get_job(project_id, region, job_id, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::Job

Gets the resource representation for a job in a project.

Examples:

require "google/cloud/dataproc"

job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)

# TODO: Initialize +project_id+:
project_id = ''

# TODO: Initialize +region+:
region = ''

# TODO: Initialize +job_id+:
job_id = ''
response = job_controller_client.get_job(project_id, region, job_id)

Parameters:

  • project_id (String) —

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

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 287

def get_job \
    project_id,
    region,
    job_id,
    options: nil,
    &block
  req = {
    project_id: project_id,
    region: region,
    job_id: job_id
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::GetJobRequest)
  @get_job.call(req, options, &block)
end

#list_jobs(project_id, region, page_size: nil, cluster_name: nil, job_state_matcher: nil, filter: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dataproc::V1::Job>

Lists regions/{region}/jobs in a project.

Examples:

require "google/cloud/dataproc"

job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)

# TODO: Initialize +project_id+:
project_id = ''

# TODO: Initialize +region+:
region = ''

# Iterate over all results.
job_controller_client.list_jobs(project_id, region).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
job_controller_client.list_jobs(project_id, region).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • project_id (String) —

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

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • cluster_name (String) —

    Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

  • job_state_matcher (Google::Cloud::Dataproc::V1::ListJobsRequest::JobStateMatcher) —

    Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

    If +filter+ is provided, +jobStateMatcher+ will be ignored.

  • filter (String) —

    Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:

    [field = value] AND [field [= value]] ...

    where field is +status.state+ or +labels.[KEY]+, and +[KEY]+ is a label key. value can be +*+ to match all values. +status.state+ can be either +ACTIVE+ or +NON_ACTIVE+. Only the logical +AND+ operator is supported; space-separated items are treated as having an implicit +AND+ operator.

    Example filter:

    status.state = ACTIVE AND labels.env = staging AND labels.starred = *

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Dataproc::V1::Job>) —

    An enumerable of Google::Cloud::Dataproc::V1::Job instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 374

def list_jobs \
    project_id,
    region,
    page_size: nil,
    cluster_name: nil,
    job_state_matcher: nil,
    filter: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    region: region,
    page_size: page_size,
    cluster_name: cluster_name,
    job_state_matcher: job_state_matcher,
    filter: filter
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::ListJobsRequest)
  @list_jobs.call(req, options, &block)
end

#submit_job(project_id, region, job, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::Job

Submits a job to a cluster.

Examples:

require "google/cloud/dataproc"

job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)

# TODO: Initialize +project_id+:
project_id = ''

# TODO: Initialize +region+:
region = ''

# TODO: Initialize +job+:
job = {}
response = job_controller_client.submit_job(project_id, region, job)

Parameters:

  • project_id (String) —

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

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job (Google::Cloud::Dataproc::V1::Job | Hash) —

    Required. The job resource. A hash of the same form as Google::Cloud::Dataproc::V1::Job can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 240

def submit_job \
    project_id,
    region,
    job,
    options: nil,
    &block
  req = {
    project_id: project_id,
    region: region,
    job: job
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::SubmitJobRequest)
  @submit_job.call(req, options, &block)
end

#update_job(project_id, region, job_id, job, update_mask, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::Job

Updates a job in a project.

Examples:

require "google/cloud/dataproc"

job_controller_client = Google::Cloud::Dataproc::JobController.new(version: :v1)

# TODO: Initialize +project_id+:
project_id = ''

# TODO: Initialize +region+:
region = ''

# TODO: Initialize +job_id+:
job_id = ''

# TODO: Initialize +job+:
job = {}

# TODO: Initialize +update_mask+:
update_mask = {}
response = job_controller_client.update_job(project_id, region, job_id, job, update_mask)

Parameters:

  • project_id (String) —

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

  • region (String) —

    Required. The Cloud Dataproc region in which to handle the request.

  • job_id (String) —

    Required. The job ID.

  • job (Google::Cloud::Dataproc::V1::Job | Hash) —

    Required. The changes to the job. A hash of the same form as Google::Cloud::Dataproc::V1::Job can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the +PATCH+ request body would specify the new value. Note: Currently, labels is the only field that can be updated. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 446

def update_job \
    project_id,
    region,
    job_id,
    job,
    update_mask,
    options: nil,
    &block
  req = {
    project_id: project_id,
    region: region,
    job_id: job_id,
    job: job,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::UpdateJobRequest)
  @update_job.call(req, options, &block)
end