Class: Google::Apis::ServiceconsumermanagementV1beta1::ServiceConsumerManagementService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::ServiceconsumermanagementV1beta1::ServiceConsumerManagementService
- Defined in:
- lib/google/apis/serviceconsumermanagement_v1beta1/service.rb
Overview
Service Consumer Management API
Manages the service consumers of a Service Infrastructure service.
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"https://serviceconsumermanagement.$UNIVERSE_DOMAIN$/"
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#initialize ⇒ ServiceConsumerManagementService
constructor
A new instance of ServiceConsumerManagementService.
-
#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.
-
#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.
-
#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.
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.
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.
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.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 278 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', ) 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 |
#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.
327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 327 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}', ) 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 |
#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.
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}', ) 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.
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}', ) 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.
225 226 227 228 229 230 231 232 233 234 |
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 225 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}', ) 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.
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', ) 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 |
#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.
367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 367 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', ) 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_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.
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 187 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', ) 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.
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 |
# File 'lib/google/apis/serviceconsumermanagement_v1beta1/service.rb', line 417 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}', ) 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 |