public final class QuotaPreference extends com.google.protobuf.GeneratedMessageV3 implements QuotaPreferenceOrBuilder
QuotaPreference represents the preferred quota configuration specified for a project, folder or organization. There is only one QuotaPreference resource for a quota value targeting a unique set of dimensions.Protobuf type
google.api.cloudquotas.v1beta.QuotaPreference| Modifier and Type | Class and Description |
|---|---|
static class |
QuotaPreference.Builder
QuotaPreference represents the preferred quota configuration specified for
a project, folder or organization.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
CONTACT_EMAIL_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DIMENSIONS_FIELD_NUMBER |
static int |
ETAG_FIELD_NUMBER |
static int |
JUSTIFICATION_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
QUOTA_CONFIG_FIELD_NUMBER |
static int |
QUOTA_ID_FIELD_NUMBER |
static int |
RECONCILING_FIELD_NUMBER |
static int |
SERVICE_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsDimensions(String key)
Immutable.
|
boolean |
equals(Object obj) |
String |
getContactEmail()
Input only.
|
com.google.protobuf.ByteString |
getContactEmailBytes()
Input only.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static QuotaPreference |
getDefaultInstance() |
QuotaPreference |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Map<String,String> |
getDimensions()
Deprecated.
|
int |
getDimensionsCount()
Immutable.
|
Map<String,String> |
getDimensionsMap()
Immutable.
|
String |
getDimensionsOrDefault(String key,
String defaultValue)
Immutable.
|
String |
getDimensionsOrThrow(String key)
Immutable.
|
String |
getEtag()
Optional.
|
com.google.protobuf.ByteString |
getEtagBytes()
Optional.
|
String |
getJustification()
The reason / justification for this quota preference.
|
com.google.protobuf.ByteString |
getJustificationBytes()
The reason / justification for this quota preference.
|
String |
getName()
Required except in the CREATE requests.
|
com.google.protobuf.ByteString |
getNameBytes()
Required except in the CREATE requests.
|
com.google.protobuf.Parser<QuotaPreference> |
getParserForType() |
QuotaConfig |
getQuotaConfig()
Required.
|
QuotaConfigOrBuilder |
getQuotaConfigOrBuilder()
Required.
|
String |
getQuotaId()
Required.
|
com.google.protobuf.ByteString |
getQuotaIdBytes()
Required.
|
boolean |
getReconciling()
Output only.
|
int |
getSerializedSize() |
String |
getService()
Required.
|
com.google.protobuf.ByteString |
getServiceBytes()
Required.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasQuotaConfig()
Required.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static QuotaPreference.Builder |
newBuilder() |
static QuotaPreference.Builder |
newBuilder(QuotaPreference prototype) |
QuotaPreference.Builder |
newBuilderForType() |
protected QuotaPreference.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static QuotaPreference |
parseDelimitedFrom(InputStream input) |
static QuotaPreference |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QuotaPreference |
parseFrom(byte[] data) |
static QuotaPreference |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QuotaPreference |
parseFrom(ByteBuffer data) |
static QuotaPreference |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QuotaPreference |
parseFrom(com.google.protobuf.ByteString data) |
static QuotaPreference |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QuotaPreference |
parseFrom(com.google.protobuf.CodedInputStream input) |
static QuotaPreference |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QuotaPreference |
parseFrom(InputStream input) |
static QuotaPreference |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<QuotaPreference> |
parser() |
QuotaPreference.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
public static final int QUOTA_CONFIG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int SERVICE_FIELD_NUMBER
public static final int QUOTA_ID_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
public static final int JUSTIFICATION_FIELD_NUMBER
public static final int CONTACT_EMAIL_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Required except in the CREATE requests. The resource name of the quota preference. The ID component following "locations/" must be "global". Example: `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`
string name = 1;getName in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Required except in the CREATE requests. The resource name of the quota preference. The ID component following "locations/" must be "global". Example: `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`
string name = 1;getNameBytes in interface QuotaPreferenceOrBuilderpublic int getDimensionsCount()
QuotaPreferenceOrBuilder
Immutable. The dimensions that this quota preference applies to. The key of
the map entry is the name of a dimension, such as "region", "zone",
"network_id", and the value of the map entry is the dimension value.
If a dimension is missing from the map of dimensions, the quota preference
applies to all the dimension values except for those that have other quota
preferences configured for the specific value.
NOTE: QuotaPreferences can only be applied across all values of "user" and
"resource" dimension. Do not set values for "user" or "resource" in the
dimension map.
Example: {"provider", "Foo Inc"} where "provider" is a service specific
dimension.
map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
getDimensionsCount in interface QuotaPreferenceOrBuilderpublic boolean containsDimensions(String key)
Immutable. The dimensions that this quota preference applies to. The key of
the map entry is the name of a dimension, such as "region", "zone",
"network_id", and the value of the map entry is the dimension value.
If a dimension is missing from the map of dimensions, the quota preference
applies to all the dimension values except for those that have other quota
preferences configured for the specific value.
NOTE: QuotaPreferences can only be applied across all values of "user" and
"resource" dimension. Do not set values for "user" or "resource" in the
dimension map.
Example: {"provider", "Foo Inc"} where "provider" is a service specific
dimension.
map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
containsDimensions in interface QuotaPreferenceOrBuilder@Deprecated public Map<String,String> getDimensions()
getDimensionsMap() instead.getDimensions in interface QuotaPreferenceOrBuilderpublic Map<String,String> getDimensionsMap()
Immutable. The dimensions that this quota preference applies to. The key of
the map entry is the name of a dimension, such as "region", "zone",
"network_id", and the value of the map entry is the dimension value.
If a dimension is missing from the map of dimensions, the quota preference
applies to all the dimension values except for those that have other quota
preferences configured for the specific value.
NOTE: QuotaPreferences can only be applied across all values of "user" and
"resource" dimension. Do not set values for "user" or "resource" in the
dimension map.
Example: {"provider", "Foo Inc"} where "provider" is a service specific
dimension.
map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
getDimensionsMap in interface QuotaPreferenceOrBuilderpublic String getDimensionsOrDefault(String key, String defaultValue)
Immutable. The dimensions that this quota preference applies to. The key of
the map entry is the name of a dimension, such as "region", "zone",
"network_id", and the value of the map entry is the dimension value.
If a dimension is missing from the map of dimensions, the quota preference
applies to all the dimension values except for those that have other quota
preferences configured for the specific value.
NOTE: QuotaPreferences can only be applied across all values of "user" and
"resource" dimension. Do not set values for "user" or "resource" in the
dimension map.
Example: {"provider", "Foo Inc"} where "provider" is a service specific
dimension.
map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
getDimensionsOrDefault in interface QuotaPreferenceOrBuilderpublic String getDimensionsOrThrow(String key)
Immutable. The dimensions that this quota preference applies to. The key of
the map entry is the name of a dimension, such as "region", "zone",
"network_id", and the value of the map entry is the dimension value.
If a dimension is missing from the map of dimensions, the quota preference
applies to all the dimension values except for those that have other quota
preferences configured for the specific value.
NOTE: QuotaPreferences can only be applied across all values of "user" and
"resource" dimension. Do not set values for "user" or "resource" in the
dimension map.
Example: {"provider", "Foo Inc"} where "provider" is a service specific
dimension.
map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
getDimensionsOrThrow in interface QuotaPreferenceOrBuilderpublic boolean hasQuotaConfig()
Required. Preferred quota configuration.
.google.api.cloudquotas.v1beta.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];
hasQuotaConfig in interface QuotaPreferenceOrBuilderpublic QuotaConfig getQuotaConfig()
Required. Preferred quota configuration.
.google.api.cloudquotas.v1beta.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];
getQuotaConfig in interface QuotaPreferenceOrBuilderpublic QuotaConfigOrBuilder getQuotaConfigOrBuilder()
Required. Preferred quota configuration.
.google.api.cloudquotas.v1beta.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];
getQuotaConfigOrBuilder in interface QuotaPreferenceOrBuilderpublic String getEtag()
Optional. The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
string etag = 4 [(.google.api.field_behavior) = OPTIONAL];getEtag in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.ByteString getEtagBytes()
Optional. The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
string etag = 4 [(.google.api.field_behavior) = OPTIONAL];getEtagBytes in interface QuotaPreferenceOrBuilderpublic boolean hasCreateTime()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface QuotaPreferenceOrBuilderpublic boolean hasUpdateTime()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface QuotaPreferenceOrBuilderpublic String getService()
Required. The name of the service to which the quota preference is applied.
string service = 7 [(.google.api.field_behavior) = REQUIRED];getService in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.ByteString getServiceBytes()
Required. The name of the service to which the quota preference is applied.
string service = 7 [(.google.api.field_behavior) = REQUIRED];getServiceBytes in interface QuotaPreferenceOrBuilderpublic String getQuotaId()
Required. The id of the quota to which the quota preference is applied. A quota name is unique in the service. Example: `CpusPerProjectPerRegion`
string quota_id = 8 [(.google.api.field_behavior) = REQUIRED];getQuotaId in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.ByteString getQuotaIdBytes()
Required. The id of the quota to which the quota preference is applied. A quota name is unique in the service. Example: `CpusPerProjectPerRegion`
string quota_id = 8 [(.google.api.field_behavior) = REQUIRED];getQuotaIdBytes in interface QuotaPreferenceOrBuilderpublic boolean getReconciling()
Output only. Is the quota preference pending Google Cloud approval and fulfillment.
bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getReconciling in interface QuotaPreferenceOrBuilderpublic String getJustification()
The reason / justification for this quota preference.
string justification = 11;getJustification in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.ByteString getJustificationBytes()
The reason / justification for this quota preference.
string justification = 11;getJustificationBytes in interface QuotaPreferenceOrBuilderpublic String getContactEmail()
Input only. An email address that can be used to contact the the user, in case Google Cloud needs more information to make a decision before additional quota can be granted. When requesting a quota increase, the email address is required. When requesting a quota decrease, the email address is optional. For example, the email address is optional when the `QuotaConfig.preferred_value` is smaller than the `QuotaDetails.reset_value`.
string contact_email = 12 [(.google.api.field_behavior) = INPUT_ONLY];getContactEmail in interface QuotaPreferenceOrBuilderpublic com.google.protobuf.ByteString getContactEmailBytes()
Input only. An email address that can be used to contact the the user, in case Google Cloud needs more information to make a decision before additional quota can be granted. When requesting a quota increase, the email address is required. When requesting a quota decrease, the email address is optional. For example, the email address is optional when the `QuotaConfig.preferred_value` is smaller than the `QuotaDetails.reset_value`.
string contact_email = 12 [(.google.api.field_behavior) = INPUT_ONLY];getContactEmailBytes in interface QuotaPreferenceOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static QuotaPreference parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QuotaPreference parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QuotaPreference parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QuotaPreference parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QuotaPreference parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QuotaPreference parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QuotaPreference parseFrom(InputStream input) throws IOException
IOExceptionpublic static QuotaPreference parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static QuotaPreference parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static QuotaPreference parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static QuotaPreference parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static QuotaPreference parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic QuotaPreference.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static QuotaPreference.Builder newBuilder()
public static QuotaPreference.Builder newBuilder(QuotaPreference prototype)
public QuotaPreference.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected QuotaPreference.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static QuotaPreference getDefaultInstance()
public static com.google.protobuf.Parser<QuotaPreference> parser()
public com.google.protobuf.Parser<QuotaPreference> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public QuotaPreference getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.