Interface QuotaPreferenceOrBuilder (0.10.0)

public interface QuotaPreferenceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDimensions(String key)

public abstract 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
Name Description
key String
Returns
Type Description
boolean

getContactEmail()

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

Returns
Type Description
String

The contactEmail.

getContactEmailBytes()

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

Returns
Type Description
ByteString

The bytes for contactEmail.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Create time stamp

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp

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

Returns
Type Description
TimestampOrBuilder

getDimensions() (deprecated)

public abstract Map<String,String> getDimensions()

Use #getDimensionsMap() instead.

Returns
Type Description
Map<String,String>

getDimensionsCount()

public abstract 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
Type Description
int

getDimensionsMap()

public abstract 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
Type Description
Map<String,String>

getDimensionsOrDefault(String key, String defaultValue)

public abstract 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
Name Description
key String
defaultValue String
Returns
Type Description
String

getDimensionsOrThrow(String key)

public abstract 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
Name Description
key String
Returns
Type Description
String

getEtag()

public abstract 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
Type Description
String

The etag.

getEtagBytes()

public abstract 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
Type Description
ByteString

The bytes for etag.

getJustification()

public abstract String getJustification()

The reason / justification for this quota preference.

string justification = 11;

Returns
Type Description
String

The justification.

getJustificationBytes()

public abstract ByteString getJustificationBytes()

The reason / justification for this quota preference.

string justification = 11;

Returns
Type Description
ByteString

The bytes for justification.

getName()

public abstract 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
Type Description
String

The name.

getNameBytes()

public abstract 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
Type Description
ByteString

The bytes for name.

getQuotaConfig()

public abstract QuotaConfig getQuotaConfig()

Required. Preferred quota configuration.

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

Returns
Type Description
QuotaConfig

The quotaConfig.

getQuotaConfigOrBuilder()

public abstract QuotaConfigOrBuilder getQuotaConfigOrBuilder()

Required. Preferred quota configuration.

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

Returns
Type Description
QuotaConfigOrBuilder

getQuotaId()

public abstract 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
Type Description
String

The quotaId.

getQuotaIdBytes()

public abstract 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
Type Description
ByteString

The bytes for quotaId.

getReconciling()

public abstract boolean getReconciling()

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

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

Returns
Type Description
boolean

The reconciling.

getService()

public abstract String getService()

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

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

Returns
Type Description
String

The service.

getServiceBytes()

public abstract ByteString getServiceBytes()

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

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

Returns
Type Description
ByteString

The bytes for service.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Update time stamp

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Create time stamp

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasQuotaConfig()

public abstract boolean hasQuotaConfig()

Required. Preferred quota configuration.

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

Returns
Type Description
boolean

Whether the quotaConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Update time stamp

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

Returns
Type Description
boolean

Whether the updateTime field is set.