Package com.google.api.serviceusage.v1beta1

Class AdminQuotaPolicy

  • All Implemented Interfaces:
    AdminQuotaPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AdminQuotaPolicy
extends com.google.protobuf.GeneratedMessageV3
implements AdminQuotaPolicyOrBuilder
     Quota policy created by quota administrator.
    Protobuf type google.api.serviceusage.v1beta1.AdminQuotaPolicy
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AdminQuotaPolicy.Builder
      Quota policy created by quota administrator.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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/adminQuotaPolicies/4a3f2c1d`
        string name = 1;
        Specified by:
        getName in interface AdminQuotaPolicyOrBuilder
        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/adminQuotaPolicies/4a3f2c1d`
        string name = 1;
        Specified by:
        getNameBytes in interface AdminQuotaPolicyOrBuilder
        Returns:
        The bytes for name.

      • 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 AdminQuotaPolicyOrBuilder
        Returns:
        The policyValue.

      • getDimensionsCount

        public int getDimensionsCount()
        Description copied from interface: AdminQuotaPolicyOrBuilder
        
 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;
        Specified by:
        getDimensionsCount in interface AdminQuotaPolicyOrBuilder

      • 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, 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;
        Specified by:
        containsDimensions in interface AdminQuotaPolicyOrBuilder

      • 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, 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;
        Specified by:
        getDimensionsMap in interface AdminQuotaPolicyOrBuilder

      • 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, 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;
        Specified by:
        getDimensionsOrDefault in interface AdminQuotaPolicyOrBuilder

      • 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, 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;
        Specified by:
        getDimensionsOrThrow in interface AdminQuotaPolicyOrBuilder

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

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

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AdminQuotaPolicy parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdminQuotaPolicy parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdminQuotaPolicy parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdminQuotaPolicy parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdminQuotaPolicy parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdminQuotaPolicy parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdminQuotaPolicy parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public AdminQuotaPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AdminQuotaPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AdminQuotaPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AdminQuotaPolicy> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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