Interface AdminQuotaPolicyOrBuilder (2.3.5)

Stay organized with collections Save and categorize content based on your preferences.
public interface AdminQuotaPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDimensions(String key)

public abstract boolean containsDimensions(String key)

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the policy is only applied to quota consumed in that region. This map has the following restrictions:

  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • Keys other than region or zone are not valid.

map<string, string> dimensions = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getContainer()

public abstract String getContainer()

The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}

string container = 6;

Returns
TypeDescription
String

The container.

getContainerBytes()

public abstract ByteString getContainerBytes()

The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}

string container = 6;

Returns
TypeDescription
ByteString

The bytes for container.

getDimensions()

public abstract Map<String,String> getDimensions()

Use #getDimensionsMap() instead.

Returns
TypeDescription
Map<String,String>

getDimensionsCount()

public abstract int getDimensionsCount()

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the policy is only applied to quota consumed in that region. This map has the following restrictions:

  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • Keys other than region or zone are not valid.

map<string, string> dimensions = 3;

Returns
TypeDescription
int

getDimensionsMap()

public abstract Map<String,String> getDimensionsMap()

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the policy is only applied to quota consumed in that region. This map has the following restrictions:

  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • Keys other than region or zone are not valid.

map<string, string> dimensions = 3;

Returns
TypeDescription
Map<String,String>

getDimensionsOrDefault(String key, String defaultValue)

public abstract String getDimensionsOrDefault(String key, String defaultValue)

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the policy is only applied to quota consumed in that region. This map has the following restrictions:

  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • Keys other than region or zone are not valid.

map<string, string> dimensions = 3;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getDimensionsOrThrow(String key)

public abstract String getDimensionsOrThrow(String key)

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the policy is only applied to quota consumed in that region. This map has the following restrictions:

  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • Keys other than region or zone are not valid.

map<string, string> dimensions = 3;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMetric()

public abstract String getMetric()

The name of the metric to which this policy applies. An example name would be: compute.googleapis.com/cpus

string metric = 4;

Returns
TypeDescription
String

The metric.

getMetricBytes()

public abstract ByteString getMetricBytes()

The name of the metric to which this policy applies. An example name would be: compute.googleapis.com/cpus

string metric = 4;

Returns
TypeDescription
ByteString

The bytes for metric.

getName()

public abstract String getName()

The resource name of the policy. This name is generated by the server when the policy is created. Example names would be: organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the policy. This name is generated by the server when the policy is created. Example names would be: organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getPolicyValue()

public abstract long getPolicyValue()

The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).

int64 policy_value = 2;

Returns
TypeDescription
long

The policyValue.

getUnit()

public abstract String getUnit()

The limit unit of the limit to which this policy applies. An example unit would be: 1/{project}/{region} Note that {project} and {region} are not placeholders in this example; the literal characters { and } occur in the string.

string unit = 5;

Returns
TypeDescription
String

The unit.

getUnitBytes()

public abstract ByteString getUnitBytes()

The limit unit of the limit to which this policy applies. An example unit would be: 1/{project}/{region} Note that {project} and {region} are not placeholders in this example; the literal characters { and } occur in the string.

string unit = 5;

Returns
TypeDescription
ByteString

The bytes for unit.