Class: Google::Apis::ServiceconsumermanagementV1beta1::ServiceConsumerManagementService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/serviceconsumermanagement_v1beta1/service.rb

Overview

Service Consumer Management API

Manages the service consumers of a Service Infrastructure service.

Examples:

require 'google/apis/serviceconsumermanagement_v1beta1'

Serviceconsumermanagement = Google::Apis::ServiceconsumermanagementV1beta1 # Alias the module
service = Serviceconsumermanagement::ServiceConsumerManagementService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://serviceconsumermanagement.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ServiceConsumerManagementService

Returns a new instance of ServiceConsumerManagementService.



47
48
49
50
51
52
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-serviceconsumermanagement_v1beta1',
        client_version: Google::Apis::ServiceconsumermanagementV1beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#create_service_consumer_quota_metric_limit_producer_override(parent, v1_beta1_quota_override_object = nil, force: nil, force_justification: nil, force_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Creates a producer override. A producer override is applied by the owner or administrator of a service to increase or decrease the amount of quota a consumer of the service is allowed to use. To create multiple overrides at once, use ImportProducerOverrides instead. If an override with the specified dimensions already exists, this call will fail. To overwrite an existing override if one is already present ("upsert" semantics), use ImportProducerOverrides instead.

Parameters:

  • parent (String) —

    The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

  • v1_beta1_quota_override_object (Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride) (defaults to: nil)
  • force (Boolean) (defaults to: nil) —

    Whether to force the creation of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.

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

    If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.

  • force_only (Array<String>, String) (defaults to: nil) —

    The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 314

def create_service_consumer_quota_metric_limit_producer_override(parent, v1_beta1_quota_override_object = nil, force: nil, force_justification: nil, force_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/producerOverrides', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation
  command.request_object = v1_beta1_quota_override_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['force'] = force unless force.nil?
  command.query['forceJustification'] = force_justification unless force_justification.nil?
  command.query['forceOnly'] = force_only unless force_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_service_consumer_quota_metric_limit_producer_quota_policy(parent, v1_beta1_producer_quota_policy_object = nil, force: nil, force_justification: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Creates a producer quota policy. A producer quota policy is applied by the owner or administrator of a service at an org or folder node to set the default quota limit for all consumers under the node where the policy is created. To create multiple policies at once, use ImportProducerQuotaPolicies instead. If a policy with the specified dimensions already exists, this call will fail. To overwrite an existing policy if one is already present ("upsert" semantics), use ImportProducerQuotaPolicies instead.

Parameters:

  • parent (String) —

    Required. The resource name of the parent quota limit. An example name would be: services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/ compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

  • v1_beta1_producer_quota_policy_object (Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ProducerQuotaPolicy) (defaults to: nil)
  • force (Boolean) (defaults to: nil) —

    Whether to force the creation of the quota policy. If the policy creation would decrease the default limit of any consumer tier by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.

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

    If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.

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

    If set to true, validate the request, but do not actually update.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 509

def create_service_consumer_quota_metric_limit_producer_quota_policy(parent, v1_beta1_producer_quota_policy_object = nil, force: nil, force_justification: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/producerQuotaPolicies', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ProducerQuotaPolicy::Representation
  command.request_object = v1_beta1_producer_quota_policy_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['force'] = force unless force.nil?
  command.query['forceJustification'] = force_justification unless force_justification.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_service_consumer_quota_metric_limit_producer_override(name, force: nil, force_justification: nil, force_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Deletes a producer override.

Parameters:

  • name (String) —

    The resource name of the override to delete. An example name would be: services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d

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

    Whether to force the deletion of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.

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

    If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.

  • force_only (Array<String>, String) (defaults to: nil) —

    The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 363

def delete_service_consumer_quota_metric_limit_producer_override(name, force: nil, force_justification: nil, force_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['forceJustification'] = force_justification unless force_justification.nil?
  command.query['forceOnly'] = force_only unless force_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_service_consumer_quota_metric_limit_producer_quota_policy(name, force: nil, force_justification: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Deletes a producer quota policy.

Parameters:

  • name (String) —

    Required. The resource name of the policy to delete. An example name would be: services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/ compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/ 4a3f2c1d

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

    Whether to force the deletion of the quota policy. If the policy deletion would decrease the default limit of any consumer tier by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.

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

    If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.

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

    If set to true, validate the request, but do not actually update.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 558

def delete_service_consumer_quota_metric_limit_producer_quota_policy(name, force: nil, force_justification: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['forceJustification'] = force_justification unless force_justification.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



75
76
77
78
79
80
81
82
83
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 75

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_service_consumer_quota_metric(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric

Retrieves a summary of quota information for a specific quota metric.

Parameters:

  • name (String) —

    The resource name of the quota metric, returned by a ListConsumerQuotaMetrics call. An example name would be: services/compute.googleapis.com/projects/123/ consumerQuotaMetrics/compute.googleapis.com%2Fcpus

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

    Specifies the level of detail for quota information in the response.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 109

def get_service_consumer_quota_metric(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_service_consumer_quota_metric_limit(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit

Retrieves a summary of quota information for a specific quota limit.

Parameters:

  • name (String) —

    The resource name of the quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: services/compute. googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/ limits/%2Fproject%2Fregion

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

    Specifies the level of detail for quota information in the response.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 261

def get_service_consumer_quota_metric_limit(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_service_consumer_quota_metric_producer_overrides(parent, v1_beta1_import_producer_overrides_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Create or update multiple producer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.

Parameters:

  • parent (String) —

    The resource name of the consumer. An example name would be: services/compute. googleapis.com/projects/123

  • v1_beta1_import_producer_overrides_request_object (Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerOverridesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 144

def import_service_consumer_quota_metric_producer_overrides(parent, v1_beta1_import_producer_overrides_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/consumerQuotaMetrics:importProducerOverrides', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerOverridesRequest::Representation
  command.request_object = v1_beta1_import_producer_overrides_request_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_service_consumer_quota_metric_producer_quota_policies(parent, v1_beta1_import_producer_quota_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Create or update multiple producer quota policies atomically, all on the same ancestor, but on many different metrics or limits. The name field in the quota policy message should not be set.

Parameters:

  • parent (String) —

    The resource name of the consumer. An example name would be: services/compute. googleapis.com/organizations/123

  • v1_beta1_import_producer_quota_policies_request_object (Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerQuotaPoliciesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 180

def import_service_consumer_quota_metric_producer_quota_policies(parent, v1_beta1_import_producer_quota_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/consumerQuotaMetrics:importProducerQuotaPolicies', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerQuotaPoliciesRequest::Representation
  command.request_object = v1_beta1_import_producer_quota_policies_request_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_service_consumer_quota_metric_limit_producer_overrides(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerOverridesResponse

Lists all producer overrides on this limit.

Parameters:

  • parent (String) —

    The resource name of the parent quota limit, returned by a ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would be: services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

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

    Requested size of the next page of data.

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

    Token identifying which result to start with; returned by a previous list call.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 403

def list_service_consumer_quota_metric_limit_producer_overrides(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/producerOverrides', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerOverridesResponse::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerOverridesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_service_consumer_quota_metric_limit_producer_quota_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerQuotaPoliciesResponse

Lists all producer policies created at current consumer node for a limit.

Parameters:

  • parent (String) —

    Required. The resource name of the parent quota limit. An example name would be: services/compute.googleapis.com/organizations/123/consumerQuotaMetrics/ compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

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

    Requested size of the next page of data.

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

    Token identifying which result to start with; returned by a previous list call.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 597

def list_service_consumer_quota_metric_limit_producer_quota_policies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/producerQuotaPolicies', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerQuotaPoliciesResponse::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerQuotaPoliciesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_service_consumer_quota_metrics(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListConsumerQuotaMetricsResponse

Retrieves a summary of all quota information about this consumer that is visible to the service producer, for each quota metric defined by the service. Each metric includes information about all of its defined limits. Each limit includes the limit configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.

Parameters:

  • parent (String) —

    Parent of the quotas resource. An example parent would be: services/ serviceconsumermanagement.googleapis.com/projects/123

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

    Requested size of the next page of data.

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

    Token identifying which result to start with; returned by a previous list call.

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

    Specifies the level of detail for quota information in the response.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 223

def list_service_consumer_quota_metrics(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/consumerQuotaMetrics', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListConsumerQuotaMetricsResponse::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListConsumerQuotaMetricsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_service_consumer_quota_metric_limit_producer_override(name, v1_beta1_quota_override_object = nil, force: nil, force_justification: nil, force_only: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Updates a producer override.

Parameters:

  • name (String) —

    The resource name of the override to update. An example name would be: services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d

  • v1_beta1_quota_override_object (Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride) (defaults to: nil)
  • force (Boolean) (defaults to: nil) —

    Whether to force the update of the quota override. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.

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

    If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.

  • force_only (Array<String>, String) (defaults to: nil) —

    The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.

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

    Update only the specified fields. If unset, all modifiable fields will be updated.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 453

def patch_service_consumer_quota_metric_limit_producer_override(name, v1_beta1_quota_override_object = nil, force: nil, force_justification: nil, force_only: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation
  command.request_object = v1_beta1_quota_override_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['forceJustification'] = force_justification unless force_justification.nil?
  command.query['forceOnly'] = force_only unless force_only.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_service_consumer_quota_metric_limit_producer_quota_policy(name, v1_beta1_producer_quota_policy_object = nil, force: nil, force_justification: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1beta1::Operation

Updates a producer quota policy.

Parameters:

  • name (String) —

    The resource name of the producer policy. An example name would be: services/ compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute. googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/ 4a3f2c1d

  • v1_beta1_producer_quota_policy_object (Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ProducerQuotaPolicy) (defaults to: nil)
  • force (Boolean) (defaults to: nil) —

    Whether to force the update of the quota policy. If the policy update would decrease the default limit of any consumer tier by more than 10 percent, the call is rejected, as a safety measure to avoid accidentally decreasing quota too quickly. Setting the force parameter to true ignores this restriction.

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

    If force option is set to true, force_justification is suggested to be set to log the reason in audit logs.

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

    Update only the specified fields. If unset, all modifiable fields will be updated.

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

    If set to true, validate the request, but do not actually update.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 646

def patch_service_consumer_quota_metric_limit_producer_quota_policy(name, v1_beta1_producer_quota_policy_object = nil, force: nil, force_justification: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ProducerQuotaPolicy::Representation
  command.request_object = v1_beta1_producer_quota_policy_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['forceJustification'] = force_justification unless force_justification.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end