Package com.google.api

Class QuotaLimit.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<QuotaLimit.Builder>
com.google.api.QuotaLimit.Builder
All Implemented Interfaces:
QuotaLimitOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
QuotaLimit
public static final class QuotaLimit.Builder extends com.google.protobuf.GeneratedMessage.Builder<QuotaLimit.Builder> implements QuotaLimitOrBuilder
 `QuotaLimit` defines a specific limit that applies over a specified duration
 for a limit type. There can be at most one limit for a duration and limit
 type combination defined within a `QuotaGroup`.
Protobuf type google.api.QuotaLimit

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<QuotaLimit.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<QuotaLimit.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<QuotaLimit.Builder>

    • clear

      public QuotaLimit.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<QuotaLimit.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<QuotaLimit.Builder>

    • getDefaultInstanceForType

      public QuotaLimit getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public QuotaLimit build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public QuotaLimit buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public QuotaLimit.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QuotaLimit.Builder>

    • mergeFrom

      public QuotaLimit.Builder mergeFrom(QuotaLimit other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<QuotaLimit.Builder>

    • mergeFrom

      public QuotaLimit.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QuotaLimit.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       Name of the quota limit.

 The name must be provided, and it must be unique within the service. The
 name can only include alphanumeric characters as well as '-'.

 The maximum length of the limit name is 64 characters.
      string name = 6;
      Specified by:
      getName in interface QuotaLimitOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of the quota limit.

 The name must be provided, and it must be unique within the service. The
 name can only include alphanumeric characters as well as '-'.

 The maximum length of the limit name is 64 characters.
      string name = 6;
      Specified by:
      getNameBytes in interface QuotaLimitOrBuilder
      Returns:
      The bytes for name.

    • setName

      public QuotaLimit.Builder setName(String value)
       Name of the quota limit.

 The name must be provided, and it must be unique within the service. The
 name can only include alphanumeric characters as well as '-'.

 The maximum length of the limit name is 64 characters.
      string name = 6;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public QuotaLimit.Builder clearName()
       Name of the quota limit.

 The name must be provided, and it must be unique within the service. The
 name can only include alphanumeric characters as well as '-'.

 The maximum length of the limit name is 64 characters.
      string name = 6;
      Returns:
      This builder for chaining.

    • setNameBytes

      public QuotaLimit.Builder setNameBytes(com.google.protobuf.ByteString value)
       Name of the quota limit.

 The name must be provided, and it must be unique within the service. The
 name can only include alphanumeric characters as well as '-'.

 The maximum length of the limit name is 64 characters.
      string name = 6;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       Optional. User-visible, extended description for this quota limit.
 Should be used only when more context is needed to understand this limit
 than provided by the limit's display name (see: `display_name`).
      string description = 2;
      Specified by:
      getDescription in interface QuotaLimitOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. User-visible, extended description for this quota limit.
 Should be used only when more context is needed to understand this limit
 than provided by the limit's display name (see: `display_name`).
      string description = 2;
      Specified by:
      getDescriptionBytes in interface QuotaLimitOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public QuotaLimit.Builder setDescription(String value)
       Optional. User-visible, extended description for this quota limit.
 Should be used only when more context is needed to understand this limit
 than provided by the limit's display name (see: `display_name`).
      string description = 2;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public QuotaLimit.Builder clearDescription()
       Optional. User-visible, extended description for this quota limit.
 Should be used only when more context is needed to understand this limit
 than provided by the limit's display name (see: `display_name`).
      string description = 2;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public QuotaLimit.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Optional. User-visible, extended description for this quota limit.
 Should be used only when more context is needed to understand this limit
 than provided by the limit's display name (see: `display_name`).
      string description = 2;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • getDefaultLimit

      public long getDefaultLimit()
       Default number of tokens that can be consumed during the specified
 duration. This is the number of tokens assigned when a client
 application developer activates the service for his/her project.

 Specifying a value of 0 will block all requests. This can be used if you
 are provisioning quota to selected consumers and blocking others.
 Similarly, a value of -1 will indicate an unlimited quota. No other
 negative values are allowed.

 Used by group-based quotas only.
      int64 default_limit = 3;
      Specified by:
      getDefaultLimit in interface QuotaLimitOrBuilder
      Returns:
      The defaultLimit.

    • setDefaultLimit

      public QuotaLimit.Builder setDefaultLimit(long value)
       Default number of tokens that can be consumed during the specified
 duration. This is the number of tokens assigned when a client
 application developer activates the service for his/her project.

 Specifying a value of 0 will block all requests. This can be used if you
 are provisioning quota to selected consumers and blocking others.
 Similarly, a value of -1 will indicate an unlimited quota. No other
 negative values are allowed.

 Used by group-based quotas only.
      int64 default_limit = 3;
      Parameters:
      value - The defaultLimit to set.
      Returns:
      This builder for chaining.

    • clearDefaultLimit

      public QuotaLimit.Builder clearDefaultLimit()
       Default number of tokens that can be consumed during the specified
 duration. This is the number of tokens assigned when a client
 application developer activates the service for his/her project.

 Specifying a value of 0 will block all requests. This can be used if you
 are provisioning quota to selected consumers and blocking others.
 Similarly, a value of -1 will indicate an unlimited quota. No other
 negative values are allowed.

 Used by group-based quotas only.
      int64 default_limit = 3;
      Returns:
      This builder for chaining.

    • getMaxLimit

      public long getMaxLimit()
       Maximum number of tokens that can be consumed during the specified
 duration. Client application developers can override the default limit up
 to this maximum. If specified, this value cannot be set to a value less
 than the default limit. If not specified, it is set to the default limit.

 To allow clients to apply overrides with no upper bound, set this to -1,
 indicating unlimited maximum quota.

 Used by group-based quotas only.
      int64 max_limit = 4;
      Specified by:
      getMaxLimit in interface QuotaLimitOrBuilder
      Returns:
      The maxLimit.

    • setMaxLimit

      public QuotaLimit.Builder setMaxLimit(long value)
       Maximum number of tokens that can be consumed during the specified
 duration. Client application developers can override the default limit up
 to this maximum. If specified, this value cannot be set to a value less
 than the default limit. If not specified, it is set to the default limit.

 To allow clients to apply overrides with no upper bound, set this to -1,
 indicating unlimited maximum quota.

 Used by group-based quotas only.
      int64 max_limit = 4;
      Parameters:
      value - The maxLimit to set.
      Returns:
      This builder for chaining.

    • clearMaxLimit

      public QuotaLimit.Builder clearMaxLimit()
       Maximum number of tokens that can be consumed during the specified
 duration. Client application developers can override the default limit up
 to this maximum. If specified, this value cannot be set to a value less
 than the default limit. If not specified, it is set to the default limit.

 To allow clients to apply overrides with no upper bound, set this to -1,
 indicating unlimited maximum quota.

 Used by group-based quotas only.
      int64 max_limit = 4;
      Returns:
      This builder for chaining.

    • getFreeTier

      public long getFreeTier()
       Free tier value displayed in the Developers Console for this limit.
 The free tier is the number of tokens that will be subtracted from the
 billed amount when billing is enabled.
 This field can only be set on a limit with duration "1d", in a billable
 group; it is invalid on any other limit. If this field is not set, it
 defaults to 0, indicating that there is no free tier for this service.

 Used by group-based quotas only.
      int64 free_tier = 7;
      Specified by:
      getFreeTier in interface QuotaLimitOrBuilder
      Returns:
      The freeTier.

    • setFreeTier

      public QuotaLimit.Builder setFreeTier(long value)
       Free tier value displayed in the Developers Console for this limit.
 The free tier is the number of tokens that will be subtracted from the
 billed amount when billing is enabled.
 This field can only be set on a limit with duration "1d", in a billable
 group; it is invalid on any other limit. If this field is not set, it
 defaults to 0, indicating that there is no free tier for this service.

 Used by group-based quotas only.
      int64 free_tier = 7;
      Parameters:
      value - The freeTier to set.
      Returns:
      This builder for chaining.

    • clearFreeTier

      public QuotaLimit.Builder clearFreeTier()
       Free tier value displayed in the Developers Console for this limit.
 The free tier is the number of tokens that will be subtracted from the
 billed amount when billing is enabled.
 This field can only be set on a limit with duration "1d", in a billable
 group; it is invalid on any other limit. If this field is not set, it
 defaults to 0, indicating that there is no free tier for this service.

 Used by group-based quotas only.
      int64 free_tier = 7;
      Returns:
      This builder for chaining.

    • getDuration

      public String getDuration()
       Duration of this limit in textual notation. Must be "100s" or "1d".

 Used by group-based quotas only.
      string duration = 5;
      Specified by:
      getDuration in interface QuotaLimitOrBuilder
      Returns:
      The duration.

    • getDurationBytes

      public com.google.protobuf.ByteString getDurationBytes()
       Duration of this limit in textual notation. Must be "100s" or "1d".

 Used by group-based quotas only.
      string duration = 5;
      Specified by:
      getDurationBytes in interface QuotaLimitOrBuilder
      Returns:
      The bytes for duration.

    • setDuration

      public QuotaLimit.Builder setDuration(String value)
       Duration of this limit in textual notation. Must be "100s" or "1d".

 Used by group-based quotas only.
      string duration = 5;
      Parameters:
      value - The duration to set.
      Returns:
      This builder for chaining.

    • clearDuration

      public QuotaLimit.Builder clearDuration()
       Duration of this limit in textual notation. Must be "100s" or "1d".

 Used by group-based quotas only.
      string duration = 5;
      Returns:
      This builder for chaining.

    • setDurationBytes

      public QuotaLimit.Builder setDurationBytes(com.google.protobuf.ByteString value)
       Duration of this limit in textual notation. Must be "100s" or "1d".

 Used by group-based quotas only.
      string duration = 5;
      Parameters:
      value - The bytes for duration to set.
      Returns:
      This builder for chaining.

    • getMetric

      public String getMetric()
       The name of the metric this quota limit applies to. The quota limits with
 the same metric will be checked together during runtime. The metric must be
 defined within the service config.
      string metric = 8;
      Specified by:
      getMetric in interface QuotaLimitOrBuilder
      Returns:
      The metric.

    • getMetricBytes

      public com.google.protobuf.ByteString getMetricBytes()
       The name of the metric this quota limit applies to. The quota limits with
 the same metric will be checked together during runtime. The metric must be
 defined within the service config.
      string metric = 8;
      Specified by:
      getMetricBytes in interface QuotaLimitOrBuilder
      Returns:
      The bytes for metric.

    • setMetric

      public QuotaLimit.Builder setMetric(String value)
       The name of the metric this quota limit applies to. The quota limits with
 the same metric will be checked together during runtime. The metric must be
 defined within the service config.
      string metric = 8;
      Parameters:
      value - The metric to set.
      Returns:
      This builder for chaining.

    • clearMetric

      public QuotaLimit.Builder clearMetric()
       The name of the metric this quota limit applies to. The quota limits with
 the same metric will be checked together during runtime. The metric must be
 defined within the service config.
      string metric = 8;
      Returns:
      This builder for chaining.

    • setMetricBytes

      public QuotaLimit.Builder setMetricBytes(com.google.protobuf.ByteString value)
       The name of the metric this quota limit applies to. The quota limits with
 the same metric will be checked together during runtime. The metric must be
 defined within the service config.
      string metric = 8;
      Parameters:
      value - The bytes for metric to set.
      Returns:
      This builder for chaining.

    • getUnit

      public String getUnit()
       Specify the unit of the quota limit. It uses the same syntax as
 [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported
 unit kinds are determined by the quota backend system.

 Here are some examples:
 * "1/min/{project}" for quota per minute per project.

 Note: the order of unit components is insignificant.
 The "1" at the beginning is required to follow the metric unit syntax.
      string unit = 9;
      Specified by:
      getUnit in interface QuotaLimitOrBuilder
      Returns:
      The unit.

    • getUnitBytes

      public com.google.protobuf.ByteString getUnitBytes()
       Specify the unit of the quota limit. It uses the same syntax as
 [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported
 unit kinds are determined by the quota backend system.

 Here are some examples:
 * "1/min/{project}" for quota per minute per project.

 Note: the order of unit components is insignificant.
 The "1" at the beginning is required to follow the metric unit syntax.
      string unit = 9;
      Specified by:
      getUnitBytes in interface QuotaLimitOrBuilder
      Returns:
      The bytes for unit.

    • setUnit

      public QuotaLimit.Builder setUnit(String value)
       Specify the unit of the quota limit. It uses the same syntax as
 [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported
 unit kinds are determined by the quota backend system.

 Here are some examples:
 * "1/min/{project}" for quota per minute per project.

 Note: the order of unit components is insignificant.
 The "1" at the beginning is required to follow the metric unit syntax.
      string unit = 9;
      Parameters:
      value - The unit to set.
      Returns:
      This builder for chaining.

    • clearUnit

      public QuotaLimit.Builder clearUnit()
       Specify the unit of the quota limit. It uses the same syntax as
 [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported
 unit kinds are determined by the quota backend system.

 Here are some examples:
 * "1/min/{project}" for quota per minute per project.

 Note: the order of unit components is insignificant.
 The "1" at the beginning is required to follow the metric unit syntax.
      string unit = 9;
      Returns:
      This builder for chaining.

    • setUnitBytes

      public QuotaLimit.Builder setUnitBytes(com.google.protobuf.ByteString value)
       Specify the unit of the quota limit. It uses the same syntax as
 [MetricDescriptor.unit][google.api.MetricDescriptor.unit]. The supported
 unit kinds are determined by the quota backend system.

 Here are some examples:
 * "1/min/{project}" for quota per minute per project.

 Note: the order of unit components is insignificant.
 The "1" at the beginning is required to follow the metric unit syntax.
      string unit = 9;
      Parameters:
      value - The bytes for unit to set.
      Returns:
      This builder for chaining.

    • getValuesCount

      public int getValuesCount()
      Description copied from interface: QuotaLimitOrBuilder
       Tiered limit values. You must specify this as a key:value pair, with an
 integer value that is the maximum number of requests allowed for the
 specified unit. Currently only STANDARD is supported.
      map<string, int64> values = 10;
      Specified by:
      getValuesCount in interface QuotaLimitOrBuilder

    • containsValues

      public boolean containsValues(String key)
       Tiered limit values. You must specify this as a key:value pair, with an
 integer value that is the maximum number of requests allowed for the
 specified unit. Currently only STANDARD is supported.
      map<string, int64> values = 10;
      Specified by:
      containsValues in interface QuotaLimitOrBuilder

    • getValues

      @Deprecated public Map<String,Long> getValues()
      Deprecated.
      Use getValuesMap() instead.
      Specified by:
      getValues in interface QuotaLimitOrBuilder

    • getValuesMap

      public Map<String,Long> getValuesMap()
       Tiered limit values. You must specify this as a key:value pair, with an
 integer value that is the maximum number of requests allowed for the
 specified unit. Currently only STANDARD is supported.
      map<string, int64> values = 10;
      Specified by:
      getValuesMap in interface QuotaLimitOrBuilder

    • getValuesOrDefault

      public long getValuesOrDefault(String key, long defaultValue)
       Tiered limit values. You must specify this as a key:value pair, with an
 integer value that is the maximum number of requests allowed for the
 specified unit. Currently only STANDARD is supported.
      map<string, int64> values = 10;
      Specified by:
      getValuesOrDefault in interface QuotaLimitOrBuilder

    • getValuesOrThrow

      public long getValuesOrThrow(String key)
       Tiered limit values. You must specify this as a key:value pair, with an
 integer value that is the maximum number of requests allowed for the
 specified unit. Currently only STANDARD is supported.
      map<string, int64> values = 10;
      Specified by:
      getValuesOrThrow in interface QuotaLimitOrBuilder

    • clearValues

      public QuotaLimit.Builder clearValues()

    • removeValues

      public QuotaLimit.Builder removeValues(String key)
       Tiered limit values. You must specify this as a key:value pair, with an
 integer value that is the maximum number of requests allowed for the
 specified unit. Currently only STANDARD is supported.
      map<string, int64> values = 10;

    • getMutableValues

      @Deprecated public Map<String,Long> getMutableValues()
      Deprecated.
      Use alternate mutation accessors instead.

    • putValues

      public QuotaLimit.Builder putValues(String key, long value)
       Tiered limit values. You must specify this as a key:value pair, with an
 integer value that is the maximum number of requests allowed for the
 specified unit. Currently only STANDARD is supported.
      map<string, int64> values = 10;

    • putAllValues

      public QuotaLimit.Builder putAllValues(Map<String,Long> values)
       Tiered limit values. You must specify this as a key:value pair, with an
 integer value that is the maximum number of requests allowed for the
 specified unit. Currently only STANDARD is supported.
      map<string, int64> values = 10;

    • getDisplayName

      public String getDisplayName()
       User-visible display name for this limit.
 Optional. If not set, the UI will provide a default display name based on
 the quota configuration. This field can be used to override the default
 display name generated from the configuration.
      string display_name = 12;
      Specified by:
      getDisplayName in interface QuotaLimitOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       User-visible display name for this limit.
 Optional. If not set, the UI will provide a default display name based on
 the quota configuration. This field can be used to override the default
 display name generated from the configuration.
      string display_name = 12;
      Specified by:
      getDisplayNameBytes in interface QuotaLimitOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public QuotaLimit.Builder setDisplayName(String value)
       User-visible display name for this limit.
 Optional. If not set, the UI will provide a default display name based on
 the quota configuration. This field can be used to override the default
 display name generated from the configuration.
      string display_name = 12;
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public QuotaLimit.Builder clearDisplayName()
       User-visible display name for this limit.
 Optional. If not set, the UI will provide a default display name based on
 the quota configuration. This field can be used to override the default
 display name generated from the configuration.
      string display_name = 12;
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public QuotaLimit.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       User-visible display name for this limit.
 Optional. If not set, the UI will provide a default display name based on
 the quota configuration. This field can be used to override the default
 display name generated from the configuration.
      string display_name = 12;
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.