Class: Google::Cloud::Dataproc::V1::ClusterControllerClient

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

Overview

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

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"dataproc.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

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

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

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ClusterControllerClient

Parameters:

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

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

  • scopes (Array<String>) —

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

  • client_config (Hash) —

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

  • timeout (Numeric) —

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

  • metadata (Hash) —

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

  • exception_transformer (Proc) —

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



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

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

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

  @operations_client = OperationsClient.new(
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    lib_name: lib_name,
    lib_version: lib_version,
  )

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

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

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

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

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

  @create_cluster = Google::Gax.create_api_call(
    @cluster_controller_stub.method(:create_cluster),
    defaults["create_cluster"],
    exception_transformer: exception_transformer
  )
  @update_cluster = Google::Gax.create_api_call(
    @cluster_controller_stub.method(:update_cluster),
    defaults["update_cluster"],
    exception_transformer: exception_transformer
  )
  @delete_cluster = Google::Gax.create_api_call(
    @cluster_controller_stub.method(:delete_cluster),
    defaults["delete_cluster"],
    exception_transformer: exception_transformer
  )
  @get_cluster = Google::Gax.create_api_call(
    @cluster_controller_stub.method(:get_cluster),
    defaults["get_cluster"],
    exception_transformer: exception_transformer
  )
  @list_clusters = Google::Gax.create_api_call(
    @cluster_controller_stub.method(:list_clusters),
    defaults["list_clusters"],
    exception_transformer: exception_transformer
  )
  @diagnose_cluster = Google::Gax.create_api_call(
    @cluster_controller_stub.method(:diagnose_cluster),
    defaults["diagnose_cluster"],
    exception_transformer: exception_transformer
  )
end

Instance Method Details

#create_cluster(project_id, region, cluster, options: nil) ⇒ Google::Gax::Operation

Creates a cluster in a project.

Examples:

require "google/cloud/dataproc"

cluster_controller_client = Google::Cloud::Dataproc::ClusterController.new(version: :v1)

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

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

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

# Register a callback during the method call.
operation = cluster_controller_client.create_cluster(project_id, region, cluster) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster (Google::Cloud::Dataproc::V1::Cluster | Hash) —

    Required. The cluster to create. A hash of the same form as Google::Cloud::Dataproc::V1::Cluster can also be provided.

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

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

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 280

def create_cluster \
    project_id,
    region,
    cluster,
    options: nil
  req = {
    project_id: project_id,
    region: region,
    cluster: cluster
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::CreateClusterRequest)
  operation = Google::Gax::Operation.new(
    @create_cluster.call(req, options),
    @operations_client,
    Google::Cloud::Dataproc::V1::Cluster,
    Google::Cloud::Dataproc::V1::ClusterOperationMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#delete_cluster(project_id, region, cluster_name, options: nil) ⇒ Google::Gax::Operation

Deletes a cluster in a project.

Examples:

require "google/cloud/dataproc"

cluster_controller_client = Google::Cloud::Dataproc::ClusterController.new(version: :v1)

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

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

# TODO: Initialize +cluster_name+:
cluster_name = ''

# Register a callback during the method call.
operation = cluster_controller_client.delete_cluster(project_id, region, cluster_name) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_name (String) —

    Required. The cluster name.

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

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

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 498

def delete_cluster \
    project_id,
    region,
    cluster_name,
    options: nil
  req = {
    project_id: project_id,
    region: region,
    cluster_name: cluster_name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::DeleteClusterRequest)
  operation = Google::Gax::Operation.new(
    @delete_cluster.call(req, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Cloud::Dataproc::V1::ClusterOperationMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#diagnose_cluster(project_id, region, cluster_name, options: nil) ⇒ Google::Gax::Operation

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains +DiagnoseClusterOutputLocation+.

Examples:

require "google/cloud/dataproc"

cluster_controller_client = Google::Cloud::Dataproc::ClusterController.new(version: :v1)

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

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

# TODO: Initialize +cluster_name+:
cluster_name = ''

# Register a callback during the method call.
operation = cluster_controller_client.diagnose_cluster(project_id, region, cluster_name) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_name (String) —

    Required. The cluster name.

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

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

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 710

def diagnose_cluster \
    project_id,
    region,
    cluster_name,
    options: nil
  req = {
    project_id: project_id,
    region: region,
    cluster_name: cluster_name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::DiagnoseClusterRequest)
  operation = Google::Gax::Operation.new(
    @diagnose_cluster.call(req, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Cloud::Dataproc::V1::DiagnoseClusterResults,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#get_cluster(project_id, region, cluster_name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::Cluster

Gets the resource representation for a cluster in a project.

Examples:

require "google/cloud/dataproc"

cluster_controller_client = Google::Cloud::Dataproc::ClusterController.new(version: :v1)

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

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

# TODO: Initialize +cluster_name+:
cluster_name = ''
response = cluster_controller_client.get_cluster(project_id, region, cluster_name)

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_name (String) —

    Required. The cluster name.

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 552

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

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

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

Examples:

require "google/cloud/dataproc"

cluster_controller_client = Google::Cloud::Dataproc::ClusterController.new(version: :v1)

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

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

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

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

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • 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 = *

  • page_size (Integer) —

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

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

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

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 636

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

#update_cluster(project_id, region, cluster_name, cluster, update_mask, options: nil) ⇒ Google::Gax::Operation

Updates a cluster in a project.

Examples:

require "google/cloud/dataproc"

cluster_controller_client = Google::Cloud::Dataproc::ClusterController.new(version: :v1)

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

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

# TODO: Initialize +cluster_name+:
cluster_name = ''

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

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

# Register a callback during the method call.
operation = cluster_controller_client.update_cluster(project_id, region, cluster_name, cluster, update_mask) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • project_id (String) —

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

  • region (String) —

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

  • cluster_name (String) —

    Required. The cluster name.

  • cluster (Google::Cloud::Dataproc::V1::Cluster | Hash) —

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

  • 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"
    }
  }
}

    Note: Currently, only the following fields can be updated:

    Mask Purpose
    labels Update labels
    config.worker_config.num_instances Resize primary worker group
    config.secondary_worker_config.num_instances Resize secondary worker group
    A hash of the same form as Google::Protobuf::FieldMask can also be provided.

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

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

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 417

def update_cluster \
    project_id,
    region,
    cluster_name,
    cluster,
    update_mask,
    options: nil
  req = {
    project_id: project_id,
    region: region,
    cluster_name: cluster_name,
    cluster: cluster,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::UpdateClusterRequest)
  operation = Google::Gax::Operation.new(
    @update_cluster.call(req, options),
    @operations_client,
    Google::Cloud::Dataproc::V1::Cluster,
    Google::Cloud::Dataproc::V1::ClusterOperationMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end