Class: Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb
Overview
Client for the AutoscalingPolicyService service.
The API interface for managing autoscaling policies in the Dataproc API.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the AutoscalingPolicyService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the AutoscalingPolicyService Client instance.
-
#create_autoscaling_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy
Creates new autoscaling policy.
-
#delete_autoscaling_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an autoscaling policy.
-
#get_autoscaling_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy
Retrieves autoscaling policy.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new AutoscalingPolicyService client object.
-
#list_autoscaling_policies(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataproc::V1::AutoscalingPolicy>
Lists autoscaling policies in the project.
-
#update_autoscaling_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy
Updates (replaces) autoscaling policy.
Methods included from Paths
#autoscaling_policy_path, #location_path, #region_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new AutoscalingPolicyService client object.
Examples
To create a new AutoscalingPolicyService client with the default configuration:
client = ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Client.new
To create a new AutoscalingPolicyService client with a custom configuration:
client = ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Client.new do |config|
config.timeout = 10.0
end
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 |
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb', line 143 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/autoscaling_policies_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 scope and endpoint are unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.scope == Client.configure.scope && @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 @autoscaling_policy_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the AutoscalingPolicyService Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all AutoscalingPolicyService clients:
::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Client.configure do |config|
config.timeout = 10.0
end
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb', line 58 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_autoscaling_policy.timeout = 600.0 default_config.rpcs.update_autoscaling_policy.timeout = 600.0 default_config.rpcs.update_autoscaling_policy.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.get_autoscaling_policy.timeout = 600.0 default_config.rpcs.get_autoscaling_policy.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.list_autoscaling_policies.timeout = 600.0 default_config.rpcs.list_autoscaling_policies.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.delete_autoscaling_policy.timeout = 600.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the AutoscalingPolicyService 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 configure.
See Configuration for a description of the configuration fields.
118 119 120 121 |
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb', line 118 def configure yield @config if block_given? @config end |
#create_autoscaling_policy(request, options = nil) ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy #create_autoscaling_policy(parent: nil, policy: nil) ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy
Creates new autoscaling policy.
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb', line 222 def create_autoscaling_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::CreateAutoscalingPolicyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_autoscaling_policy..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_autoscaling_policy.timeout, metadata: , retry_policy: @config.rpcs.create_autoscaling_policy.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @autoscaling_policy_service_stub.call_rpc :create_autoscaling_policy, request, 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 |
#delete_autoscaling_policy(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_autoscaling_policy(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 |
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb', line 524 def delete_autoscaling_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::DeleteAutoscalingPolicyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_autoscaling_policy..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_autoscaling_policy.timeout, metadata: , retry_policy: @config.rpcs.delete_autoscaling_policy.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @autoscaling_policy_service_stub.call_rpc :delete_autoscaling_policy, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_autoscaling_policy(request, options = nil) ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy #get_autoscaling_policy(name: nil) ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy
Retrieves autoscaling policy.
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb', line 366 def get_autoscaling_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::GetAutoscalingPolicyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_autoscaling_policy..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_autoscaling_policy.timeout, metadata: , retry_policy: @config.rpcs.get_autoscaling_policy.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @autoscaling_policy_service_stub.call_rpc :get_autoscaling_policy, request, 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_autoscaling_policies(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataproc::V1::AutoscalingPolicy> #list_autoscaling_policies(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataproc::V1::AutoscalingPolicy>
Lists autoscaling policies in the project.
447 448 449 450 451 452 453 454 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/autoscaling_policy_service/client.rb', line 447 def list_autoscaling_policies request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::ListAutoscalingPoliciesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_autoscaling_policies..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_autoscaling_policies.timeout, metadata: , retry_policy: @config.rpcs.list_autoscaling_policies.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @autoscaling_policy_service_stub.call_rpc :list_autoscaling_policies, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @autoscaling_policy_service_stub, :list_autoscaling_policies, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#update_autoscaling_policy(request, options = nil) ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy #update_autoscaling_policy(policy: nil) ⇒ ::Google::Cloud::Dataproc::V1::AutoscalingPolicy
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb', line 291 def update_autoscaling_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::UpdateAutoscalingPolicyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_autoscaling_policy..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "policy.name" => request.policy.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_autoscaling_policy.timeout, metadata: , retry_policy: @config.rpcs.update_autoscaling_policy.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @autoscaling_policy_service_stub.call_rpc :update_autoscaling_policy, request, 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 |