class Google::Cloud::Dataproc::V1::ClusterController::Client

Client for the ClusterController service.

The ClusterControllerService provides methods to manage clusters of Compute Engine instances.

Attributes

cluster_controller_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::Dataproc::V1::ClusterController::Operations]

Public Class Methods

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

Configure the ClusterController Client class.

See {::Google::Cloud::Dataproc::V1::ClusterController::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all ClusterController clients
::Google::Cloud::Dataproc::V1::ClusterController::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/cluster_controller/client.rb, line 57
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.create_cluster.timeout = 300.0
    default_config.rpcs.create_cluster.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_cluster.timeout = 300.0
    default_config.rpcs.update_cluster.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_cluster.timeout = 300.0
    default_config.rpcs.delete_cluster.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_cluster.timeout = 300.0
    default_config.rpcs.get_cluster.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [13, 4, 14]
    }

    default_config.rpcs.list_clusters.timeout = 300.0
    default_config.rpcs.list_clusters.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [13, 4, 14]
    }

    default_config.rpcs.diagnose_cluster.timeout = 300.0
    default_config.rpcs.diagnose_cluster.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
new() { |config| ... } click to toggle source

Create a new ClusterController client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Dataproc::V1::ClusterController::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dataproc::V1::ClusterController::Client.new do |config|
  config.timeout = 10.0
end

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

# File lib/google/cloud/dataproc/v1/cluster_controller/client.rb, line 140
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/clusters_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

  @cluster_controller_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dataproc::V1::ClusterController::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

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

Configure the ClusterController 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::ClusterController::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/cluster_controller/client.rb, line 119
def configure
  yield @config if block_given?
  @config
end
create_cluster(request, options = nil) { |response, operation| ... } click to toggle source

Creates a cluster in a project. The returned {::Google::Longrunning::Operation#metadata Operation.metadata} will be [ClusterOperationMetadata](cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).

@overload create_cluster(request, options = nil)

Pass arguments to `create_cluster` via a request object, either of type
{::Google::Cloud::Dataproc::V1::CreateClusterRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataproc::V1::CreateClusterRequest, ::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_cluster(project_id: nil, region: nil, cluster: nil, request_id: nil)

Pass arguments to `create_cluster` 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 cluster
  belongs to.
@param region [::String]
  Required. The Dataproc region in which to handle the request.
@param cluster [::Google::Cloud::Dataproc::V1::Cluster, ::Hash]
  Required. The cluster to create.
@param request_id [::String]
  Optional. A unique id used to identify the request. If the server receives two
  [CreateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s
  with the same id, then the second request will be ignored and the
  first {::Google::Longrunning::Operation google.longrunning.Operation} 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/cluster_controller/client.rb, line 238
def create_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::CreateClusterRequest

  # 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_cluster.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.create_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_cluster.retry_policy

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

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

Deletes a cluster in a project. The returned {::Google::Longrunning::Operation#metadata Operation.metadata} will be [ClusterOperationMetadata](cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).

@overload delete_cluster(request, options = nil)

Pass arguments to `delete_cluster` via a request object, either of type
{::Google::Cloud::Dataproc::V1::DeleteClusterRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataproc::V1::DeleteClusterRequest, ::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_cluster(project_id: nil, region: nil, cluster_name: nil, cluster_uuid: nil, request_id: nil)

Pass arguments to `delete_cluster` 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 cluster
  belongs to.
@param region [::String]
  Required. The Dataproc region in which to handle the request.
@param cluster_name [::String]
  Required. The cluster name.
@param cluster_uuid [::String]
  Optional. Specifying the `cluster_uuid` means the RPC should fail
  (with error NOT_FOUND) if cluster with specified UUID does not exist.
@param request_id [::String]
  Optional. A unique id used to identify the request. If the server
  receives two
  [DeleteClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteClusterRequest)s
  with the same id, then the second request will be ignored and the
  first {::Google::Longrunning::Operation google.longrunning.Operation} 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/cluster_controller/client.rb, line 670
def delete_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::DeleteClusterRequest

  # 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_cluster.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,
    "cluster_name" => request.cluster_name
  }
  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_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_cluster.retry_policy

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

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

Gets cluster diagnostic information. The returned {::Google::Longrunning::Operation#metadata Operation.metadata} will be [ClusterOperationMetadata](cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, {::Google::Longrunning::Operation#response Operation.response} contains [DiagnoseClusterResults](cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).

@overload diagnose_cluster(request, options = nil)

Pass arguments to `diagnose_cluster` via a request object, either of type
{::Google::Cloud::Dataproc::V1::DiagnoseClusterRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataproc::V1::DiagnoseClusterRequest, ::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 diagnose_cluster(project_id: nil, region: nil, cluster_name: nil)

Pass arguments to `diagnose_cluster` 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 cluster
  belongs to.
@param region [::String]
  Required. The Dataproc region in which to handle the request.
@param cluster_name [::String]
  Required. The cluster name.

@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/cluster_controller/client.rb, line 924
def diagnose_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::DiagnoseClusterRequest

  # 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.diagnose_cluster.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,
    "cluster_name" => request.cluster_name
  }
  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.diagnose_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.diagnose_cluster.retry_policy

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

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

Gets the resource representation for a cluster in a project.

@overload get_cluster(request, options = nil)

Pass arguments to `get_cluster` via a request object, either of type
{::Google::Cloud::Dataproc::V1::GetClusterRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataproc::V1::GetClusterRequest, ::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_cluster(project_id: nil, region: nil, cluster_name: nil)

Pass arguments to `get_cluster` 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 cluster
  belongs to.
@param region [::String]
  Required. The Dataproc region in which to handle the request.
@param cluster_name [::String]
  Required. The cluster name.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataproc::V1::Cluster] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dataproc::V1::Cluster]

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

# File lib/google/cloud/dataproc/v1/cluster_controller/client.rb, line 746
def get_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::GetClusterRequest

  # 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_cluster.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,
    "cluster_name" => request.cluster_name
  }
  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_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_cluster.retry_policy

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

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

Lists all regions/\{region}/clusters in a project alphabetically.

@overload list_clusters(request, options = nil)

Pass arguments to `list_clusters` via a request object, either of type
{::Google::Cloud::Dataproc::V1::ListClustersRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataproc::V1::ListClustersRequest, ::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_clusters(project_id: nil, region: nil, filter: nil, page_size: nil, page_token: nil)

Pass arguments to `list_clusters` 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 cluster
  belongs to.
@param region [::String]
  Required. The Dataproc region in which to handle the request.
@param filter [::String]
  Optional. A filter constraining the clusters to list. Filters are
  case-sensitive and have the following syntax:

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

  where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`,
  and `[KEY]` is a label key. **value** can be `*` to match all values.
  `status.state` can be one of the following: `ACTIVE`, `INACTIVE`,
  `CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE`
  contains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE`
  contains the `DELETING` and `ERROR` states.
  `clusterName` is the name of the cluster provided at creation time.
  Only the logical `AND` operator is supported; space-separated items are
  treated as having an implicit `AND` operator.

  Example filter:

  status.state = ACTIVE AND clusterName = mycluster
  AND labels.env = staging AND labels.starred = *
@param page_size [::Integer]
  Optional. The standard List page size.
@param page_token [::String]
  Optional. The standard List page token.

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

@return [::Gapic::PagedEnumerable<::Google::Cloud::Dataproc::V1::Cluster>]

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

# File lib/google/cloud/dataproc/v1/cluster_controller/client.rb, line 843
def list_clusters request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::ListClustersRequest

  # 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_clusters.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_clusters.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_clusters.retry_policy

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

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

Starts a cluster in a project.

@overload start_cluster(request, options = nil)

Pass arguments to `start_cluster` via a request object, either of type
{::Google::Cloud::Dataproc::V1::StartClusterRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataproc::V1::StartClusterRequest, ::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 start_cluster(project_id: nil, region: nil, cluster_name: nil, cluster_uuid: nil, request_id: nil)

Pass arguments to `start_cluster` 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 the
  cluster belongs to.
@param region [::String]
  Required. The Dataproc region in which to handle the request.
@param cluster_name [::String]
  Required. The cluster name.
@param cluster_uuid [::String]
  Optional. Specifying the `cluster_uuid` means the RPC will fail
  (with error NOT_FOUND) if a cluster with the specified UUID does not exist.
@param request_id [::String]
  Optional. A unique id used to identify the request. If the server
  receives two
  [StartClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StartClusterRequest)s
  with the same id, then the second request will be ignored and the
  first {::Google::Longrunning::Operation google.longrunning.Operation} created and stored in the
  backend is returned.

  Recommendation: 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/cluster_controller/client.rb, line 576
def start_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::StartClusterRequest

  # 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.start_cluster.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,
    "cluster_name" => request.cluster_name
  }
  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.start_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.start_cluster.retry_policy

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

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

Stops a cluster in a project.

@overload stop_cluster(request, options = nil)

Pass arguments to `stop_cluster` via a request object, either of type
{::Google::Cloud::Dataproc::V1::StopClusterRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataproc::V1::StopClusterRequest, ::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 stop_cluster(project_id: nil, region: nil, cluster_name: nil, cluster_uuid: nil, request_id: nil)

Pass arguments to `stop_cluster` 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 the
  cluster belongs to.
@param region [::String]
  Required. The Dataproc region in which to handle the request.
@param cluster_name [::String]
  Required. The cluster name.
@param cluster_uuid [::String]
  Optional. Specifying the `cluster_uuid` means the RPC will fail
  (with error NOT_FOUND) if a cluster with the specified UUID does not exist.
@param request_id [::String]
  Optional. A unique id used to identify the request. If the server
  receives two
  [StopClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StopClusterRequest)s
  with the same id, then the second request will be ignored and the
  first {::Google::Longrunning::Operation google.longrunning.Operation} created and stored in the
  backend is returned.

  Recommendation: 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/cluster_controller/client.rb, line 484
def stop_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::StopClusterRequest

  # 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.stop_cluster.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,
    "cluster_name" => request.cluster_name
  }
  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.stop_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.stop_cluster.retry_policy

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

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

Updates a cluster in a project. The returned {::Google::Longrunning::Operation#metadata Operation.metadata} will be [ClusterOperationMetadata](cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).

@overload update_cluster(request, options = nil)

Pass arguments to `update_cluster` via a request object, either of type
{::Google::Cloud::Dataproc::V1::UpdateClusterRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dataproc::V1::UpdateClusterRequest, ::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_cluster(project_id: nil, region: nil, cluster_name: nil, cluster: nil, graceful_decommission_timeout: nil, update_mask: nil, request_id: nil)

Pass arguments to `update_cluster` 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 the
  cluster belongs to.
@param region [::String]
  Required. The Dataproc region in which to handle the request.
@param cluster_name [::String]
  Required. The cluster name.
@param cluster [::Google::Cloud::Dataproc::V1::Cluster, ::Hash]
  Required. The changes to the cluster.
@param graceful_decommission_timeout [::Google::Protobuf::Duration, ::Hash]
  Optional. Timeout for graceful YARN decomissioning. Graceful
  decommissioning allows removing nodes from the cluster without
  interrupting jobs in progress. Timeout specifies how long to wait for jobs
  in progress to finish before forcefully removing nodes (and potentially
  interrupting jobs). Default timeout is 0 (for forceful decommission), and
  the maximum allowed timeout is 1 day. (see JSON representation of
  [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).

  Only supported on Dataproc image versions 1.2 and higher.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Required. Specifies the path, relative to `Cluster`, of
  the field to update. For example, to change the number of workers
  in a cluster to 5, the `update_mask` parameter would be
  specified as `config.worker_config.num_instances`,
  and the `PATCH` request body would specify the new value, as follows:

      {
        "config":{
          "workerConfig":{
            "numInstances":"5"
          }
        }
      }
  Similarly, to change the number of preemptible workers in a cluster to 5,
  the `update_mask` parameter would be
  `config.secondary_worker_config.num_instances`, and the `PATCH` request
  body would be set as follows:

      {
        "config":{
          "secondaryWorkerConfig":{
            "numInstances":"5"
          }
        }
      }
  <strong>Note:</strong> Currently, only the following fields can be updated:

   <table>
   <tbody>
   <tr>
   <td><strong>Mask</strong></td>
   <td><strong>Purpose</strong></td>
   </tr>
   <tr>
   <td><strong><em>labels</em></strong></td>
   <td>Update labels</td>
   </tr>
   <tr>
   <td><strong><em>config.worker_config.num_instances</em></strong></td>
   <td>Resize primary worker group</td>
   </tr>
   <tr>
   <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td>
   <td>Resize secondary worker group</td>
   </tr>
   <tr>
   <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or
   change autoscaling policies</td>
   </tr>
   </tbody>
   </table>
@param request_id [::String]
  Optional. A unique id used to identify the request. If the server
  receives two
  [UpdateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s
  with the same id, then the second request will be ignored and the
  first {::Google::Longrunning::Operation google.longrunning.Operation} 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/cluster_controller/client.rb, line 392
def update_cluster request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::UpdateClusterRequest

  # 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_cluster.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,
    "cluster_name" => request.cluster_name
  }
  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_cluster.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_cluster.retry_policy

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

  @cluster_controller_stub.call_rpc :update_cluster, 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