- 2.58.0 (latest)
- 2.57.0
- 2.56.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.1
- 2.49.0
- 2.48.0
- 2.46.0
- 2.45.1
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.1
- 2.38.0
- 2.37.1
- 2.36.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.1
- 2.24.0
- 2.23.1
- 2.22.1
- 2.21.1
- 2.15.0
- 2.14.3
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.6
- 2.8.4
- 2.7.4
public static final class QuotaFailure.Violation.Builder extends GeneratedMessageV3.Builder<QuotaFailure.Violation.Builder> implements QuotaFailure.ViolationOrBuilderA message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
Protobuf type google.rpc.QuotaFailure.Violation
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > QuotaFailure.Violation.BuilderImplements
QuotaFailure.ViolationOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public QuotaFailure.Violation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
build()
public QuotaFailure.Violation build()| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation |
|
buildPartial()
public QuotaFailure.Violation buildPartial()| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation |
|
clear()
public QuotaFailure.Violation.Builder clear()| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
clearApiService()
public QuotaFailure.Violation.Builder clearApiService() The API Service from which the QuotaFailure.Violation orginates. In
some cases, Quota issues originate from an API Service other than the one
that was called. In other words, a dependency of the called API Service
could be the cause of the QuotaFailure, and this field would have the
dependency API service name.
For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
string api_service = 3;
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
clearDescription()
public QuotaFailure.Violation.Builder clearDescription()A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
For example: "Service disabled" or "Daily Limit for read operations exceeded".
string description = 2;
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public QuotaFailure.Violation.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
clearFutureQuotaValue()
public QuotaFailure.Violation.Builder clearFutureQuotaValue()The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
optional int64 future_quota_value = 8;
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public QuotaFailure.Violation.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
clearQuotaDimensions()
public QuotaFailure.Violation.Builder clearQuotaDimensions()| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
clearQuotaId()
public QuotaFailure.Violation.Builder clearQuotaId()The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
For example, "CPUS-PER-VM-FAMILY-per-project-region".
string quota_id = 5;
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
clearQuotaMetric()
public QuotaFailure.Violation.Builder clearQuotaMetric()The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
string quota_metric = 4;
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
clearQuotaValue()
public QuotaFailure.Violation.Builder clearQuotaValue() The enforced quota value at the time of the QuotaFailure.
For example, if the enforced quota value at the time of the
QuotaFailure on the number of CPUs is "10", then the value of this
field would reflect this quantity.
int64 quota_value = 7;
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
clearSubject()
public QuotaFailure.Violation.Builder clearSubject()The subject on which the quota check failed. For example, "clientip:<ip address of client>" or "project:<Google developer project id>".
string subject = 1;
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
clone()
public QuotaFailure.Violation.Builder clone()| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
containsQuotaDimensions(String key)
public boolean containsQuotaDimensions(String key)The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
{ "region": "us-central1", "vm_family": "n1", }
When a quota is enforced globally, the quota_dimensions would always be empty.
map<string, string> quota_dimensions = 6;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getApiService()
public String getApiService() The API Service from which the QuotaFailure.Violation orginates. In
some cases, Quota issues originate from an API Service other than the one
that was called. In other words, a dependency of the called API Service
could be the cause of the QuotaFailure, and this field would have the
dependency API service name.
For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
string api_service = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The apiService. |
getApiServiceBytes()
public ByteString getApiServiceBytes() The API Service from which the QuotaFailure.Violation orginates. In
some cases, Quota issues originate from an API Service other than the one
that was called. In other words, a dependency of the called API Service
could be the cause of the QuotaFailure, and this field would have the
dependency API service name.
For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
string api_service = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for apiService. |
getDefaultInstanceForType()
public QuotaFailure.Violation getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation |
|
getDescription()
public String getDescription()A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
For example: "Service disabled" or "Daily Limit for read operations exceeded".
string description = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
For example: "Service disabled" or "Daily Limit for read operations exceeded".
string description = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFutureQuotaValue()
public long getFutureQuotaValue()The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
optional int64 future_quota_value = 8;
| Returns | |
|---|---|
| Type | Description |
long |
The futureQuotaValue. |
getMutableQuotaDimensions() (deprecated)
public Map<String,String> getMutableQuotaDimensions()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getQuotaDimensions() (deprecated)
public Map<String,String> getQuotaDimensions()Use #getQuotaDimensionsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getQuotaDimensionsCount()
public int getQuotaDimensionsCount()The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
{ "region": "us-central1", "vm_family": "n1", }
When a quota is enforced globally, the quota_dimensions would always be empty.
map<string, string> quota_dimensions = 6;
| Returns | |
|---|---|
| Type | Description |
int |
|
getQuotaDimensionsMap()
public Map<String,String> getQuotaDimensionsMap()The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
{ "region": "us-central1", "vm_family": "n1", }
When a quota is enforced globally, the quota_dimensions would always be empty.
map<string, string> quota_dimensions = 6;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getQuotaDimensionsOrDefault(String key, String defaultValue)
public String getQuotaDimensionsOrDefault(String key, String defaultValue)The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
{ "region": "us-central1", "vm_family": "n1", }
When a quota is enforced globally, the quota_dimensions would always be empty.
map<string, string> quota_dimensions = 6;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getQuotaDimensionsOrThrow(String key)
public String getQuotaDimensionsOrThrow(String key)The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
{ "region": "us-central1", "vm_family": "n1", }
When a quota is enforced globally, the quota_dimensions would always be empty.
map<string, string> quota_dimensions = 6;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getQuotaId()
public String getQuotaId()The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
For example, "CPUS-PER-VM-FAMILY-per-project-region".
string quota_id = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The quotaId. |
getQuotaIdBytes()
public ByteString getQuotaIdBytes()The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
For example, "CPUS-PER-VM-FAMILY-per-project-region".
string quota_id = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for quotaId. |
getQuotaMetric()
public String getQuotaMetric()The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
string quota_metric = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The quotaMetric. |
getQuotaMetricBytes()
public ByteString getQuotaMetricBytes()The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
string quota_metric = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for quotaMetric. |
getQuotaValue()
public long getQuotaValue() The enforced quota value at the time of the QuotaFailure.
For example, if the enforced quota value at the time of the
QuotaFailure on the number of CPUs is "10", then the value of this
field would reflect this quantity.
int64 quota_value = 7;
| Returns | |
|---|---|
| Type | Description |
long |
The quotaValue. |
getSubject()
public String getSubject()The subject on which the quota check failed. For example, "clientip:<ip address of client>" or "project:<Google developer project id>".
string subject = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The subject. |
getSubjectBytes()
public ByteString getSubjectBytes()The subject on which the quota check failed. For example, "clientip:<ip address of client>" or "project:<Google developer project id>".
string subject = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for subject. |
hasFutureQuotaValue()
public boolean hasFutureQuotaValue()The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
optional int64 future_quota_value = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the futureQuotaValue field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public QuotaFailure.Violation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public QuotaFailure.Violation.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
mergeFrom(QuotaFailure.Violation other)
public QuotaFailure.Violation.Builder mergeFrom(QuotaFailure.Violation other)| Parameter | |
|---|---|
| Name | Description |
other |
QuotaFailure.Violation |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final QuotaFailure.Violation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
putAllQuotaDimensions(Map<String,String> values)
public QuotaFailure.Violation.Builder putAllQuotaDimensions(Map<String,String> values)The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
{ "region": "us-central1", "vm_family": "n1", }
When a quota is enforced globally, the quota_dimensions would always be empty.
map<string, string> quota_dimensions = 6;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
putQuotaDimensions(String key, String value)
public QuotaFailure.Violation.Builder putQuotaDimensions(String key, String value)The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
{ "region": "us-central1", "vm_family": "n1", }
When a quota is enforced globally, the quota_dimensions would always be empty.
map<string, string> quota_dimensions = 6;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
removeQuotaDimensions(String key)
public QuotaFailure.Violation.Builder removeQuotaDimensions(String key)The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased.
For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be,
{ "region": "us-central1", "vm_family": "n1", }
When a quota is enforced globally, the quota_dimensions would always be empty.
map<string, string> quota_dimensions = 6;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
setApiService(String value)
public QuotaFailure.Violation.Builder setApiService(String value) The API Service from which the QuotaFailure.Violation orginates. In
some cases, Quota issues originate from an API Service other than the one
that was called. In other words, a dependency of the called API Service
could be the cause of the QuotaFailure, and this field would have the
dependency API service name.
For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
string api_service = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe apiService to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setApiServiceBytes(ByteString value)
public QuotaFailure.Violation.Builder setApiServiceBytes(ByteString value) The API Service from which the QuotaFailure.Violation orginates. In
some cases, Quota issues originate from an API Service other than the one
that was called. In other words, a dependency of the called API Service
could be the cause of the QuotaFailure, and this field would have the
dependency API service name.
For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
string api_service = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for apiService to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setDescription(String value)
public QuotaFailure.Violation.Builder setDescription(String value)A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
For example: "Service disabled" or "Daily Limit for read operations exceeded".
string description = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public QuotaFailure.Violation.Builder setDescriptionBytes(ByteString value)A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
For example: "Service disabled" or "Daily Limit for read operations exceeded".
string description = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public QuotaFailure.Violation.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
setFutureQuotaValue(long value)
public QuotaFailure.Violation.Builder setFutureQuotaValue(long value)The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set.
For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
optional int64 future_quota_value = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe futureQuotaValue to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setQuotaId(String value)
public QuotaFailure.Violation.Builder setQuotaId(String value)The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
For example, "CPUS-PER-VM-FAMILY-per-project-region".
string quota_id = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe quotaId to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setQuotaIdBytes(ByteString value)
public QuotaFailure.Violation.Builder setQuotaIdBytes(ByteString value)The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service.
For example, "CPUS-PER-VM-FAMILY-per-project-region".
string quota_id = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for quotaId to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setQuotaMetric(String value)
public QuotaFailure.Violation.Builder setQuotaMetric(String value)The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
string quota_metric = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe quotaMetric to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setQuotaMetricBytes(ByteString value)
public QuotaFailure.Violation.Builder setQuotaMetricBytes(ByteString value)The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected.
For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
string quota_metric = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for quotaMetric to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setQuotaValue(long value)
public QuotaFailure.Violation.Builder setQuotaValue(long value) The enforced quota value at the time of the QuotaFailure.
For example, if the enforced quota value at the time of the
QuotaFailure on the number of CPUs is "10", then the value of this
field would reflect this quantity.
int64 quota_value = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe quotaValue to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public QuotaFailure.Violation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|
setSubject(String value)
public QuotaFailure.Violation.Builder setSubject(String value)The subject on which the quota check failed. For example, "clientip:<ip address of client>" or "project:<Google developer project id>".
string subject = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe subject to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setSubjectBytes(ByteString value)
public QuotaFailure.Violation.Builder setSubjectBytes(ByteString value)The subject on which the quota check failed. For example, "clientip:<ip address of client>" or "project:<Google developer project id>".
string subject = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for subject to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final QuotaFailure.Violation.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
QuotaFailure.Violation.Builder |
|