public static final class AdminQuotaPolicy.Builder extends GeneratedMessageV3.Builder<AdminQuotaPolicy.Builder> implements AdminQuotaPolicyOrBuilderQuota policy created by quota administrator.
Protobuf type google.api.serviceusage.v1beta1.AdminQuotaPolicy
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AdminQuotaPolicy.BuilderImplements
AdminQuotaPolicyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AdminQuotaPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
build()
public AdminQuotaPolicy build()| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy | |
buildPartial()
public AdminQuotaPolicy buildPartial()| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy | |
clear()
public AdminQuotaPolicy.Builder clear()| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
clearContainer()
public AdminQuotaPolicy.Builder clearContainer() The cloud resource container at which the quota policy is created. The
format is {container_type}/{container_number}
string container = 6;
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | This builder for chaining. |
clearDimensions()
public AdminQuotaPolicy.Builder clearDimensions()| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
clearField(Descriptors.FieldDescriptor field)
public AdminQuotaPolicy.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
clearMetric()
public AdminQuotaPolicy.Builder clearMetric() The name of the metric to which this policy applies.
An example name would be:
compute.googleapis.com/cpus
string metric = 4;
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | This builder for chaining. |
clearName()
public AdminQuotaPolicy.Builder clearName() 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 | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AdminQuotaPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
clearPolicyValue()
public AdminQuotaPolicy.Builder clearPolicyValue()The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
int64 policy_value = 2;
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | This builder for chaining. |
clearUnit()
public AdminQuotaPolicy.Builder clearUnit() 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 | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | This builder for chaining. |
clone()
public AdminQuotaPolicy.Builder clone()| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
containsDimensions(String key)
public 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
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - Keys other than
regionorzoneare not valid.
map<string, string> dimensions = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getContainer()
public String getContainer() The cloud resource container at which the quota policy is created. The
format is {container_type}/{container_number}
string container = 6;
| Returns | |
|---|---|
| Type | Description |
String | The container. |
getContainerBytes()
public ByteString getContainerBytes() The cloud resource container at which the quota policy is created. The
format is {container_type}/{container_number}
string container = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for container. |
getDefaultInstanceForType()
public AdminQuotaPolicy getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDimensions()
public Map<String,String> getDimensions()Use #getDimensionsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getDimensionsCount()
public 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
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - Keys other than
regionorzoneare not valid.
map<string, string> dimensions = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
getDimensionsMap()
public 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
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - Keys other than
regionorzoneare not valid.
map<string, string> dimensions = 3;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getDimensionsOrDefault(String key, String defaultValue)
public 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
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - Keys other than
regionorzoneare not valid.
map<string, string> dimensions = 3;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getDimensionsOrThrow(String key)
public 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
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - Keys other than
regionorzoneare not valid.
map<string, string> dimensions = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMetric()
public 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 | |
|---|---|
| Type | Description |
String | The metric. |
getMetricBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for metric. |
getMutableDimensions()
public Map<String,String> getMutableDimensions()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getName()
public 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 | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getPolicyValue()
public long getPolicyValue()The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
int64 policy_value = 2;
| Returns | |
|---|---|
| Type | Description |
long | The policyValue. |
getUnit()
public 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 | |
|---|---|
| Type | Description |
String | The unit. |
getUnitBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for unit. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(AdminQuotaPolicy other)
public AdminQuotaPolicy.Builder mergeFrom(AdminQuotaPolicy other)| Parameter | |
|---|---|
| Name | Description |
other | AdminQuotaPolicy |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AdminQuotaPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public AdminQuotaPolicy.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AdminQuotaPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
putAllDimensions(Map<String,String> values)
public AdminQuotaPolicy.Builder putAllDimensions(Map<String,String> values) 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
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - Keys other than
regionorzoneare not valid.
map<string, string> dimensions = 3;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
putDimensions(String key, String value)
public AdminQuotaPolicy.Builder putDimensions(String key, String value) 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
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - Keys other than
regionorzoneare not valid.
map<string, string> dimensions = 3;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
removeDimensions(String key)
public AdminQuotaPolicy.Builder removeDimensions(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
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - Keys other than
regionorzoneare not valid.
map<string, string> dimensions = 3;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | |
setContainer(String value)
public AdminQuotaPolicy.Builder setContainer(String value) The cloud resource container at which the quota policy is created. The
format is {container_type}/{container_number}
string container = 6;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe container to set. |
| Returns | |
|---|---|
| Type | Description |
AdminQuotaPolicy.Builder | This builder for chaining. |
setContainerBytes(ByteString value)
public AdminQuotaPolicy.Builder setContainerBytes(ByteString value) The cloud resource container at which the quota policy is created. The
format is {container_type}/{container_number}
string container = 6;