Class: Google::Cloud::ServiceControl::V1::QuotaOperation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/servicecontrol/v1/quota_controller.rb

Overview

Represents information regarding a quota operation.

Defined Under Namespace

Modules: QuotaMode Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_id ⇒ ::String

Returns Identity of the consumer for whom this quota operation is being performed.

This can be in one of the following formats: project:, project_number:, api_key:.

Returns:

  • (::String) —

    Identity of the consumer for whom this quota operation is being performed.

    This can be in one of the following formats: project:, project_number:, api_key:.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 97

class QuotaOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Supported quota modes.
  module QuotaMode
    # Guard against implicit default. Must not be used.
    UNSPECIFIED = 0

    # For AllocateQuota request, allocates quota for the amount specified in
    # the service configuration or specified using the quota metrics. If the
    # amount is higher than the available quota, allocation error will be
    # returned and no quota will be allocated.
    # If multiple quotas are part of the request, and one fails, none of the
    # quotas are allocated or released.
    NORMAL = 1

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the amount is
    # higher than the available quota, request does not fail but all available
    # quota will be allocated.
    # For rate quota, BEST_EFFORT will continue to deduct from other groups
    # even if one does not have enough quota. For allocation, it will find the
    # minimum available amount across all groups and deduct that amount from
    # all the affected groups.
    BEST_EFFORT = 2

    # For AllocateQuota request, only checks if there is enough quota
    # available and does not change the available quota. No lock is placed on
    # the available quota either.
    CHECK_ONLY = 3

    # Unimplemented. When used in AllocateQuotaRequest, this returns the
    # effective quota limit(s) in the response, and no quota check will be
    # performed. Not supported for other requests, and even for
    # AllocateQuotaRequest, this is currently supported only for allowlisted
    # services.
    QUERY_ONLY = 4

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the requested
    # amount is higher than the available quota, request does not fail and
    # remaining quota would become negative (going over the limit).
    # Not supported for Rate Quota.
    ADJUST_ONLY = 5
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels describing the operation.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels describing the operation.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 97

class QuotaOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Supported quota modes.
  module QuotaMode
    # Guard against implicit default. Must not be used.
    UNSPECIFIED = 0

    # For AllocateQuota request, allocates quota for the amount specified in
    # the service configuration or specified using the quota metrics. If the
    # amount is higher than the available quota, allocation error will be
    # returned and no quota will be allocated.
    # If multiple quotas are part of the request, and one fails, none of the
    # quotas are allocated or released.
    NORMAL = 1

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the amount is
    # higher than the available quota, request does not fail but all available
    # quota will be allocated.
    # For rate quota, BEST_EFFORT will continue to deduct from other groups
    # even if one does not have enough quota. For allocation, it will find the
    # minimum available amount across all groups and deduct that amount from
    # all the affected groups.
    BEST_EFFORT = 2

    # For AllocateQuota request, only checks if there is enough quota
    # available and does not change the available quota. No lock is placed on
    # the available quota either.
    CHECK_ONLY = 3

    # Unimplemented. When used in AllocateQuotaRequest, this returns the
    # effective quota limit(s) in the response, and no quota check will be
    # performed. Not supported for other requests, and even for
    # AllocateQuotaRequest, this is currently supported only for allowlisted
    # services.
    QUERY_ONLY = 4

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the requested
    # amount is higher than the available quota, request does not fail and
    # remaining quota would become negative (going over the limit).
    # Not supported for Rate Quota.
    ADJUST_ONLY = 5
  end
end

#method_name ⇒ ::String

Returns Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration.

This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override.

Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf.

Returns:

  • (::String) —

    Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration.

    This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override.

    Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 97

class QuotaOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Supported quota modes.
  module QuotaMode
    # Guard against implicit default. Must not be used.
    UNSPECIFIED = 0

    # For AllocateQuota request, allocates quota for the amount specified in
    # the service configuration or specified using the quota metrics. If the
    # amount is higher than the available quota, allocation error will be
    # returned and no quota will be allocated.
    # If multiple quotas are part of the request, and one fails, none of the
    # quotas are allocated or released.
    NORMAL = 1

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the amount is
    # higher than the available quota, request does not fail but all available
    # quota will be allocated.
    # For rate quota, BEST_EFFORT will continue to deduct from other groups
    # even if one does not have enough quota. For allocation, it will find the
    # minimum available amount across all groups and deduct that amount from
    # all the affected groups.
    BEST_EFFORT = 2

    # For AllocateQuota request, only checks if there is enough quota
    # available and does not change the available quota. No lock is placed on
    # the available quota either.
    CHECK_ONLY = 3

    # Unimplemented. When used in AllocateQuotaRequest, this returns the
    # effective quota limit(s) in the response, and no quota check will be
    # performed. Not supported for other requests, and even for
    # AllocateQuotaRequest, this is currently supported only for allowlisted
    # services.
    QUERY_ONLY = 4

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the requested
    # amount is higher than the available quota, request does not fail and
    # remaining quota would become negative (going over the limit).
    # Not supported for Rate Quota.
    ADJUST_ONLY = 5
  end
end

#operation_id ⇒ ::String

Returns Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID.

Returns:

  • (::String) —

    Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

    In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 97

class QuotaOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Supported quota modes.
  module QuotaMode
    # Guard against implicit default. Must not be used.
    UNSPECIFIED = 0

    # For AllocateQuota request, allocates quota for the amount specified in
    # the service configuration or specified using the quota metrics. If the
    # amount is higher than the available quota, allocation error will be
    # returned and no quota will be allocated.
    # If multiple quotas are part of the request, and one fails, none of the
    # quotas are allocated or released.
    NORMAL = 1

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the amount is
    # higher than the available quota, request does not fail but all available
    # quota will be allocated.
    # For rate quota, BEST_EFFORT will continue to deduct from other groups
    # even if one does not have enough quota. For allocation, it will find the
    # minimum available amount across all groups and deduct that amount from
    # all the affected groups.
    BEST_EFFORT = 2

    # For AllocateQuota request, only checks if there is enough quota
    # available and does not change the available quota. No lock is placed on
    # the available quota either.
    CHECK_ONLY = 3

    # Unimplemented. When used in AllocateQuotaRequest, this returns the
    # effective quota limit(s) in the response, and no quota check will be
    # performed. Not supported for other requests, and even for
    # AllocateQuotaRequest, this is currently supported only for allowlisted
    # services.
    QUERY_ONLY = 4

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the requested
    # amount is higher than the available quota, request does not fail and
    # remaining quota would become negative (going over the limit).
    # Not supported for Rate Quota.
    ADJUST_ONLY = 5
  end
end

#quota_metrics ⇒ ::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>

Returns Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

Returns:

  • (::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>) —

    Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

    Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

    This field is mutually exclusive with method_name.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 97

class QuotaOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Supported quota modes.
  module QuotaMode
    # Guard against implicit default. Must not be used.
    UNSPECIFIED = 0

    # For AllocateQuota request, allocates quota for the amount specified in
    # the service configuration or specified using the quota metrics. If the
    # amount is higher than the available quota, allocation error will be
    # returned and no quota will be allocated.
    # If multiple quotas are part of the request, and one fails, none of the
    # quotas are allocated or released.
    NORMAL = 1

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the amount is
    # higher than the available quota, request does not fail but all available
    # quota will be allocated.
    # For rate quota, BEST_EFFORT will continue to deduct from other groups
    # even if one does not have enough quota. For allocation, it will find the
    # minimum available amount across all groups and deduct that amount from
    # all the affected groups.
    BEST_EFFORT = 2

    # For AllocateQuota request, only checks if there is enough quota
    # available and does not change the available quota. No lock is placed on
    # the available quota either.
    CHECK_ONLY = 3

    # Unimplemented. When used in AllocateQuotaRequest, this returns the
    # effective quota limit(s) in the response, and no quota check will be
    # performed. Not supported for other requests, and even for
    # AllocateQuotaRequest, this is currently supported only for allowlisted
    # services.
    QUERY_ONLY = 4

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the requested
    # amount is higher than the available quota, request does not fail and
    # remaining quota would become negative (going over the limit).
    # Not supported for Rate Quota.
    ADJUST_ONLY = 5
  end
end

#quota_mode ⇒ ::Google::Cloud::ServiceControl::V1::QuotaOperation::QuotaMode

Returns Quota mode for this operation.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'proto_docs/google/api/servicecontrol/v1/quota_controller.rb', line 97

class QuotaOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Supported quota modes.
  module QuotaMode
    # Guard against implicit default. Must not be used.
    UNSPECIFIED = 0

    # For AllocateQuota request, allocates quota for the amount specified in
    # the service configuration or specified using the quota metrics. If the
    # amount is higher than the available quota, allocation error will be
    # returned and no quota will be allocated.
    # If multiple quotas are part of the request, and one fails, none of the
    # quotas are allocated or released.
    NORMAL = 1

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the amount is
    # higher than the available quota, request does not fail but all available
    # quota will be allocated.
    # For rate quota, BEST_EFFORT will continue to deduct from other groups
    # even if one does not have enough quota. For allocation, it will find the
    # minimum available amount across all groups and deduct that amount from
    # all the affected groups.
    BEST_EFFORT = 2

    # For AllocateQuota request, only checks if there is enough quota
    # available and does not change the available quota. No lock is placed on
    # the available quota either.
    CHECK_ONLY = 3

    # Unimplemented. When used in AllocateQuotaRequest, this returns the
    # effective quota limit(s) in the response, and no quota check will be
    # performed. Not supported for other requests, and even for
    # AllocateQuotaRequest, this is currently supported only for allowlisted
    # services.
    QUERY_ONLY = 4

    # The operation allocates quota for the amount specified in the service
    # configuration or specified using the quota metrics. If the requested
    # amount is higher than the available quota, request does not fail and
    # remaining quota would become negative (going over the limit).
    # Not supported for Rate Quota.
    ADJUST_ONLY = 5
  end
end