Package com.google.api.serviceusage.v1beta1

Class ProducerQuotaPolicy.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ProducerQuotaPolicy.Builder>
com.google.api.serviceusage.v1beta1.ProducerQuotaPolicy.Builder
All Implemented Interfaces:
ProducerQuotaPolicyOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ProducerQuotaPolicy
public static final class ProducerQuotaPolicy.Builder extends com.google.protobuf.GeneratedMessage.Builder<ProducerQuotaPolicy.Builder> implements ProducerQuotaPolicyOrBuilder
 Quota policy created by service producer.
Protobuf type google.api.serviceusage.v1beta1.ProducerQuotaPolicy

  • 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<ProducerQuotaPolicy.Builder>

    • internalGetMutableMapFieldReflection

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

    • internalGetFieldAccessorTable

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

    • clear

      public ProducerQuotaPolicy.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<ProducerQuotaPolicy.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<ProducerQuotaPolicy.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ProducerQuotaPolicy.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<ProducerQuotaPolicy.Builder>

    • mergeFrom

      public ProducerQuotaPolicy.Builder mergeFrom(ProducerQuotaPolicy other)

    • isInitialized

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

    • mergeFrom

      public ProducerQuotaPolicy.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<ProducerQuotaPolicy.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       The resource name of the policy.
 This name is generated by the server when the policy is created.

 Example names would be:
 `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
      string name = 1;
      Specified by:
      getName in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the policy.
 This name is generated by the server when the policy is created.

 Example names would be:
 `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
      string name = 1;
      Specified by:
      getNameBytes in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The bytes for name.

    • setName

      public ProducerQuotaPolicy.Builder setName(String value)
       The resource name of the policy.
 This name is generated by the server when the policy is created.

 Example names would be:
 `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
      string name = 1;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public ProducerQuotaPolicy.Builder clearName()
       The resource name of the policy.
 This name is generated by the server when the policy is created.

 Example names would be:
 `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
      string name = 1;
      Returns:
      This builder for chaining.

    • setNameBytes

      public ProducerQuotaPolicy.Builder setNameBytes(com.google.protobuf.ByteString value)
       The resource name of the policy.
 This name is generated by the server when the policy is created.

 Example names would be:
 `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d`
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getPolicyValue

      public long getPolicyValue()
       The quota policy value.
 Can be any nonnegative integer, or -1 (unlimited quota).
      int64 policy_value = 2;
      Specified by:
      getPolicyValue in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The policyValue.

    • setPolicyValue

      public ProducerQuotaPolicy.Builder setPolicyValue(long value)
       The quota policy value.
 Can be any nonnegative integer, or -1 (unlimited quota).
      int64 policy_value = 2;
      Parameters:
      value - The policyValue to set.
      Returns:
      This builder for chaining.

    • clearPolicyValue

      public ProducerQuotaPolicy.Builder clearPolicyValue()
       The quota policy value.
 Can be any nonnegative integer, or -1 (unlimited quota).
      int64 policy_value = 2;
      Returns:
      This builder for chaining.

    • getDimensionsCount

      public int getDimensionsCount()
      Description copied from interface: ProducerQuotaPolicyOrBuilder
      
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, a policy on a limit with the unit `1/{project}/{region}`
 could contain an entry with the key `region` and the value `us-east-1`;
 the policy is only applied to quota consumed in that region.

 This map has the following restrictions:

 *   Keys that are not defined in the limit's unit are not valid keys.
 Any string appearing in {brackets} in the unit (besides {project} or
 {user}) is a defined key.
 *   `project` is not a valid key; the project is already specified in
 the parent resource name.
 *   `user` is not a valid key; the API does not support quota policies
 that apply only to a specific user.
 *   If `region` appears as a key, its value must be a valid Cloud region.
 *   If `zone` appears as a key, its value must be a valid Cloud zone.
 *   If any valid key other than `region` or `zone` appears in the map, then
 all valid keys other than `region` or `zone` must also appear in the
 map.
      map<string, string> dimensions = 3;
      Specified by:
      getDimensionsCount in interface ProducerQuotaPolicyOrBuilder

    • containsDimensions

      public boolean containsDimensions(String key)
      
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, a policy on a limit with the unit `1/{project}/{region}`
 could contain an entry with the key `region` and the value `us-east-1`;
 the policy is only applied to quota consumed in that region.

 This map has the following restrictions:

 *   Keys that are not defined in the limit's unit are not valid keys.
 Any string appearing in {brackets} in the unit (besides {project} or
 {user}) is a defined key.
 *   `project` is not a valid key; the project is already specified in
 the parent resource name.
 *   `user` is not a valid key; the API does not support quota policies
 that apply only to a specific user.
 *   If `region` appears as a key, its value must be a valid Cloud region.
 *   If `zone` appears as a key, its value must be a valid Cloud zone.
 *   If any valid key other than `region` or `zone` appears in the map, then
 all valid keys other than `region` or `zone` must also appear in the
 map.
      map<string, string> dimensions = 3;
      Specified by:
      containsDimensions in interface ProducerQuotaPolicyOrBuilder

    • getDimensions

      @Deprecated public Map<String,String> getDimensions()
      Deprecated.
      Use getDimensionsMap() instead.
      Specified by:
      getDimensions in interface ProducerQuotaPolicyOrBuilder

    • getDimensionsMap

      public Map<String,String> getDimensionsMap()
      
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, a policy on a limit with the unit `1/{project}/{region}`
 could contain an entry with the key `region` and the value `us-east-1`;
 the policy is only applied to quota consumed in that region.

 This map has the following restrictions:

 *   Keys that are not defined in the limit's unit are not valid keys.
 Any string appearing in {brackets} in the unit (besides {project} or
 {user}) is a defined key.
 *   `project` is not a valid key; the project is already specified in
 the parent resource name.
 *   `user` is not a valid key; the API does not support quota policies
 that apply only to a specific user.
 *   If `region` appears as a key, its value must be a valid Cloud region.
 *   If `zone` appears as a key, its value must be a valid Cloud zone.
 *   If any valid key other than `region` or `zone` appears in the map, then
 all valid keys other than `region` or `zone` must also appear in the
 map.
      map<string, string> dimensions = 3;
      Specified by:
      getDimensionsMap in interface ProducerQuotaPolicyOrBuilder

    • getDimensionsOrDefault

      public String getDimensionsOrDefault(String key, String defaultValue)
      
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, a policy on a limit with the unit `1/{project}/{region}`
 could contain an entry with the key `region` and the value `us-east-1`;
 the policy is only applied to quota consumed in that region.

 This map has the following restrictions:

 *   Keys that are not defined in the limit's unit are not valid keys.
 Any string appearing in {brackets} in the unit (besides {project} or
 {user}) is a defined key.
 *   `project` is not a valid key; the project is already specified in
 the parent resource name.
 *   `user` is not a valid key; the API does not support quota policies
 that apply only to a specific user.
 *   If `region` appears as a key, its value must be a valid Cloud region.
 *   If `zone` appears as a key, its value must be a valid Cloud zone.
 *   If any valid key other than `region` or `zone` appears in the map, then
 all valid keys other than `region` or `zone` must also appear in the
 map.
      map<string, string> dimensions = 3;
      Specified by:
      getDimensionsOrDefault in interface ProducerQuotaPolicyOrBuilder

    • getDimensionsOrThrow

      public String getDimensionsOrThrow(String key)
      
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, a policy on a limit with the unit `1/{project}/{region}`
 could contain an entry with the key `region` and the value `us-east-1`;
 the policy is only applied to quota consumed in that region.

 This map has the following restrictions:

 *   Keys that are not defined in the limit's unit are not valid keys.
 Any string appearing in {brackets} in the unit (besides {project} or
 {user}) is a defined key.
 *   `project` is not a valid key; the project is already specified in
 the parent resource name.
 *   `user` is not a valid key; the API does not support quota policies
 that apply only to a specific user.
 *   If `region` appears as a key, its value must be a valid Cloud region.
 *   If `zone` appears as a key, its value must be a valid Cloud zone.
 *   If any valid key other than `region` or `zone` appears in the map, then
 all valid keys other than `region` or `zone` must also appear in the
 map.
      map<string, string> dimensions = 3;
      Specified by:
      getDimensionsOrThrow in interface ProducerQuotaPolicyOrBuilder

    • clearDimensions

      public ProducerQuotaPolicy.Builder clearDimensions()

    • removeDimensions

      public ProducerQuotaPolicy.Builder removeDimensions(String key)
      
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, a policy on a limit with the unit `1/{project}/{region}`
 could contain an entry with the key `region` and the value `us-east-1`;
 the policy is only applied to quota consumed in that region.

 This map has the following restrictions:

 *   Keys that are not defined in the limit's unit are not valid keys.
 Any string appearing in {brackets} in the unit (besides {project} or
 {user}) is a defined key.
 *   `project` is not a valid key; the project is already specified in
 the parent resource name.
 *   `user` is not a valid key; the API does not support quota policies
 that apply only to a specific user.
 *   If `region` appears as a key, its value must be a valid Cloud region.
 *   If `zone` appears as a key, its value must be a valid Cloud zone.
 *   If any valid key other than `region` or `zone` appears in the map, then
 all valid keys other than `region` or `zone` must also appear in the
 map.
      map<string, string> dimensions = 3;

    • getMutableDimensions

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

    • putDimensions

      public ProducerQuotaPolicy.Builder putDimensions(String key, String value)
      
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, a policy on a limit with the unit `1/{project}/{region}`
 could contain an entry with the key `region` and the value `us-east-1`;
 the policy is only applied to quota consumed in that region.

 This map has the following restrictions:

 *   Keys that are not defined in the limit's unit are not valid keys.
 Any string appearing in {brackets} in the unit (besides {project} or
 {user}) is a defined key.
 *   `project` is not a valid key; the project is already specified in
 the parent resource name.
 *   `user` is not a valid key; the API does not support quota policies
 that apply only to a specific user.
 *   If `region` appears as a key, its value must be a valid Cloud region.
 *   If `zone` appears as a key, its value must be a valid Cloud zone.
 *   If any valid key other than `region` or `zone` appears in the map, then
 all valid keys other than `region` or `zone` must also appear in the
 map.
      map<string, string> dimensions = 3;

    • putAllDimensions

      public ProducerQuotaPolicy.Builder putAllDimensions(Map<String,String> values)
      
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, a policy on a limit with the unit `1/{project}/{region}`
 could contain an entry with the key `region` and the value `us-east-1`;
 the policy is only applied to quota consumed in that region.

 This map has the following restrictions:

 *   Keys that are not defined in the limit's unit are not valid keys.
 Any string appearing in {brackets} in the unit (besides {project} or
 {user}) is a defined key.
 *   `project` is not a valid key; the project is already specified in
 the parent resource name.
 *   `user` is not a valid key; the API does not support quota policies
 that apply only to a specific user.
 *   If `region` appears as a key, its value must be a valid Cloud region.
 *   If `zone` appears as a key, its value must be a valid Cloud zone.
 *   If any valid key other than `region` or `zone` appears in the map, then
 all valid keys other than `region` or `zone` must also appear in the
 map.
      map<string, string> dimensions = 3;

    • getMetric

      public String getMetric()
       The name of the metric to which this policy applies.

 An example name would be:
 `compute.googleapis.com/cpus`
      string metric = 4;
      Specified by:
      getMetric in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The metric.

    • getMetricBytes

      public com.google.protobuf.ByteString getMetricBytes()
       The name of the metric to which this policy applies.

 An example name would be:
 `compute.googleapis.com/cpus`
      string metric = 4;
      Specified by:
      getMetricBytes in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The bytes for metric.

    • setMetric

      public ProducerQuotaPolicy.Builder setMetric(String value)
       The name of the metric to which this policy applies.

 An example name would be:
 `compute.googleapis.com/cpus`
      string metric = 4;
      Parameters:
      value - The metric to set.
      Returns:
      This builder for chaining.

    • clearMetric

      public ProducerQuotaPolicy.Builder clearMetric()
       The name of the metric to which this policy applies.

 An example name would be:
 `compute.googleapis.com/cpus`
      string metric = 4;
      Returns:
      This builder for chaining.

    • setMetricBytes

      public ProducerQuotaPolicy.Builder setMetricBytes(com.google.protobuf.ByteString value)
       The name of the metric to which this policy applies.

 An example name would be:
 `compute.googleapis.com/cpus`
      string metric = 4;
      Parameters:
      value - The bytes for metric to set.
      Returns:
      This builder for chaining.

    • getUnit

      public String getUnit()
       The limit unit of the limit to which this policy applies.

 An example unit would be:
 `1/{project}/{region}`
 Note that `{project}` and `{region}` are not placeholders in this example;
 the literal characters `{` and `}` occur in the string.
      string unit = 5;
      Specified by:
      getUnit in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The unit.

    • getUnitBytes

      public com.google.protobuf.ByteString getUnitBytes()
       The limit unit of the limit to which this policy applies.

 An example unit would be:
 `1/{project}/{region}`
 Note that `{project}` and `{region}` are not placeholders in this example;
 the literal characters `{` and `}` occur in the string.
      string unit = 5;
      Specified by:
      getUnitBytes in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The bytes for unit.

    • setUnit

      public ProducerQuotaPolicy.Builder setUnit(String value)
       The limit unit of the limit to which this policy applies.

 An example unit would be:
 `1/{project}/{region}`
 Note that `{project}` and `{region}` are not placeholders in this example;
 the literal characters `{` and `}` occur in the string.
      string unit = 5;
      Parameters:
      value - The unit to set.
      Returns:
      This builder for chaining.

    • clearUnit

      public ProducerQuotaPolicy.Builder clearUnit()
       The limit unit of the limit to which this policy applies.

 An example unit would be:
 `1/{project}/{region}`
 Note that `{project}` and `{region}` are not placeholders in this example;
 the literal characters `{` and `}` occur in the string.
      string unit = 5;
      Returns:
      This builder for chaining.

    • setUnitBytes

      public ProducerQuotaPolicy.Builder setUnitBytes(com.google.protobuf.ByteString value)
       The limit unit of the limit to which this policy applies.

 An example unit would be:
 `1/{project}/{region}`
 Note that `{project}` and `{region}` are not placeholders in this example;
 the literal characters `{` and `}` occur in the string.
      string unit = 5;
      Parameters:
      value - The bytes for unit to set.
      Returns:
      This builder for chaining.

    • getContainer

      public String getContainer()
       The cloud resource container at which the quota policy is created. The
 format is `{container_type}/{container_number}`
      string container = 6;
      Specified by:
      getContainer in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The container.

    • getContainerBytes

      public com.google.protobuf.ByteString getContainerBytes()
       The cloud resource container at which the quota policy is created. The
 format is `{container_type}/{container_number}`
      string container = 6;
      Specified by:
      getContainerBytes in interface ProducerQuotaPolicyOrBuilder
      Returns:
      The bytes for container.

    • setContainer

      public ProducerQuotaPolicy.Builder setContainer(String value)
       The cloud resource container at which the quota policy is created. The
 format is `{container_type}/{container_number}`
      string container = 6;
      Parameters:
      value - The container to set.
      Returns:
      This builder for chaining.

    • clearContainer

      public ProducerQuotaPolicy.Builder clearContainer()
       The cloud resource container at which the quota policy is created. The
 format is `{container_type}/{container_number}`
      string container = 6;
      Returns:
      This builder for chaining.

    • setContainerBytes

      public ProducerQuotaPolicy.Builder setContainerBytes(com.google.protobuf.ByteString value)
       The cloud resource container at which the quota policy is created. The
 format is `{container_type}/{container_number}`
      string container = 6;
      Parameters:
      value - The bytes for container to set.
      Returns:
      This builder for chaining.