Class: Google::Cloud::Dataproc::V1::AutoscalingPolicyServiceClient

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

Overview

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

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

Class Method Summary collapse

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: "") ⇒ AutoscalingPolicyServiceClient

Returns a new instance of AutoscalingPolicyServiceClient.

Parameters:

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

    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>) (defaults to: ALL_SCOPES) —

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

  • client_config (Hash) (defaults to: {}) —

    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) (defaults to: DEFAULT_TIMEOUT) —

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

  • metadata (Hash) (defaults to: nil) —

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

  • service_address (String) (defaults to: nil) —

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil) —

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

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



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
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
258
259
260
 
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb', line 141

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/autoscaling_policies_services_pb"

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

  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 }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "autoscaling_policy_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.dataproc.v1.AutoscalingPolicyService",
      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
  @autoscaling_policy_service_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::AutoscalingPolicyService::Stub.method(:new)
  )

  @create_autoscaling_policy = Google::Gax.create_api_call(
    @autoscaling_policy_service_stub.method(:create_autoscaling_policy),
    defaults["create_autoscaling_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_autoscaling_policy = Google::Gax.create_api_call(
    @autoscaling_policy_service_stub.method(:update_autoscaling_policy),
    defaults["update_autoscaling_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'policy.name' => request.policy.name}
    end
  )
  @get_autoscaling_policy = Google::Gax.create_api_call(
    @autoscaling_policy_service_stub.method(:get_autoscaling_policy),
    defaults["get_autoscaling_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_autoscaling_policies = Google::Gax.create_api_call(
    @autoscaling_policy_service_stub.method(:list_autoscaling_policies),
    defaults["list_autoscaling_policies"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @delete_autoscaling_policy = Google::Gax.create_api_call(
    @autoscaling_policy_service_stub.method(:delete_autoscaling_policy),
    defaults["delete_autoscaling_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
end

Class Method Details

.autoscaling_policy_path(project, region, autoscaling_policy) ⇒ String

Returns a fully-qualified autoscaling_policy resource name string.

Parameters:

  • project (String)
  • region (String)
  • autoscaling_policy (String)

Returns:

  • (String) 


89
90
91
92
93
94
95
 
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb', line 89

def self.autoscaling_policy_path project, region, autoscaling_policy
  AUTOSCALING_POLICY_PATH_TEMPLATE.render(
    :"project" => project,
    :"region" => region,
    :"autoscaling_policy" => autoscaling_policy
  )
end

.region_path(project, region) ⇒ String

Returns a fully-qualified region resource name string.

Parameters:

  • project (String)
  • region (String)

Returns:

  • (String) 


101
102
103
104
105
106
 
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb', line 101

def self.region_path project, region
  REGION_PATH_TEMPLATE.render(
    :"project" => project,
    :"region" => region
  )
end

Instance Method Details

#create_autoscaling_policy(parent, policy, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::AutoscalingPolicy

Creates new autoscaling policy.

Examples:

require "google/cloud/dataproc"

autoscaling_policy_client = Google::Cloud::Dataproc::AutoscalingPolicyService.new(version: :v1)
formatted_parent = Google::Cloud::Dataproc::V1::AutoscalingPolicyServiceClient.region_path("[PROJECT]", "[REGION]")

# TODO: Initialize `policy`:
policy = {}
response = autoscaling_policy_client.create_autoscaling_policy(formatted_parent, policy)

Parameters:

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

  • policy (Google::Cloud::Dataproc::V1::AutoscalingPolicy | Hash) —

    The autoscaling policy to create. A hash of the same form as Google::Cloud::Dataproc::V1::AutoscalingPolicy can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb', line 299

def create_autoscaling_policy \
    parent,
    policy,
    options: nil,
    &block
  req = {
    parent: parent,
    policy: policy
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::CreateAutoscalingPolicyRequest)
  @create_autoscaling_policy.call(req, options, &block)
end

#delete_autoscaling_policy(name, options: nil) {|result, operation| ... } ⇒ Object

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

Examples:

require "google/cloud/dataproc"

autoscaling_policy_client = Google::Cloud::Dataproc::AutoscalingPolicyService.new(version: :v1)
formatted_name = Google::Cloud::Dataproc::V1::AutoscalingPolicyServiceClient.autoscaling_policy_path("[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
autoscaling_policy_client.delete_autoscaling_policy(formatted_name)

Parameters:

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb', line 479

def delete_autoscaling_policy \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::DeleteAutoscalingPolicyRequest)
  @delete_autoscaling_policy.call(req, options, &block)
  nil
end

#get_autoscaling_policy(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::AutoscalingPolicy

Retrieves autoscaling policy.

Examples:

require "google/cloud/dataproc"

autoscaling_policy_client = Google::Cloud::Dataproc::AutoscalingPolicyService.new(version: :v1)
formatted_name = Google::Cloud::Dataproc::V1::AutoscalingPolicyServiceClient.autoscaling_policy_path("[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
response = autoscaling_policy_client.get_autoscaling_policy(formatted_name)

Parameters:

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



377
378
379
380
381
382
383
384
385
386
 
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb', line 377

def get_autoscaling_policy \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::GetAutoscalingPolicyRequest)
  @get_autoscaling_policy.call(req, options, &block)
end

#list_autoscaling_policies(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dataproc::V1::AutoscalingPolicy>

Lists autoscaling policies in the project.

Examples:

require "google/cloud/dataproc"

autoscaling_policy_client = Google::Cloud::Dataproc::AutoscalingPolicyService.new(version: :v1)
formatted_parent = Google::Cloud::Dataproc::V1::AutoscalingPolicyServiceClient.region_path("[PROJECT]", "[REGION]")

# Iterate over all results.
autoscaling_policy_client.list_autoscaling_policies(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
autoscaling_policy_client.list_autoscaling_policies(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

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

  • page_size (Integer) (defaults to: nil) —

    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) (defaults to: nil) —

    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::AutoscalingPolicy>) —

    An enumerable of Google::Cloud::Dataproc::V1::AutoscalingPolicy 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.



438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb', line 438

def list_autoscaling_policies \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::ListAutoscalingPoliciesRequest)
  @list_autoscaling_policies.call(req, options, &block)
end

#update_autoscaling_policy(policy, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::AutoscalingPolicy

Updates (replaces) autoscaling policy.

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

Examples:

require "google/cloud/dataproc"

autoscaling_policy_client = Google::Cloud::Dataproc::AutoscalingPolicyService.new(version: :v1)

# TODO: Initialize `policy`:
policy = {}
response = autoscaling_policy_client.update_autoscaling_policy(policy)

Parameters:

  • policy (Google::Cloud::Dataproc::V1::AutoscalingPolicy | Hash) —

    Required. The updated autoscaling policy. A hash of the same form as Google::Cloud::Dataproc::V1::AutoscalingPolicy can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



338
339
340
341
342
343
344
345
346
347
 
# File 'lib/google/cloud/dataproc/v1/autoscaling_policy_service_client.rb', line 338

def update_autoscaling_policy \
    policy,
    options: nil,
    &block
  req = {
    policy: policy
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::UpdateAutoscalingPolicyRequest)
  @update_autoscaling_policy.call(req, options, &block)
end