Class: Google::Cloud::Dataproc::V1::ClusterControllerClient
- Inherits:
-
Object
- Object
- Google::Cloud::Dataproc::V1::ClusterControllerClient
- 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
-
#create_cluster(project_id, region, cluster, request_id: nil, options: nil) ⇒ Google::Gax::Operation
Creates a cluster in a project.
-
#delete_cluster(project_id, region, cluster_name, cluster_uuid: nil, request_id: nil, options: nil) ⇒ Google::Gax::Operation
Deletes a cluster in a project.
-
#diagnose_cluster(project_id, region, cluster_name, options: nil) ⇒ Google::Gax::Operation
Gets cluster diagnostic information.
-
#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.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ ClusterControllerClient
constructor
A new instance of ClusterControllerClient.
-
#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.
-
#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.
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.
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 220 |
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 107 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!() unless .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, request_id: nil, options: nil) ⇒ Google::Gax::Operation
Creates a cluster in a project.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 293 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, ), @operations_client, Google::Cloud::Dataproc::V1::Cluster, Google::Cloud::Dataproc::V1::ClusterOperationMetadata, call_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.
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 |
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 555 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, ), @operations_client, Google::Protobuf::Empty, Google::Cloud::Dataproc::V1::ClusterOperationMetadata, call_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.
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 |
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 771 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, ), @operations_client, Google::Protobuf::Empty, Google::Cloud::Dataproc::V1::DiagnoseClusterResults, call_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.
613 614 615 616 617 618 619 620 621 622 623 624 625 626 |
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 613 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, , &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.
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 |
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 697 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, , &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.
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 |
# File 'lib/google/cloud/dataproc/v1/cluster_controller_client.rb', line 455 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, ), @operations_client, Google::Cloud::Dataproc::V1::Cluster, Google::Cloud::Dataproc::V1::ClusterOperationMetadata, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |