Class: Google::Cloud::ServiceControl::V1::QuotaController::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/service_control/v1/quota_controller/client.rb

Overview

Client for the QuotaController service.

Google Quota Control API

Allows clients to allocate and release quota against a managed service.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new QuotaController client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the QuotaController client.

Yield Parameters:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/cloud/service_control/v1/quota_controller/client.rb', line 122

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/servicecontrol/v1/quota_controller_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_controller_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::ServiceControl::V1::QuotaController::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
  )
end

Class Method Details

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

Configure the QuotaController Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all QuotaController clients
::Google::Cloud::ServiceControl::V1::QuotaController::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/google/cloud/service_control/v1/quota_controller/client.rb', line 60

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "ServiceControl", "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
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#allocate_quota(request, options = nil) ⇒ ::Google::Cloud::ServiceControl::V1::AllocateQuotaResponse #allocate_quota(service_name: nil, allocate_operation: nil, service_config_id: nil) ⇒ ::Google::Cloud::ServiceControl::V1::AllocateQuotaResponse

Attempts to allocate quota for the specified consumer. It should be called before the operation is executed.

This method requires the servicemanagement.services.quota permission on the specified service. For more information, see Cloud IAM.

NOTE: The client must fail-open on server errors INTERNAL, UNKNOWN, DEADLINE_EXCEEDED, and UNAVAILABLE. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality.

Examples:

Basic example

require "google/cloud/service_control/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ServiceControl::V1::QuotaController::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ServiceControl::V1::AllocateQuotaRequest.new

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

# The returned object is of type Google::Cloud::ServiceControl::V1::AllocateQuotaResponse.
p result

Overloads:

  • #allocate_quota(request, options = nil) ⇒ ::Google::Cloud::ServiceControl::V1::AllocateQuotaResponse

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

    Parameters:

    • request (::Google::Cloud::ServiceControl::V1::AllocateQuotaRequest, ::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.

  • #allocate_quota(service_name: nil, allocate_operation: nil, service_config_id: nil) ⇒ ::Google::Cloud::ServiceControl::V1::AllocateQuotaResponse

    Pass arguments to allocate_quota 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:

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

      Name of the service as specified in the service configuration. For example, "pubsub.googleapis.com".

      See [google.api.Service][google.api.Service] for the definition of a service name.

    • allocate_operation (::Google::Cloud::ServiceControl::V1::QuotaOperation, ::Hash) (defaults to: nil) —

      Operation that describes the quota allocation.

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

      Specifies which version of service configuration should be used to process the request. If unspecified or no matching version can be found, the latest one will be used.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
261
262
263
264
265
266
 
# File 'lib/google/cloud/service_control/v1/quota_controller/client.rb', line 227

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ServiceControl::V1::AllocateQuotaRequest

  # 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.allocate_quota.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::ServiceControl::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.service_name
    header_params["service_name"] = request.service_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.allocate_quota.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.allocate_quota.retry_policy

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

  @quota_controller_stub.call_rpc :allocate_quota, 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

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

Configure the QuotaController 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:



92
93
94
95
 
# File 'lib/google/cloud/service_control/v1/quota_controller/client.rb', line 92

def configure
  yield @config if block_given?
  @config
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


102
103
104
 
# File 'lib/google/cloud/service_control/v1/quota_controller/client.rb', line 102

def universe_domain
  @quota_controller_stub.universe_domain
end