class Google::Cloud::Dataproc::V1::AutoscalingPolicyService::Client

Client for the AutoscalingPolicyService service.

The API interface for managing autoscaling policies in the Dataproc API.

Attributes

autoscaling_policy_service_stub[R]

@private

Public Class Methods

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

Configure the AutoscalingPolicyService Client class.

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

@example

# Modify the configuration for all AutoscalingPolicyService clients
::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::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/autoscaling_policy_service/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_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
new() { |config| ... } click to toggle source

Create a new AutoscalingPolicyService client object.

@example

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

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

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

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

  @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

Public Instance Methods

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

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 {Client.configure}.

See {::Google::Cloud::Dataproc::V1::AutoscalingPolicyService::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/autoscaling_policy_service/client.rb, line 108
def configure
  yield @config if block_given?
  @config
end
create_autoscaling_policy(request, options = nil) { |response, operation| ... } click to toggle source

Creates new autoscaling policy.

@overload create_autoscaling_policy(request, options = nil)

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

@param request [::Google::Cloud::Dataproc::V1::CreateAutoscalingPolicyRequest, ::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_autoscaling_policy(parent: nil, policy: nil)

Pass arguments to `create_autoscaling_policy` 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 parent [::String]
  Required. The "resource name" of the region or location, as described
  in https://cloud.google.com/apis/design/resource_names.

  * For `projects.regions.autoscalingPolicies.create`, the resource name
    of the region has the following format:
    `projects/{project_id}/regions/{region}`

  * For `projects.locations.autoscalingPolicies.create`, the resource name
    of the location has the following format:
    `projects/{project_id}/locations/{location}`
@param policy [::Google::Cloud::Dataproc::V1::AutoscalingPolicy, ::Hash]
  Required. The autoscaling policy to create.

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

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

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

# File lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb, line 207
def create_autoscaling_policy request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_autoscaling_policy.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 = {
    "parent" => request.parent
  }
  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_autoscaling_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_autoscaling_policy.retry_policy

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

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

Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.

@overload delete_autoscaling_policy(request, options = nil)

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

@param request [::Google::Cloud::Dataproc::V1::DeleteAutoscalingPolicyRequest, ::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_autoscaling_policy(name: nil)

Pass arguments to `delete_autoscaling_policy` 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 name [::String]
  Required. The "resource name" of the autoscaling policy, as described
  in https://cloud.google.com/apis/design/resource_names.

  * For `projects.regions.autoscalingPolicies.delete`, the resource name
    of the policy has the following format:
    `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`

  * For `projects.locations.autoscalingPolicies.delete`, the resource name
    of the policy has the following format:
    `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

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

# File lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb, line 517
def delete_autoscaling_policy request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_autoscaling_policy.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 = {
    "name" => request.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_autoscaling_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_autoscaling_policy.retry_policy

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

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

Retrieves autoscaling policy.

@overload get_autoscaling_policy(request, options = nil)

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

@param request [::Google::Cloud::Dataproc::V1::GetAutoscalingPolicyRequest, ::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_autoscaling_policy(name: nil)

Pass arguments to `get_autoscaling_policy` 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 name [::String]
  Required. The "resource name" of the autoscaling policy, as described
  in https://cloud.google.com/apis/design/resource_names.

  * For `projects.regions.autoscalingPolicies.get`, the resource name
    of the policy has the following format:
    `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}`

  * For `projects.locations.autoscalingPolicies.get`, the resource name
    of the policy has the following format:
    `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`

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

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

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

# File lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb, line 355
def get_autoscaling_policy request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_autoscaling_policy.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 = {
    "name" => request.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_autoscaling_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_autoscaling_policy.retry_policy

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

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

Lists autoscaling policies in the project.

@overload list_autoscaling_policies(request, options = nil)

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

@param request [::Google::Cloud::Dataproc::V1::ListAutoscalingPoliciesRequest, ::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_autoscaling_policies(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_autoscaling_policies` 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 parent [::String]
  Required. The "resource name" of the region or location, as described
  in https://cloud.google.com/apis/design/resource_names.

  * For `projects.regions.autoscalingPolicies.list`, the resource name
    of the region has the following format:
    `projects/{project_id}/regions/{region}`

  * For `projects.locations.autoscalingPolicies.list`, the resource name
    of the location has the following format:
    `projects/{project_id}/locations/{location}`
@param page_size [::Integer]
  Optional. The maximum number of results to return in each response.
  Must be less than or equal to 1000. Defaults to 100.
@param page_token [::String]
  Optional. The page token, returned by a previous call, to request the
  next page of results.

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

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

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

# File lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb, line 438
def list_autoscaling_policies request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_autoscaling_policies.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 = {
    "parent" => request.parent
  }
  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_autoscaling_policies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_autoscaling_policies.retry_policy

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

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

Updates (replaces) autoscaling policy.

Disabled check for update_mask, because all updates will be full replacements.

@overload update_autoscaling_policy(request, options = nil)

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

@param request [::Google::Cloud::Dataproc::V1::UpdateAutoscalingPolicyRequest, ::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_autoscaling_policy(policy: nil)

Pass arguments to `update_autoscaling_policy` 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 policy [::Google::Cloud::Dataproc::V1::AutoscalingPolicy, ::Hash]
  Required. The updated autoscaling policy.

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

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

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

# File lib/google/cloud/dataproc/v1/autoscaling_policy_service/client.rb, line 278
def update_autoscaling_policy request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_autoscaling_policy.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 = {
    "policy.name" => request.policy.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_autoscaling_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_autoscaling_policy.retry_policy

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

  @autoscaling_policy_service_stub.call_rpc :update_autoscaling_policy, 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