Package com.google.rpc

Class QuotaFailure.Violation.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<QuotaFailure.Violation,QuotaFailure.Violation.Builder>
com.google.rpc.QuotaFailure.Violation.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, QuotaFailure.ViolationOrBuilder, Cloneable
Enclosing class:
QuotaFailure.Violation
public static final class QuotaFailure.Violation.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<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

  • Method Details

    • 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 [json_name = "subject"];
      Specified by:
      getSubject in interface QuotaFailure.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 interface QuotaFailure.ViolationOrBuilder
      Returns:
      The bytes for subject.

    • setSubject

      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 [json_name = "subject"];
      Parameters:
      value - The subject to set.
      Returns:
      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 [json_name = "subject"];
      Returns:
      This builder for chaining.

    • setSubjectBytes

      public QuotaFailure.Violation.Builder setSubjectBytes(com.google.protobuf.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 [json_name = "subject"];
      Parameters:
      value - The bytes for subject to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "description"];
      Specified by:
      getDescription in interface QuotaFailure.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 interface QuotaFailure.ViolationOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      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 [json_name = "description"];
      Parameters:
      value - The description to set.
      Returns:
      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 [json_name = "description"];
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public QuotaFailure.Violation.Builder setDescriptionBytes(com.google.protobuf.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 [json_name = "description"];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "apiService"];
      Specified by:
      getApiService in interface QuotaFailure.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 interface QuotaFailure.ViolationOrBuilder
      Returns:
      The bytes for apiService.

    • setApiService

      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 [json_name = "apiService"];
      Parameters:
      value - The apiService to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "apiService"];
      Returns:
      This builder for chaining.

    • setApiServiceBytes

      public QuotaFailure.Violation.Builder setApiServiceBytes(com.google.protobuf.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 [json_name = "apiService"];
      Parameters:
      value - The bytes for apiService to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "quotaMetric"];
      Specified by:
      getQuotaMetric in interface QuotaFailure.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 interface QuotaFailure.ViolationOrBuilder
      Returns:
      The bytes for quotaMetric.

    • setQuotaMetric

      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 [json_name = "quotaMetric"];
      Parameters:
      value - The quotaMetric to set.
      Returns:
      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 [json_name = "quotaMetric"];
      Returns:
      This builder for chaining.

    • setQuotaMetricBytes

      public QuotaFailure.Violation.Builder setQuotaMetricBytes(com.google.protobuf.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 [json_name = "quotaMetric"];
      Parameters:
      value - The bytes for quotaMetric to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "quotaId"];
      Specified by:
      getQuotaId in interface QuotaFailure.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 interface QuotaFailure.ViolationOrBuilder
      Returns:
      The bytes for quotaId.

    • setQuotaId

      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 [json_name = "quotaId"];
      Parameters:
      value - The quotaId to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "quotaId"];
      Returns:
      This builder for chaining.

    • setQuotaIdBytes

      public QuotaFailure.Violation.Builder setQuotaIdBytes(com.google.protobuf.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 [json_name = "quotaId"];
      Parameters:
      value - The bytes for quotaId to set.
      Returns:
      This builder for chaining.

    • 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 interface QuotaFailure.ViolationOrBuilder

    • containsQuotaDimensions

      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 [json_name = "quotaDimensions"];
      Specified by:
      containsQuotaDimensions in interface QuotaFailure.ViolationOrBuilder

    • clearQuotaDimensions

      public QuotaFailure.Violation.Builder clearQuotaDimensions()

    • removeQuotaDimensions

      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 [json_name = "quotaDimensions"];

    • getQuotaDimensions

      @Deprecated public Map<String,String> getQuotaDimensions()
      Deprecated.
      Use getQuotaDimensionsMap() instead.
      Specified by:
      getQuotaDimensions in interface QuotaFailure.ViolationOrBuilder

    • 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 [json_name = "quotaDimensions"];
      Specified by:
      getQuotaDimensionsMap in interface QuotaFailure.ViolationOrBuilder

    • getQuotaDimensionsOrDefault

      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 [json_name = "quotaDimensions"];
      Specified by:
      getQuotaDimensionsOrDefault in interface QuotaFailure.ViolationOrBuilder

    • getQuotaDimensionsOrThrow

      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 [json_name = "quotaDimensions"];
      Specified by:
      getQuotaDimensionsOrThrow in interface QuotaFailure.ViolationOrBuilder

    • putQuotaDimensions

      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 [json_name = "quotaDimensions"];

    • putAllQuotaDimensions

      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 [json_name = "quotaDimensions"];

    • 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 interface QuotaFailure.ViolationOrBuilder
      Returns:
      The quotaValue.

    • setQuotaValue

      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 [json_name = "quotaValue"];
      Parameters:
      value - The quotaValue to set.
      Returns:
      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 [json_name = "quotaValue"];
      Returns:
      This builder for chaining.

    • 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 interface QuotaFailure.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 interface QuotaFailure.ViolationOrBuilder
      Returns:
      The futureQuotaValue.

    • setFutureQuotaValue

      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 [json_name = "futureQuotaValue"];
      Parameters:
      value - The futureQuotaValue to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "futureQuotaValue"];
      Returns:
      This builder for chaining.