QuotaLimit (proto-google-common-protos 1.12.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.api.QuotaLimit

All Implemented Interfaces:: QuotaLimitOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class QuotaLimit
extends com.google.protobuf.GeneratedMessageV3
implements QuotaLimitOrBuilder

 `QuotaLimit` defines a specific limit that applies over a specified duration
 for a limit type. There can be at most one limit for a duration and limit
 type combination defined within a `QuotaGroup`.

Protobuf type google.api.QuotaLimit

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QuotaLimit.Builder
`QuotaLimit` defines a specific limit that applies over a specified duration for a limit type.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Nested Classes
Modifier and Type	Class and Description
`static class`	`QuotaLimit.Builder` `QuotaLimit` defines a specific limit that applies over a specified duration for a limit type.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_LIMIT_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`DURATION_FIELD_NUMBER`
`static int`	`FREE_TIER_FIELD_NUMBER`
`static int`	`MAX_LIMIT_FIELD_NUMBER`
`static int`	`METRIC_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`UNIT_FIELD_NUMBER`
`static int`	`VALUES_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsValues(java.lang.String key)` Tiered limit values.
`boolean`	`equals(java.lang.Object obj)`
`static QuotaLimit`	`getDefaultInstance()`
`QuotaLimit`	`getDefaultInstanceForType()`
`long`	`getDefaultLimit()` Default number of tokens that can be consumed during the specified duration.
`java.lang.String`	`getDescription()` Optional.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` Optional.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`java.lang.String`	`getDisplayName()` User-visible display name for this limit.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` User-visible display name for this limit.
`java.lang.String`	`getDuration()` Duration of this limit in textual notation.
`com.google.protobuf.ByteString`	`getDurationBytes()` Duration of this limit in textual notation.
`long`	`getFreeTier()` Free tier value displayed in the Developers Console for this limit.
`long`	`getMaxLimit()` Maximum number of tokens that can be consumed during the specified duration.
`java.lang.String`	`getMetric()` The name of the metric this quota limit applies to.
`com.google.protobuf.ByteString`	`getMetricBytes()` The name of the metric this quota limit applies to.
`java.lang.String`	`getName()` Name of the quota limit.
`com.google.protobuf.ByteString`	`getNameBytes()` Name of the quota limit.
`com.google.protobuf.Parser<QuotaLimit>`	`getParserForType()`
`int`	`getSerializedSize()`
`java.lang.String`	`getUnit()` Specify the unit of the quota limit.
`com.google.protobuf.ByteString`	`getUnitBytes()` Specify the unit of the quota limit.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`java.util.Map<java.lang.String,java.lang.Long>`	`getValues()` Deprecated.
`int`	`getValuesCount()` Tiered limit values.
`java.util.Map<java.lang.String,java.lang.Long>`	`getValuesMap()` Tiered limit values.
`long`	`getValuesOrDefault(java.lang.String key, long defaultValue)` Tiered limit values.
`long`	`getValuesOrThrow(java.lang.String key)` Tiered limit values.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static QuotaLimit.Builder`	`newBuilder()`
`static QuotaLimit.Builder`	`newBuilder(QuotaLimit prototype)`
`QuotaLimit.Builder`	`newBuilderForType()`
`protected QuotaLimit.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static QuotaLimit`	`parseDelimitedFrom(java.io.InputStream input)`
`static QuotaLimit`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QuotaLimit`	`parseFrom(byte[] data)`
`static QuotaLimit`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QuotaLimit`	`parseFrom(java.nio.ByteBuffer data)`
`static QuotaLimit`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QuotaLimit`	`parseFrom(com.google.protobuf.ByteString data)`
`static QuotaLimit`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QuotaLimit`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static QuotaLimit`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static QuotaLimit`	`parseFrom(java.io.InputStream input)`
`static QuotaLimit`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<QuotaLimit>`	`parser()`
`QuotaLimit.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEFAULT_LIMIT_FIELD_NUMBER
```
public static final int DEFAULT_LIMIT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MAX_LIMIT_FIELD_NUMBER
```
public static final int MAX_LIMIT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FREE_TIER_FIELD_NUMBER
```
public static final int FREE_TIER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DURATION_FIELD_NUMBER
```
public static final int DURATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METRIC_FIELD_NUMBER
```
public static final int METRIC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UNIT_FIELD_NUMBER
```
public static final int UNIT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VALUES_FIELD_NUMBER
```
public static final int VALUES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public java.lang.String getName()

 Name of the quota limit. The name is used to refer to the limit when
 overriding the default limit on per-consumer basis.
 For group-based quota limits, the name must be unique within the quota
 group. If a name is not provided, it will be generated from the limit_by
 and duration fields.
 For metric-based quota limits, the name must be provided, and it must be
 unique within the service. The name can only include alphanumeric
 characters as well as '-'.
 The maximum length of the limit name is 64 characters.
 The name of a limit is used as a unique identifier for this limit.
 Therefore, once a limit has been put into use, its name should be
 immutable. You can use the display_name field to provide a user-friendly
 name for the limit. The display name can be evolved over time without
 affecting the identity of the limit.

string name = 6;

Specified by:: getName in interface QuotaLimitOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Name of the quota limit. The name is used to refer to the limit when
 overriding the default limit on per-consumer basis.
 For group-based quota limits, the name must be unique within the quota
 group. If a name is not provided, it will be generated from the limit_by
 and duration fields.
 For metric-based quota limits, the name must be provided, and it must be
 unique within the service. The name can only include alphanumeric
 characters as well as '-'.
 The maximum length of the limit name is 64 characters.
 The name of a limit is used as a unique identifier for this limit.
 Therefore, once a limit has been put into use, its name should be
 immutable. You can use the display_name field to provide a user-friendly
 name for the limit. The display name can be evolved over time without
 affecting the identity of the limit.

string name = 6;

Specified by:: getNameBytes in interface QuotaLimitOrBuilder

getDescription

public java.lang.String getDescription()

 Optional. User-visible, extended description for this quota limit.
 Should be used only when more context is needed to understand this limit
 than provided by the limit's display name (see: `display_name`).

string description = 2;

Specified by:: getDescription in interface QuotaLimitOrBuilder

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Optional. User-visible, extended description for this quota limit.
 Should be used only when more context is needed to understand this limit
 than provided by the limit's display name (see: `display_name`).

string description = 2;

Specified by:: getDescriptionBytes in interface QuotaLimitOrBuilder

getDefaultLimit

public long getDefaultLimit()

 Default number of tokens that can be consumed during the specified
 duration. This is the number of tokens assigned when a client
 application developer activates the service for his/her project.
 Specifying a value of 0 will block all requests. This can be used if you
 are provisioning quota to selected consumers and blocking others.
 Similarly, a value of -1 will indicate an unlimited quota. No other
 negative values are allowed.
 Used by group-based quotas only.

int64 default_limit = 3;

Specified by:: getDefaultLimit in interface QuotaLimitOrBuilder

getMaxLimit

public long getMaxLimit()

 Maximum number of tokens that can be consumed during the specified
 duration. Client application developers can override the default limit up
 to this maximum. If specified, this value cannot be set to a value less
 than the default limit. If not specified, it is set to the default limit.
 To allow clients to apply overrides with no upper bound, set this to -1,
 indicating unlimited maximum quota.
 Used by group-based quotas only.

int64 max_limit = 4;

Specified by:: getMaxLimit in interface QuotaLimitOrBuilder

getFreeTier

public long getFreeTier()

 Free tier value displayed in the Developers Console for this limit.
 The free tier is the number of tokens that will be subtracted from the
 billed amount when billing is enabled.
 This field can only be set on a limit with duration "1d", in a billable
 group; it is invalid on any other limit. If this field is not set, it
 defaults to 0, indicating that there is no free tier for this service.
 Used by group-based quotas only.

int64 free_tier = 7;

Specified by:: getFreeTier in interface QuotaLimitOrBuilder

getDuration

public java.lang.String getDuration()

 Duration of this limit in textual notation. Example: "100s", "24h", "1d".
 For duration longer than a day, only multiple of days is supported. We
 support only "100s" and "1d" for now. Additional support will be added in
 the future. "0" indicates indefinite duration.
 Used by group-based quotas only.

string duration = 5;

Specified by:: getDuration in interface QuotaLimitOrBuilder

getDurationBytes

public com.google.protobuf.ByteString getDurationBytes()

 Duration of this limit in textual notation. Example: "100s", "24h", "1d".
 For duration longer than a day, only multiple of days is supported. We
 support only "100s" and "1d" for now. Additional support will be added in
 the future. "0" indicates indefinite duration.
 Used by group-based quotas only.

string duration = 5;

Specified by:: getDurationBytes in interface QuotaLimitOrBuilder

getMetric

public java.lang.String getMetric()

 The name of the metric this quota limit applies to. The quota limits with
 the same metric will be checked together during runtime. The metric must be
 defined within the service config.
 Used by metric-based quotas only.

string metric = 8;

Specified by:: getMetric in interface QuotaLimitOrBuilder

getMetricBytes

public com.google.protobuf.ByteString getMetricBytes()

 The name of the metric this quota limit applies to. The quota limits with
 the same metric will be checked together during runtime. The metric must be
 defined within the service config.
 Used by metric-based quotas only.

string metric = 8;

Specified by:: getMetricBytes in interface QuotaLimitOrBuilder

getUnit

public java.lang.String getUnit()

 Specify the unit of the quota limit. It uses the same syntax as
 [Metric.unit][]. The supported unit kinds are determined by the quota
 backend system.
 The [Google Service Control](https://cloud.google.com/service-control)
 supports the following unit components:
 * One of the time intevals:
   * "/min"  for quota every minute.
   * "/d"  for quota every 24 hours, starting 00:00 US Pacific Time.
   * Otherwise the quota won't be reset by time, such as storage limit.
 * One and only one of the granted containers:
   * "/{organization}" quota for an organization.
   * "/{project}" quota for a project.
   * "/{folder}" quota for a folder.
   * "/{resource}" quota for a universal resource.
 * Zero or more quota segmentation dimension. Not all combos are valid.
   * "/{region}" quota for every region. Not to be used with time intervals.
   * Otherwise the resources granted on the target is not segmented.
   * "/{zone}" quota for every zone. Not to be used with time intervals.
   * Otherwise the resources granted on the target is not segmented.
   * "/{resource}" quota for a resource associated with a project or org.
 Here are some examples:
 * "1/min/{project}" for quota per minute per project.
 * "1/min/{user}" for quota per minute per user.
 * "1/min/{organization}" for quota per minute per organization.
 Note: the order of unit components is insignificant.
 The "1" at the beginning is required to follow the metric unit syntax.
 Used by metric-based quotas only.

string unit = 9;

Specified by:: getUnit in interface QuotaLimitOrBuilder

getUnitBytes

public com.google.protobuf.ByteString getUnitBytes()

 Specify the unit of the quota limit. It uses the same syntax as
 [Metric.unit][]. The supported unit kinds are determined by the quota
 backend system.
 The [Google Service Control](https://cloud.google.com/service-control)
 supports the following unit components:
 * One of the time intevals:
   * "/min"  for quota every minute.
   * "/d"  for quota every 24 hours, starting 00:00 US Pacific Time.
   * Otherwise the quota won't be reset by time, such as storage limit.
 * One and only one of the granted containers:
   * "/{organization}" quota for an organization.
   * "/{project}" quota for a project.
   * "/{folder}" quota for a folder.
   * "/{resource}" quota for a universal resource.
 * Zero or more quota segmentation dimension. Not all combos are valid.
   * "/{region}" quota for every region. Not to be used with time intervals.
   * Otherwise the resources granted on the target is not segmented.
   * "/{zone}" quota for every zone. Not to be used with time intervals.
   * Otherwise the resources granted on the target is not segmented.
   * "/{resource}" quota for a resource associated with a project or org.
 Here are some examples:
 * "1/min/{project}" for quota per minute per project.
 * "1/min/{user}" for quota per minute per user.
 * "1/min/{organization}" for quota per minute per organization.
 Note: the order of unit components is insignificant.
 The "1" at the beginning is required to follow the metric unit syntax.
 Used by metric-based quotas only.

string unit = 9;

Specified by:: getUnitBytes in interface QuotaLimitOrBuilder