Cloud Quotas V1BETA API - Class Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client (v0.1.0)

Reference documentation and code samples for the Cloud Quotas V1BETA API class Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client.

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.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the QuotaAdjusterSettingsManager Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all QuotaAdjusterSettingsManager clients
::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettingsManager::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#get_quota_adjuster_settings

def get_quota_adjuster_settings(request, options = nil) -> ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings
def get_quota_adjuster_settings(name: nil) -> ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings

RPC Method for getting QuotaAdjusterSettings based on the request

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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).
Parameter
  • name (::String) — Required. Name of the config. Required to be “settings”, as only a single setting per container will be supported initially.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

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

#initialize

def initialize() { |config| ... } -> Client

Create a new QuotaAdjusterSettingsManager client object.

Yields
  • (config) — Configure the QuotaAdjusterSettingsManager client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# 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

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_quota_adjuster_settings

def update_quota_adjuster_settings(request, options = nil) -> ::Google::Cloud::CloudQuotas::V1beta::QuotaAdjusterSettings
def 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

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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) — Required. The QuotaAdjusterSettings to update.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update.
  • validate_only (::Boolean) — Optional. If set to true, validate the request, but do not actually update. Note that a request being valid does not mean that the request is guaranteed to 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.
Example

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