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



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
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 112

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

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

  package_version = Google::Cloud::Dataproc::VERSION

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

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "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 = service_address || self.class::SERVICE_ADDRESS
  port = service_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, request_id: nil, options: nil) ⇒ Google::Gax::Operation

Creates a cluster in a project. The returned Operation#metadata will be ClusterOperationMetadata.

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!

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 305

def create_cluster \
    project_id,
    region,
    cluster,
    request_id: nil,
    options: nil
  req = {
    project_id: project_id,
    region: region,
    cluster: cluster,
    request_id: request_id
  }.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, cluster_uuid: nil, request_id: nil, options: nil) ⇒ Google::Gax::Operation

Deletes a cluster in a project. The returned Operation#metadata will be ClusterOperationMetadata.

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!

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 575

def delete_cluster \
    project_id,
    region,
    cluster_name,
    cluster_uuid: nil,
    request_id: nil,
    options: nil
  req = {
    project_id: project_id,
    region: region,
    cluster_name: cluster_name,
    cluster_uuid: cluster_uuid,
    request_id: request_id
  }.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. The returned Operation#metadata will be ClusterOperationMetadata. After the operation completes, Operation#response contains DiagnoseClusterResults.

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!

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 795

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)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 633

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 717

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, graceful_decommission_timeout: nil, request_id: nil, options: nil) ⇒ Google::Gax::Operation

Updates a cluster in a project. The returned Operation#metadata will be ClusterOperationMetadata.

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!

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 473

def update_cluster \
    project_id,
    region,
    cluster_name,
    cluster,
    update_mask,
    graceful_decommission_timeout: nil,
    request_id: nil,
    options: nil
  req = {
    project_id: project_id,
    region: region,
    cluster_name: cluster_name,
    cluster: cluster,
    update_mask: update_mask,
    graceful_decommission_timeout: graceful_decommission_timeout,
    request_id: request_id
  }.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