- 2.48.0 (latest)
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.7
- 2.2.8
public static final class ProducerQuotaPolicy.Builder extends GeneratedMessageV3.Builder<ProducerQuotaPolicy.Builder> implements ProducerQuotaPolicyOrBuilder
Quota policy created by service producer.
Protobuf type google.api.serviceusage.v1beta1.ProducerQuotaPolicy
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ProducerQuotaPolicy.BuilderImplements
ProducerQuotaPolicyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ProducerQuotaPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
build()
public ProducerQuotaPolicy build()
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy |
buildPartial()
public ProducerQuotaPolicy buildPartial()
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy |
clear()
public ProducerQuotaPolicy.Builder clear()
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
clearContainer()
public ProducerQuotaPolicy.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 |
ProducerQuotaPolicy.Builder | This builder for chaining. |
clearDimensions()
public ProducerQuotaPolicy.Builder clearDimensions()
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
clearField(Descriptors.FieldDescriptor field)
public ProducerQuotaPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
clearMetric()
public ProducerQuotaPolicy.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 |
ProducerQuotaPolicy.Builder | This builder for chaining. |
clearName()
public ProducerQuotaPolicy.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/producerQuotaPolicies/4a3f2c1d
string name = 1;
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ProducerQuotaPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
clearPolicyValue()
public ProducerQuotaPolicy.Builder clearPolicyValue()
The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
int64 policy_value = 2;
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
clearUnit()
public ProducerQuotaPolicy.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 |
ProducerQuotaPolicy.Builder | This builder for chaining. |
clone()
public ProducerQuotaPolicy.Builder clone()
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.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, a 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:
- Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
project
is not a valid key; the project is already specified in the parent resource name.user
is not a valid key; the API does not support quota policies that apply only to a specific user.- 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. - If any valid key other than
region
orzone
appears in the map, then all valid keys other thanregion
orzone
must also appear in the map.
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 ProducerQuotaPolicy getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy |
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, a 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:
- Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
project
is not a valid key; the project is already specified in the parent resource name.user
is not a valid key; the API does not support quota policies that apply only to a specific user.- 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. - If any valid key other than
region
orzone
appears in the map, then all valid keys other thanregion
orzone
must also appear in the map.
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, a 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:
- Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
project
is not a valid key; the project is already specified in the parent resource name.user
is not a valid key; the API does not support quota policies that apply only to a specific user.- 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. - If any valid key other than
region
orzone
appears in the map, then all valid keys other thanregion
orzone
must also appear in the map.
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, a 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:
- Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
project
is not a valid key; the project is already specified in the parent resource name.user
is not a valid key; the API does not support quota policies that apply only to a specific user.- 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. - If any valid key other than
region
orzone
appears in the map, then all valid keys other thanregion
orzone
must also appear in the map.
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, a 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:
- Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
project
is not a valid key; the project is already specified in the parent resource name.user
is not a valid key; the API does not support quota policies that apply only to a specific user.- 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. - If any valid key other than
region
orzone
appears in the map, then all valid keys other thanregion
orzone
must also appear in the map.
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/producerQuotaPolicies/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/producerQuotaPolicies/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(ProducerQuotaPolicy other)
public ProducerQuotaPolicy.Builder mergeFrom(ProducerQuotaPolicy other)
Parameter | |
---|---|
Name | Description |
other | ProducerQuotaPolicy |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ProducerQuotaPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ProducerQuotaPolicy.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ProducerQuotaPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
putAllDimensions(Map<String,String> values)
public ProducerQuotaPolicy.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, a 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:
- Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
project
is not a valid key; the project is already specified in the parent resource name.user
is not a valid key; the API does not support quota policies that apply only to a specific user.- 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. - If any valid key other than
region
orzone
appears in the map, then all valid keys other thanregion
orzone
must also appear in the map.
map<string, string> dimensions = 3;
Parameter | |
---|---|
Name | Description |
values | Map<String,String> |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
putDimensions(String key, String value)
public ProducerQuotaPolicy.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, a 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:
- Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
project
is not a valid key; the project is already specified in the parent resource name.user
is not a valid key; the API does not support quota policies that apply only to a specific user.- 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. - If any valid key other than
region
orzone
appears in the map, then all valid keys other thanregion
orzone
must also appear in the map.
map<string, string> dimensions = 3;
Parameters | |
---|---|
Name | Description |
key | String |
value | String |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
removeDimensions(String key)
public ProducerQuotaPolicy.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, a 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:
- Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
project
is not a valid key; the project is already specified in the parent resource name.user
is not a valid key; the API does not support quota policies that apply only to a specific user.- 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. - If any valid key other than
region
orzone
appears in the map, then all valid keys other thanregion
orzone
must also appear in the map.
map<string, string> dimensions = 3;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
setContainer(String value)
public ProducerQuotaPolicy.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 | String The container to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setContainerBytes(ByteString value)
public ProducerQuotaPolicy.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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for container to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ProducerQuotaPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
setMetric(String value)
public ProducerQuotaPolicy.Builder setMetric(String value)
The name of the metric to which this policy applies.
An example name would be:
compute.googleapis.com/cpus
string metric = 4;
Parameter | |
---|---|
Name | Description |
value | String The metric to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setMetricBytes(ByteString value)
public ProducerQuotaPolicy.Builder setMetricBytes(ByteString value)
The name of the metric to which this policy applies.
An example name would be:
compute.googleapis.com/cpus
string metric = 4;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for metric to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setName(String value)
public ProducerQuotaPolicy.Builder setName(String value)
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/producerQuotaPolicies/4a3f2c1d
string name = 1;
Parameter | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public ProducerQuotaPolicy.Builder setNameBytes(ByteString value)
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/producerQuotaPolicies/4a3f2c1d
string name = 1;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setPolicyValue(long value)
public ProducerQuotaPolicy.Builder setPolicyValue(long value)
The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
int64 policy_value = 2;
Parameter | |
---|---|
Name | Description |
value | long The policyValue to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ProducerQuotaPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |
setUnit(String value)
public ProducerQuotaPolicy.Builder setUnit(String value)
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;
Parameter | |
---|---|
Name | Description |
value | String The unit to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setUnitBytes(ByteString value)
public ProducerQuotaPolicy.Builder setUnitBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for unit to set. |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ProducerQuotaPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ProducerQuotaPolicy.Builder |