Package com.google.rpc
Class QuotaFailure.Violation
java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<QuotaFailure.Violation,QuotaFailure.Violation.Builder>
com.google.rpc.QuotaFailure.Violation
- All Implemented Interfaces:
com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,QuotaFailure.ViolationOrBuilder
- Enclosing class:
- QuotaFailure
public static final class QuotaFailure.Violation
extends com.google.protobuf.GeneratedMessageLite<QuotaFailure.Violation,QuotaFailure.Violation.Builder>
implements QuotaFailure.ViolationOrBuilder
A 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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A message type used to describe a single quota violation.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,
?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite, Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageLite
unknownFields
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
The dimensions of the violated quota.protected final Object
dynamicMethod
(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) The API Service from which the `QuotaFailure.Violation` orginates.com.google.protobuf.ByteString
The API Service from which the `QuotaFailure.Violation` orginates.static QuotaFailure.Violation
A description of how the quota check failed.com.google.protobuf.ByteString
A description of how the quota check failed.long
The new quota value being rolled out at the time of the violation.Deprecated.int
The dimensions of the violated quota.The dimensions of the violated quota.getQuotaDimensionsOrDefault
(String key, String defaultValue) The dimensions of the violated quota.The dimensions of the violated quota.The id of the violated quota.com.google.protobuf.ByteString
The id of the violated quota.The metric of the violated quota.com.google.protobuf.ByteString
The metric of the violated quota.long
The enforced quota value at the time of the `QuotaFailure`.The subject on which the quota check failed.com.google.protobuf.ByteString
The subject on which the quota check failed.boolean
The new quota value being rolled out at the time of the violation.newBuilder
(QuotaFailure.Violation prototype) static QuotaFailure.Violation
parseDelimitedFrom
(InputStream input) static QuotaFailure.Violation
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QuotaFailure.Violation
parseFrom
(byte[] data) static QuotaFailure.Violation
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QuotaFailure.Violation
parseFrom
(com.google.protobuf.ByteString data) static QuotaFailure.Violation
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QuotaFailure.Violation
parseFrom
(com.google.protobuf.CodedInputStream input) static QuotaFailure.Violation
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QuotaFailure.Violation
parseFrom
(InputStream input) static QuotaFailure.Violation
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QuotaFailure.Violation
parseFrom
(ByteBuffer data) static QuotaFailure.Violation
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<QuotaFailure.Violation>
parser()
Methods inherited from class com.google.protobuf.GeneratedMessageLite
createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
SUBJECT_FIELD_NUMBER
public static final int SUBJECT_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
API_SERVICE_FIELD_NUMBER
public static final int API_SERVICE_FIELD_NUMBER- See Also:
-
QUOTA_METRIC_FIELD_NUMBER
public static final int QUOTA_METRIC_FIELD_NUMBER- See Also:
-
QUOTA_ID_FIELD_NUMBER
public static final int QUOTA_ID_FIELD_NUMBER- See Also:
-
QUOTA_DIMENSIONS_FIELD_NUMBER
public static final int QUOTA_DIMENSIONS_FIELD_NUMBER- See Also:
-
QUOTA_VALUE_FIELD_NUMBER
public static final int QUOTA_VALUE_FIELD_NUMBER- See Also:
-
FUTURE_QUOTA_VALUE_FIELD_NUMBER
public static final int FUTURE_QUOTA_VALUE_FIELD_NUMBER- See Also:
-
-
Method Details
-
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 [json_name = "subject"];
- Specified by:
getSubject
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The subject.
-
getSubjectBytes
public com.google.protobuf.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 [json_name = "subject"];
- Specified by:
getSubjectBytes
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The bytes for subject.
-
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 [json_name = "description"];
- Specified by:
getDescription
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.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 [json_name = "description"];
- Specified by:
getDescriptionBytes
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The bytes for description.
-
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 [json_name = "apiService"];
- Specified by:
getApiService
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The apiService.
-
getApiServiceBytes
public com.google.protobuf.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 [json_name = "apiService"];
- Specified by:
getApiServiceBytes
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The bytes for apiService.
-
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 [json_name = "quotaMetric"];
- Specified by:
getQuotaMetric
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The quotaMetric.
-
getQuotaMetricBytes
public com.google.protobuf.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 [json_name = "quotaMetric"];
- Specified by:
getQuotaMetricBytes
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The bytes for quotaMetric.
-
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 [json_name = "quotaId"];
- Specified by:
getQuotaId
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The quotaId.
-
getQuotaIdBytes
public com.google.protobuf.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 [json_name = "quotaId"];
- Specified by:
getQuotaIdBytes
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The bytes for quotaId.
-
getQuotaDimensionsCount
public int getQuotaDimensionsCount()Description copied from interface:QuotaFailure.ViolationOrBuilder
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 [json_name = "quotaDimensions"];
- Specified by:
getQuotaDimensionsCount
in interfaceQuotaFailure.ViolationOrBuilder
-
containsQuotaDimensions
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 [json_name = "quotaDimensions"];
- Specified by:
containsQuotaDimensions
in interfaceQuotaFailure.ViolationOrBuilder
-
getQuotaDimensions
Deprecated.UsegetQuotaDimensionsMap()
instead.- Specified by:
getQuotaDimensions
in interfaceQuotaFailure.ViolationOrBuilder
-
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 [json_name = "quotaDimensions"];
- Specified by:
getQuotaDimensionsMap
in interfaceQuotaFailure.ViolationOrBuilder
-
getQuotaDimensionsOrDefault
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 [json_name = "quotaDimensions"];
- Specified by:
getQuotaDimensionsOrDefault
in interfaceQuotaFailure.ViolationOrBuilder
-
getQuotaDimensionsOrThrow
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 [json_name = "quotaDimensions"];
- Specified by:
getQuotaDimensionsOrThrow
in interfaceQuotaFailure.ViolationOrBuilder
-
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 [json_name = "quotaValue"];
- Specified by:
getQuotaValue
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The quotaValue.
-
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 [json_name = "futureQuotaValue"];
- Specified by:
hasFutureQuotaValue
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- Whether the futureQuotaValue field is set.
-
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 [json_name = "futureQuotaValue"];
- Specified by:
getFutureQuotaValue
in interfaceQuotaFailure.ViolationOrBuilder
- Returns:
- The futureQuotaValue.
-
parseFrom
public static QuotaFailure.Violation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaFailure.Violation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaFailure.Violation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaFailure.Violation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaFailure.Violation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QuotaFailure.Violation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static QuotaFailure.Violation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static QuotaFailure.Violation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static QuotaFailure.Violation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static QuotaFailure.Violation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) - Specified by:
dynamicMethod
in classcom.google.protobuf.GeneratedMessageLite<QuotaFailure.Violation,
QuotaFailure.Violation.Builder>
-
getDefaultInstance
-
parser
-