Class QuotaPreference (0.8.0)

public final class QuotaPreference extends 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.v1.QuotaPreference

Static Fields

CONTACT_EMAIL_FIELD_NUMBER

public static final int CONTACT_EMAIL_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

JUSTIFICATION_FIELD_NUMBER

public static final int JUSTIFICATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_CONFIG_FIELD_NUMBER

public static final int QUOTA_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_ID_FIELD_NUMBER

public static final int QUOTA_ID_FIELD_NUMBER
Field Value
TypeDescription
int

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static QuotaPreference getDefaultInstance()
Returns
TypeDescription
QuotaPreference

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static QuotaPreference.Builder newBuilder()
Returns
TypeDescription
QuotaPreference.Builder

newBuilder(QuotaPreference prototype)

public static QuotaPreference.Builder newBuilder(QuotaPreference prototype)
Parameter
NameDescription
prototypeQuotaPreference
Returns
TypeDescription
QuotaPreference.Builder

parseDelimitedFrom(InputStream input)

public static QuotaPreference parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaPreference parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static QuotaPreference parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QuotaPreference parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QuotaPreference parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QuotaPreference parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QuotaPreference parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaPreference parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static QuotaPreference parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaPreference parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static QuotaPreference parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QuotaPreference parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaPreference
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<QuotaPreference> parser()
Returns
TypeDescription
Parser<QuotaPreference>

Methods

containsDimensions(String key)

public 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];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContactEmail()

public String getContactEmail()

Input only. An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted.

The email address is optional for decrease quota preferences. In another word, QuotaConfig.preferred_value is smaller than the QuotaDetails.reset_value. It is required for increase quota preferences. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.

string contact_email = 12 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
String

The contactEmail.

getContactEmailBytes()

public ByteString getContactEmailBytes()

Input only. An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted.

The email address is optional for decrease quota preferences. In another word, QuotaConfig.preferred_value is smaller than the QuotaDetails.reset_value. It is required for increase quota preferences. The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.

string contact_email = 12 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for contactEmail.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public QuotaPreference getDefaultInstanceForType()
Returns
TypeDescription
QuotaPreference

getDimensions() (deprecated)

public Map<String,String> getDimensions()

Use #getDimensionsMap() instead.

Returns
TypeDescription
Map<String,String>

getDimensionsCount()

public int getDimensionsCount()

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];

Returns
TypeDescription
int

getDimensionsMap()

public 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];

Returns
TypeDescription
Map<String,String>

getDimensionsOrDefault(String key, String defaultValue)

public 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];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getDimensionsOrThrow(String key)

public 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];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getEtag()

public 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];

Returns
TypeDescription
String

The etag.

getEtagBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for etag.

getJustification()

public String getJustification()

The reason / justification for this quota preference.

string justification = 11;

Returns
TypeDescription
String

The justification.

getJustificationBytes()

public ByteString getJustificationBytes()

The reason / justification for this quota preference.

string justification = 11;

Returns
TypeDescription
ByteString

The bytes for justification.

getName()

public 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;

Returns
TypeDescription
String

The name.

getNameBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<QuotaPreference> getParserForType()
Returns
TypeDescription
Parser<QuotaPreference>
Overrides

getQuotaConfig()

public QuotaConfig getQuotaConfig()

Required. Preferred quota configuration.

.google.api.cloudquotas.v1.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
QuotaConfig

The quotaConfig.

getQuotaConfigOrBuilder()

public QuotaConfigOrBuilder getQuotaConfigOrBuilder()

Required. Preferred quota configuration.

.google.api.cloudquotas.v1.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
QuotaConfigOrBuilder

getQuotaId()

public 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];

Returns
TypeDescription
String

The quotaId.

getQuotaIdBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for quotaId.

getReconciling()

public boolean getReconciling()

Output only. Is the quota preference pending Google Cloud approval and fulfillment.

bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The reconciling.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getService()

public String getService()

Required. The name of the service to which the quota preference is applied.

string service = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The service.

getServiceBytes()

public ByteString getServiceBytes()

Required. The name of the service to which the quota preference is applied.

string service = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for service.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasQuotaConfig()

public boolean hasQuotaConfig()

Required. Preferred quota configuration.

.google.api.cloudquotas.v1.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the quotaConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public QuotaPreference.Builder newBuilderForType()
Returns
TypeDescription
QuotaPreference.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QuotaPreference.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
QuotaPreference.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public QuotaPreference.Builder toBuilder()
Returns
TypeDescription
QuotaPreference.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException