class Google::Cloud::Dataproc::V1::JobController::Client
Client
for the JobController
service.
The JobController
provides methods to manage jobs.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::Dataproc::V1::JobController::Operations]
Public Class Methods
Configure the JobController
Client
class.
See {::Google::Cloud::Dataproc::V1::JobController::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all JobController clients ::Google::Cloud::Dataproc::V1::JobController::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 54 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dataproc", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.submit_job.timeout = 900.0 default_config.rpcs.submit_job.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.submit_job_as_operation.timeout = 900.0 default_config.rpcs.submit_job_as_operation.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_job.timeout = 900.0 default_config.rpcs.get_job.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14] } default_config.rpcs.list_jobs.timeout = 900.0 default_config.rpcs.list_jobs.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14] } default_config.rpcs.update_job.timeout = 900.0 default_config.rpcs.update_job.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.cancel_job.timeout = 900.0 default_config.rpcs.cancel_job.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14] } default_config.rpcs.delete_job.timeout = 900.0 default_config.rpcs.delete_job.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end
Create a new JobController
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Dataproc::V1::JobController::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dataproc::V1::JobController::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the JobController
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 142 def initialize # 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 "gapic/grpc" require "google/cloud/dataproc/v1/jobs_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @job_controller_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dataproc::V1::JobController::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Starts a job cancellation request. To access the job resource after cancellation, call [regions/\{region}/jobs.list](cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or [regions/\{region}/jobs.get](cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).
@overload cancel_job
(request, options = nil)
Pass arguments to `cancel_job` via a request object, either of type {::Google::Cloud::Dataproc::V1::CancelJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::CancelJobRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload cancel_job
(project_id: nil, region: nil, job_id: nil)
Pass arguments to `cancel_job` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param project_id [::String] Required. The ID of the Google Cloud Platform project that the job belongs to. @param region [::String] Required. The Dataproc region in which to handle the request. @param job_id [::String] Required. The job ID.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataproc::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dataproc::V1::Job]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 665 def cancel_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::CancelJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.cancel_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id, "region" => request.region, "job_id" => request.job_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.cancel_job.timeout, metadata: metadata, retry_policy: @config.rpcs.cancel_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @job_controller_stub.call_rpc :cancel_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Configure the JobController
Client
instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.
See {::Google::Cloud::Dataproc::V1::JobController::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 121 def configure yield @config if block_given? @config end
Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.
@overload delete_job
(request, options = nil)
Pass arguments to `delete_job` via a request object, either of type {::Google::Cloud::Dataproc::V1::DeleteJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::DeleteJobRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_job
(project_id: nil, region: nil, job_id: nil)
Pass arguments to `delete_job` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param project_id [::String] Required. The ID of the Google Cloud Platform project that the job belongs to. @param region [::String] Required. The Dataproc region in which to handle the request. @param job_id [::String] Required. The job ID.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 741 def delete_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::DeleteJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id, "region" => request.region, "job_id" => request.job_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_job.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @job_controller_stub.call_rpc :delete_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets the resource representation for a job in a project.
@overload get_job
(request, options = nil)
Pass arguments to `get_job` via a request object, either of type {::Google::Cloud::Dataproc::V1::GetJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::GetJobRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_job
(project_id: nil, region: nil, job_id: nil)
Pass arguments to `get_job` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param project_id [::String] Required. The ID of the Google Cloud Platform project that the job belongs to. @param region [::String] Required. The Dataproc region in which to handle the request. @param job_id [::String] Required. The job ID.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataproc::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dataproc::V1::Job]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 401 def get_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::GetJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id, "region" => request.region, "job_id" => request.job_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_job.timeout, metadata: metadata, retry_policy: @config.rpcs.get_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @job_controller_stub.call_rpc :get_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists regions/\{region}/jobs in a project.
@overload list_jobs
(request, options = nil)
Pass arguments to `list_jobs` via a request object, either of type {::Google::Cloud::Dataproc::V1::ListJobsRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::ListJobsRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_jobs
(project_id: nil, region: nil, page_size: nil, page_token: nil, cluster_name: nil, job_state_matcher: nil, filter: nil)
Pass arguments to `list_jobs` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param project_id [::String] Required. The ID of the Google Cloud Platform project that the job belongs to. @param region [::String] Required. The Dataproc region in which to handle the request. @param page_size [::Integer] Optional. The number of results to return in each response. @param page_token [::String] Optional. The page token, returned by a previous call, to request the next page of results. @param cluster_name [::String] Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster. @param 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. @param 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 = *
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataproc::V1::Job>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Dataproc::V1::Job>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 502 def list_jobs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::ListJobsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_jobs.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id, "region" => request.region } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_jobs.timeout, metadata: metadata, retry_policy: @config.rpcs.list_jobs.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @job_controller_stub.call_rpc :list_jobs, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @job_controller_stub, :list_jobs, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Submits a job to a cluster.
@overload submit_job
(request, options = nil)
Pass arguments to `submit_job` via a request object, either of type {::Google::Cloud::Dataproc::V1::SubmitJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::SubmitJobRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload submit_job
(project_id: nil, region: nil, job: nil, request_id: nil)
Pass arguments to `submit_job` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param project_id [::String] Required. The ID of the Google Cloud Platform project that the job belongs to. @param region [::String] Required. The Dataproc region in which to handle the request. @param job [::Google::Cloud::Dataproc::V1::Job, ::Hash] Required. The job resource. @param request_id [::String] Optional. A unique id used to identify the request. If the server receives two [SubmitJobRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.SubmitJobRequest)s with the same id, then the second request will be ignored and the first {::Google::Cloud::Dataproc::V1::Job Job} created and stored in the backend is returned. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataproc::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dataproc::V1::Job]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 239 def submit_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::SubmitJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.submit_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id, "region" => request.region } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.submit_job.timeout, metadata: metadata, retry_policy: @config.rpcs.submit_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @job_controller_stub.call_rpc :submit_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Submits job to a cluster.
@overload submit_job_as_operation
(request, options = nil)
Pass arguments to `submit_job_as_operation` via a request object, either of type {::Google::Cloud::Dataproc::V1::SubmitJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::SubmitJobRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload submit_job_as_operation
(project_id: nil, region: nil, job: nil, request_id: nil)
Pass arguments to `submit_job_as_operation` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param project_id [::String] Required. The ID of the Google Cloud Platform project that the job belongs to. @param region [::String] Required. The Dataproc region in which to handle the request. @param job [::Google::Cloud::Dataproc::V1::Job, ::Hash] Required. The job resource. @param request_id [::String] Optional. A unique id used to identify the request. If the server receives two [SubmitJobRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.SubmitJobRequest)s with the same id, then the second request will be ignored and the first {::Google::Cloud::Dataproc::V1::Job Job} created and stored in the backend is returned. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 326 def submit_job_as_operation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::SubmitJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.submit_job_as_operation.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id, "region" => request.region } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.submit_job_as_operation.timeout, metadata: metadata, retry_policy: @config.rpcs.submit_job_as_operation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @job_controller_stub.call_rpc :submit_job_as_operation, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates a job in a project.
@overload update_job
(request, options = nil)
Pass arguments to `update_job` via a request object, either of type {::Google::Cloud::Dataproc::V1::UpdateJobRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::UpdateJobRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_job
(project_id: nil, region: nil, job_id: nil, job: nil, update_mask: nil)
Pass arguments to `update_job` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param project_id [::String] Required. The ID of the Google Cloud Platform project that the job belongs to. @param region [::String] Required. The Dataproc region in which to handle the request. @param job_id [::String] Required. The job ID. @param job [::Google::Cloud::Dataproc::V1::Job, ::Hash] Required. The changes to the job. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Required. Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be specified as <code>labels</code>, and the `PATCH` request body would specify the new value. <strong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataproc::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dataproc::V1::Job]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/job_controller/client.rb, line 586 def update_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::UpdateJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "project_id" => request.project_id, "region" => request.region, "job_id" => request.job_id } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_job.timeout, metadata: metadata, retry_policy: @config.rpcs.update_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @job_controller_stub.call_rpc :update_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end