Class: Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/cloud_quotas/v1beta/quota_adjuster_settings_manager/client.rb

Overview

Client for the QuotaAdjusterSettingsManager service.

The Quotas Adjuster Settings API is an infrastructure service for Google Cloud that lets service consumers view and update their quota adjuster settings.

  • Update quota adjuster settings.
  • Get the name of the configurations.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#quota_adjuster_settings_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new QuotaAdjusterSettingsManager client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the QuotaAdjusterSettingsManager client.

Yield Parameters:



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
 
# File 'lib/google/cloud/cloud_quotas/v1beta/quota_adjuster_settings_manager/client.rb', line 139

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/api/cloudquotas/v1beta/quota_adjuster_settings_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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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

  @quota_adjuster_settings_manager_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @quota_adjuster_settings_manager_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the QuotaAdjusterSettingsManager Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all QuotaAdjusterSettingsManager clients
::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
 
# File 'lib/google/cloud/cloud_quotas/v1beta/quota_adjuster_settings_manager/client.rb', line 67

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "CloudQuotas", "V1beta"]
    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.update_quota_adjuster_settings.timeout = 60.0
    default_config.rpcs.update_quota_adjuster_settings.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_quota_adjuster_settings.timeout = 60.0
    default_config.rpcs.get_quota_adjuster_settings.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the QuotaAdjusterSettingsManager 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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



109
110
111
112
 
# File 'lib/google/cloud/cloud_quotas/v1beta/quota_adjuster_settings_manager/client.rb', line 109

def configure
  yield @config if block_given?
  @config
end

#get_quota_adjuster_settings(request, options = nil) ⇒ ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings #get_quota_adjuster_settings(name: nil) ⇒ ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings

RPC Method for getting QuotaAdjusterSettings based on the request

Examples:

Basic example

require "google/cloud/cloud_quotas/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudQuotas::V1beta::GetQuotaAdjusterSettingsRequest.new

# Call the get_quota_adjuster_settings method.
result = client.get_quota_adjuster_settings request

# The returned object is of type Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings.
p result

Overloads:

  • #get_quota_adjuster_settings(request, options = nil) ⇒ ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings

    Pass arguments to get_quota_adjuster_settings via a request object, either of type GetQuotaAdjusterSettingsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CloudQuotas::V1beta::GetQuotaAdjusterSettingsRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_quota_adjuster_settings(name: nil) ⇒ ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings

    Pass arguments to get_quota_adjuster_settings 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).

    Parameters:

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

      Required. Name of the quotaAdjusterSettings configuration. Only a single setting per project is supported.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/google/cloud/cloud_quotas/v1beta/quota_adjuster_settings_manager/client.rb', line 337

def get_quota_adjuster_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudQuotas::V1beta::GetQuotaAdjusterSettingsRequest

  # 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_quota_adjuster_settings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CloudQuotas::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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_quota_adjuster_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_quota_adjuster_settings.retry_policy

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

  @quota_adjuster_settings_manager_stub.call_rpc :get_quota_adjuster_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


195
196
197
 
# File 'lib/google/cloud/cloud_quotas/v1beta/quota_adjuster_settings_manager/client.rb', line 195

def logger
  @quota_adjuster_settings_manager_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


119
120
121
 
# File 'lib/google/cloud/cloud_quotas/v1beta/quota_adjuster_settings_manager/client.rb', line 119

def universe_domain
  @quota_adjuster_settings_manager_stub.universe_domain
end

#update_quota_adjuster_settings(request, options = nil) ⇒ ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings #update_quota_adjuster_settings(quota_adjuster_settings: nil, update_mask: nil, validate_only: nil) ⇒ ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings

RPC Method for updating QuotaAdjusterSettings based on the request

Examples:

Basic example

require "google/cloud/cloud_quotas/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CloudQuotas::V1beta::UpdateQuotaAdjusterSettingsRequest.new

# Call the update_quota_adjuster_settings method.
result = client.update_quota_adjuster_settings request

# The returned object is of type Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings.
p result

Overloads:

  • #update_quota_adjuster_settings(request, options = nil) ⇒ ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings

    Pass arguments to update_quota_adjuster_settings via a request object, either of type UpdateQuotaAdjusterSettingsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CloudQuotas::V1beta::UpdateQuotaAdjusterSettingsRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_quota_adjuster_settings(quota_adjuster_settings: nil, update_mask: nil, validate_only: nil) ⇒ ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings

    Pass arguments to update_quota_adjuster_settings 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).

    Parameters:

    • quota_adjuster_settings (::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings, ::Hash) (defaults to: nil) —

      Required. The QuotaAdjusterSettings to update.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. The list of fields to update.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, checks the syntax of the request but doesn't update the quota adjuster settings value. Note that although a request can be valid, that doesn't guarantee that the request will be fulfilled.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/google/cloud/cloud_quotas/v1beta/quota_adjuster_settings_manager/client.rb', line 251

def update_quota_adjuster_settings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudQuotas::V1beta::UpdateQuotaAdjusterSettingsRequest

  # 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_quota_adjuster_settings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::CloudQuotas::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.quota_adjuster_settings&.name
    header_params["quota_adjuster_settings.name"] = request.quota_adjuster_settings.name
  end

  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_quota_adjuster_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_quota_adjuster_settings.retry_policy

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

  @quota_adjuster_settings_manager_stub.call_rpc :update_quota_adjuster_settings, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end