Package com.google.api.serviceusage.v1beta1

Interface AdminQuotaPolicyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AdminQuotaPolicy, AdminQuotaPolicy.Builder
    public interface AdminQuotaPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsDimensions​(String key)
      If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit.
      String getContainer()
      The cloud resource container at which the quota policy is created.
      com.google.protobuf.ByteString getContainerBytes()
      The cloud resource container at which the quota policy is created.
      Map<String,​String> getDimensions()
      Deprecated.
      int getDimensionsCount()
      If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit.
      Map<String,​String> getDimensionsMap()
      If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit.
      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.
      String getDimensionsOrThrow​(String key)
      If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit.
      String getMetric()
      The name of the metric to which this policy applies.
      com.google.protobuf.ByteString getMetricBytes()
      The name of the metric to which this policy applies.
      String getName()
      The resource name of the policy.
      com.google.protobuf.ByteString getNameBytes()
      The resource name of the policy.
      long getPolicyValue()
      The quota policy value.
      String getUnit()
      The limit unit of the limit to which this policy applies.
      com.google.protobuf.ByteString getUnitBytes()
      The limit unit of the limit to which this policy applies.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getName

        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/adminQuotaPolicies/4a3f2c1d`
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        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/adminQuotaPolicies/4a3f2c1d`
        string name = 1;
        Returns:
        The bytes for name.

      • getPolicyValue

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

      • getDimensionsCount

        int getDimensionsCount()
        
 If this map is nonempty, then this policy applies only to specific values
 for dimensions defined in the limit unit.

 For example, an 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:

 *   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.
 *   Keys other than `region` or `zone` are not valid.
        map<string, string> dimensions = 3;

      • containsDimensions

        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, an 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:

 *   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.
 *   Keys other than `region` or `zone` are not valid.
        map<string, string> dimensions = 3;

      • getDimensionsMap

        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, an 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:

 *   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.
 *   Keys other than `region` or `zone` are not valid.
        map<string, string> dimensions = 3;

      • getDimensionsOrDefault

        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, an 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:

 *   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.
 *   Keys other than `region` or `zone` are not valid.
        map<string, string> dimensions = 3;

      • getDimensionsOrThrow

        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, an 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:

 *   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.
 *   Keys other than `region` or `zone` are not valid.
        map<string, string> dimensions = 3;

      • getMetric

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

 An example name would be:
 `compute.googleapis.com/cpus`
        string metric = 4;
        Returns:
        The metric.

      • getMetricBytes

        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;
        Returns:
        The bytes for metric.

      • getUnit

        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;
        Returns:
        The unit.

      • getUnitBytes

        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;
        Returns:
        The bytes for unit.

      • getContainer

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

      • getContainerBytes

        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;
        Returns:
        The bytes for container.