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, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ JobControllerClient 



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
203
204
205
206
207
208
209
210
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 104

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: 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 = Google::Cloud::Dataproc::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 = service_address || self.class::SERVICE_ADDRESS
  port = service_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)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 523

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)

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.



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 570

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)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 309

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 396

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, request_id: nil, 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)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 260

def submit_job \
    project_id,
    region,
    job,
    request_id: nil,
    options: nil,
    &block
  req = {
    project_id: project_id,
    region: region,
    job: job,
    request_id: request_id
  }.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)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/google/cloud/dataproc/v1/job_controller_client.rb', line 468

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