Package com.google.api
Class QuotaLimit
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
,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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
`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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
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
Modifier and TypeMethodDescriptionboolean
containsValues
(String key) Tiered limit values.boolean
static QuotaLimit
long
Default number of tokens that can be consumed during the specified duration.Optional.com.google.protobuf.ByteString
Optional.static final com.google.protobuf.Descriptors.Descriptor
User-visible display name for this limit.com.google.protobuf.ByteString
User-visible display name for this limit.Duration of this limit in textual notation.com.google.protobuf.ByteString
Duration of this limit in textual notation.long
Free tier value displayed in the Developers Console for this limit.long
Maximum number of tokens that can be consumed during the specified duration.The name of the metric this quota limit applies to.com.google.protobuf.ByteString
The name of the metric this quota limit applies to.getName()
Name of the quota limit.com.google.protobuf.ByteString
Name of the quota limit.com.google.protobuf.Parser<QuotaLimit>
int
getUnit()
Specify the unit of the quota limit.com.google.protobuf.ByteString
Specify the unit of the quota limit.Deprecated.int
Tiered limit values.Tiered limit values.long
getValuesOrDefault
(String key, long defaultValue) Tiered limit values.long
getValuesOrThrow
(String key) Tiered limit values.int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMapFieldReflection
(int number) final boolean
static QuotaLimit.Builder
static QuotaLimit.Builder
newBuilder
(QuotaLimit prototype) protected QuotaLimit.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static QuotaLimit
parseDelimitedFrom
(InputStream input) static QuotaLimit
parseDelimitedFrom
(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
(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
(InputStream input) static QuotaLimit
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QuotaLimit
parseFrom
(ByteBuffer data) static QuotaLimit
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<QuotaLimit>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
DEFAULT_LIMIT_FIELD_NUMBER
public static final int DEFAULT_LIMIT_FIELD_NUMBER- See Also:
-
MAX_LIMIT_FIELD_NUMBER
public static final int MAX_LIMIT_FIELD_NUMBER- See Also:
-
FREE_TIER_FIELD_NUMBER
public static final int FREE_TIER_FIELD_NUMBER- See Also:
-
DURATION_FIELD_NUMBER
public static final int DURATION_FIELD_NUMBER- See Also:
-
METRIC_FIELD_NUMBER
public static final int METRIC_FIELD_NUMBER- See Also:
-
UNIT_FIELD_NUMBER
public static final int UNIT_FIELD_NUMBER- See Also:
-
VALUES_FIELD_NUMBER
public static final int VALUES_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflection
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getName
Name of the quota limit. 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.
string name = 6;
- Specified by:
getName
in interfaceQuotaLimitOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Name of the quota limit. 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.
string name = 6;
- Specified by:
getNameBytes
in interfaceQuotaLimitOrBuilder
- Returns:
- The bytes for name.
-
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 interfaceQuotaLimitOrBuilder
- Returns:
- The description.
-
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 interfaceQuotaLimitOrBuilder
- Returns:
- The bytes for description.
-
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 interfaceQuotaLimitOrBuilder
- Returns:
- The defaultLimit.
-
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 interfaceQuotaLimitOrBuilder
- Returns:
- The maxLimit.
-
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 interfaceQuotaLimitOrBuilder
- Returns:
- The freeTier.
-
getDuration
Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
string duration = 5;
- Specified by:
getDuration
in interfaceQuotaLimitOrBuilder
- Returns:
- The duration.
-
getDurationBytes
public com.google.protobuf.ByteString getDurationBytes()Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
string duration = 5;
- Specified by:
getDurationBytes
in interfaceQuotaLimitOrBuilder
- Returns:
- The bytes for duration.
-
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.
string metric = 8;
- Specified by:
getMetric
in interfaceQuotaLimitOrBuilder
- Returns:
- The metric.
-
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.
string metric = 8;
- Specified by:
getMetricBytes
in interfaceQuotaLimitOrBuilder
- Returns:
- The bytes for metric.
-
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. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
string unit = 9;
- Specified by:
getUnit
in interfaceQuotaLimitOrBuilder
- Returns:
- The unit.
-
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. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
string unit = 9;
- Specified by:
getUnitBytes
in interfaceQuotaLimitOrBuilder
- Returns:
- The bytes for unit.
-
getValuesCount
public int getValuesCount()Description copied from interface:QuotaLimitOrBuilder
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;
- Specified by:
getValuesCount
in interfaceQuotaLimitOrBuilder
-
containsValues
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;
- Specified by:
containsValues
in interfaceQuotaLimitOrBuilder
-
getValues
Deprecated.UsegetValuesMap()
instead.- Specified by:
getValues
in interfaceQuotaLimitOrBuilder
-
getValuesMap
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;
- Specified by:
getValuesMap
in interfaceQuotaLimitOrBuilder
-
getValuesOrDefault
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;
- Specified by:
getValuesOrDefault
in interfaceQuotaLimitOrBuilder
-
getValuesOrThrow
Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
map<string, int64> values = 10;
- Specified by:
getValuesOrThrow
in interfaceQuotaLimitOrBuilder
-
getDisplayName
User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
string display_name = 12;
- Specified by:
getDisplayName
in interfaceQuotaLimitOrBuilder
- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
string display_name = 12;
- Specified by:
getDisplayNameBytes
in interfaceQuotaLimitOrBuilder
- Returns:
- The bytes for displayName.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static QuotaLimit parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaLimit parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaLimit parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaLimit parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaLimit parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaLimit parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static QuotaLimit parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static QuotaLimit parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static QuotaLimit parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected QuotaLimit.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-