class Google::Cloud::Dataflow::V1beta3::Jobs::Client

Client for the Jobs service.

Provides a method to create and modify Google Cloud Dataflow jobs. A Job is a multi-stage computation graph run by the Cloud Dataflow service.

Attributes

jobs_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the Jobs Client class.

See {::Google::Cloud::Dataflow::V1beta3::Jobs::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Jobs clients
::Google::Cloud::Dataflow::V1beta3::Jobs::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/dataflow/v1beta3/jobs/client.rb, line 55
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dataflow", "V1beta3"]
    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.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new Jobs client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dataflow::V1beta3::Jobs::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Jobs client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/dataflow/v1beta3/jobs/client.rb, line 110
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/dataflow/v1beta3/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

  @jobs_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dataflow::V1beta3::JobsV1Beta3::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

aggregated_list_jobs(request, options = nil) { |response, operation| ... } click to toggle source

List the jobs of a project across all regions.

@overload aggregated_list_jobs(request, options = nil)

Pass arguments to `aggregated_list_jobs` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::ListJobsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::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 aggregated_list_jobs(filter: nil, project_id: nil, view: nil, page_size: nil, page_token: nil, location: nil)

Pass arguments to `aggregated_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 filter [::Google::Cloud::Dataflow::V1beta3::ListJobsRequest::Filter]
  The kind of filter to use.
@param project_id [::String]
  The project which owns the jobs.
@param view [::Google::Cloud::Dataflow::V1beta3::JobView]
  Deprecated. ListJobs always returns summaries now.
  Use GetJob for other JobViews.
@param page_size [::Integer]
  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.
@param page_token [::String]
  Set this to the 'next_page_token' field of a previous response
  to request additional results in a long list.
@param location [::String]
  The [regional endpoint]
  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
  contains this job.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataflow::V1beta3::Job>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Dataflow::V1beta3::Job>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/jobs/client.rb, line 510
def aggregated_list_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::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.aggregated_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::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.aggregated_list_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.aggregated_list_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @jobs_stub.call_rpc :aggregated_list_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @jobs_stub, :aggregated_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
check_active_jobs(request, options = nil) { |response, operation| ... } click to toggle source

Check for existence of active jobs in the given project across all regions.

@overload check_active_jobs(request, options = nil)

Pass arguments to `check_active_jobs` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::CheckActiveJobsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::CheckActiveJobsRequest, ::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 check_active_jobs(project_id: nil)

Pass arguments to `check_active_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]
  The project which owns the jobs.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataflow::V1beta3::CheckActiveJobsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataflow::V1beta3::CheckActiveJobsResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/jobs/client.rb, line 573
def check_active_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::CheckActiveJobsRequest

  # 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.check_active_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::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.check_active_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.check_active_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @jobs_stub.call_rpc :check_active_jobs, 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() { |config| ... } click to toggle source

Configure the Jobs 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::Dataflow::V1beta3::Jobs::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/dataflow/v1beta3/jobs/client.rb, line 89
def configure
  yield @config if block_given?
  @config
end
create_job(request, options = nil) { |response, operation| ... } click to toggle source

Creates a Cloud Dataflow job.

To create a job, we recommend using `projects.locations.jobs.create` with a

regional endpoint

(cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`.

@overload create_job(request, options = nil)

Pass arguments to `create_job` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::CreateJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::CreateJobRequest, ::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 create_job(project_id: nil, job: nil, view: nil, replace_job_id: nil, location: nil)

Pass arguments to `create_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]
  The ID of the Cloud Platform project that the job belongs to.
@param job [::Google::Cloud::Dataflow::V1beta3::Job, ::Hash]
  The job to create.
@param view [::Google::Cloud::Dataflow::V1beta3::JobView]
  The level of information requested in response.
@param replace_job_id [::String]
  Deprecated. This field is now in the Job message.
@param location [::String]
  The [regional endpoint]
  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
  contains this job.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataflow::V1beta3::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataflow::V1beta3::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/jobs/client.rb, line 193
def create_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::CreateJobRequest

  # 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.create_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::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @jobs_stub.call_rpc :create_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
get_job(request, options = nil) { |response, operation| ... } click to toggle source

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] (cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`.

@overload get_job(request, options = nil)

Pass arguments to `get_job` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::GetJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::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, job_id: nil, view: nil, location: 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]
  The ID of the Cloud Platform project that the job belongs to.
@param job_id [::String]
  The job ID.
@param view [::Google::Cloud::Dataflow::V1beta3::JobView]
  The level of information requested in response.
@param location [::String]
  The [regional endpoint]
  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
  contains this job.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataflow::V1beta3::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataflow::V1beta3::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/jobs/client.rb, line 269
def get_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::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::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  @jobs_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
list_jobs(request, options = nil) { |response, operation| ... } click to toggle source

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] (cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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`.

@overload list_jobs(request, options = nil)

Pass arguments to `list_jobs` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::ListJobsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::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(filter: nil, project_id: nil, view: nil, page_size: nil, page_token: nil, location: 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 filter [::Google::Cloud::Dataflow::V1beta3::ListJobsRequest::Filter]
  The kind of filter to use.
@param project_id [::String]
  The project which owns the jobs.
@param view [::Google::Cloud::Dataflow::V1beta3::JobView]
  Deprecated. ListJobs always returns summaries now.
  Use GetJob for other JobViews.
@param page_size [::Integer]
  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.
@param page_token [::String]
  Set this to the 'next_page_token' field of a previous response
  to request additional results in a long list.
@param location [::String]
  The [regional endpoint]
  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
  contains this job.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataflow::V1beta3::Job>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Dataflow::V1beta3::Job>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/jobs/client.rb, line 431
def list_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::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::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  @jobs_stub.call_rpc :list_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @jobs_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
snapshot_job(request, options = nil) { |response, operation| ... } click to toggle source

Snapshot the state of a streaming job.

@overload snapshot_job(request, options = nil)

Pass arguments to `snapshot_job` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::SnapshotJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::SnapshotJobRequest, ::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 snapshot_job(project_id: nil, job_id: nil, ttl: nil, location: nil, snapshot_sources: nil, description: nil)

Pass arguments to `snapshot_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]
  The project which owns the job to be snapshotted.
@param job_id [::String]
  The job to be snapshotted.
@param ttl [::Google::Protobuf::Duration, ::Hash]
  TTL for the snapshot.
@param location [::String]
  The location that contains this job.
@param snapshot_sources [::Boolean]
  If true, perform snapshots for sources which support this.
@param description [::String]
  User specified description of the snapshot. Maybe empty.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataflow::V1beta3::Snapshot] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataflow::V1beta3::Snapshot]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/jobs/client.rb, line 645
def snapshot_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::SnapshotJobRequest

  # 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.snapshot_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::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.snapshot_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.snapshot_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @jobs_stub.call_rpc :snapshot_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
update_job(request, options = nil) { |response, operation| ... } click to toggle source

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] (cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`.

@overload update_job(request, options = nil)

Pass arguments to `update_job` via a request object, either of type
{::Google::Cloud::Dataflow::V1beta3::UpdateJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataflow::V1beta3::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, job_id: nil, job: nil, location: 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]
  The ID of the Cloud Platform project that the job belongs to.
@param job_id [::String]
  The job ID.
@param job [::Google::Cloud::Dataflow::V1beta3::Job, ::Hash]
  The updated job.
  Only the job state is updatable; other fields will be ignored.
@param location [::String]
  The [regional endpoint]
  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
  contains this job.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataflow::V1beta3::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataflow::V1beta3::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataflow/v1beta3/jobs/client.rb, line 346
def update_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataflow::V1beta3::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::Dataflow::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  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

  @jobs_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