Class QuotaOverride

  • All Implemented Interfaces:
    QuotaOverrideOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class QuotaOverride
    extends com.google.protobuf.GeneratedMessageV3
    implements QuotaOverrideOrBuilder
     A quota override
     
    Protobuf type google.api.serviceusage.v1beta1.QuotaOverride
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  QuotaOverride.Builder
      A quota override
      • 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 override.
         This name is generated by the server when the override is created.
        
         Example names would be:
         `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
         `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
        
         The resource name is intended to be opaque and should not be parsed for
         its component strings, since its representation could change in the future.
         
        string name = 1;
        Specified by:
        getName in interface QuotaOverrideOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the override.
         This name is generated by the server when the override is created.
        
         Example names would be:
         `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
         `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
        
         The resource name is intended to be opaque and should not be parsed for
         its component strings, since its representation could change in the future.
         
        string name = 1;
        Specified by:
        getNameBytes in interface QuotaOverrideOrBuilder
        Returns:
        The bytes for name.
      • getOverrideValue

        public long getOverrideValue()
         The overriding quota limit value.
         Can be any nonnegative integer, or -1 (unlimited quota).
         
        int64 override_value = 2;
        Specified by:
        getOverrideValue in interface QuotaOverrideOrBuilder
        Returns:
        The overrideValue.
      • getDimensionsCount

        public int getDimensionsCount()
        Description copied from interface: QuotaOverrideOrBuilder
         If this map is nonempty, then this override applies only to specific values
         for dimensions defined in the limit unit.
        
         For example, an override on a limit with the unit `1/{project}/{region}`
         could contain an entry with the key `region` and the value `us-east-1`;
         the override 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 overrides
             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 QuotaOverrideOrBuilder
      • containsDimensions

        public boolean containsDimensions​(String key)
         If this map is nonempty, then this override applies only to specific values
         for dimensions defined in the limit unit.
        
         For example, an override on a limit with the unit `1/{project}/{region}`
         could contain an entry with the key `region` and the value `us-east-1`;
         the override 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 overrides
             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 QuotaOverrideOrBuilder
      • getDimensionsMap

        public Map<String,​String> getDimensionsMap()
         If this map is nonempty, then this override applies only to specific values
         for dimensions defined in the limit unit.
        
         For example, an override on a limit with the unit `1/{project}/{region}`
         could contain an entry with the key `region` and the value `us-east-1`;
         the override 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 overrides
             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 QuotaOverrideOrBuilder
      • getDimensionsOrDefault

        public String getDimensionsOrDefault​(String key,
                                             String defaultValue)
         If this map is nonempty, then this override applies only to specific values
         for dimensions defined in the limit unit.
        
         For example, an override on a limit with the unit `1/{project}/{region}`
         could contain an entry with the key `region` and the value `us-east-1`;
         the override 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 overrides
             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 QuotaOverrideOrBuilder
      • getDimensionsOrThrow

        public String getDimensionsOrThrow​(String key)
         If this map is nonempty, then this override applies only to specific values
         for dimensions defined in the limit unit.
        
         For example, an override on a limit with the unit `1/{project}/{region}`
         could contain an entry with the key `region` and the value `us-east-1`;
         the override 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 overrides
             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 QuotaOverrideOrBuilder
      • getMetric

        public String getMetric()
         The name of the metric to which this override applies.
        
         An example name would be:
         `compute.googleapis.com/cpus`
         
        string metric = 4;
        Specified by:
        getMetric in interface QuotaOverrideOrBuilder
        Returns:
        The metric.
      • getMetricBytes

        public com.google.protobuf.ByteString getMetricBytes()
         The name of the metric to which this override applies.
        
         An example name would be:
         `compute.googleapis.com/cpus`
         
        string metric = 4;
        Specified by:
        getMetricBytes in interface QuotaOverrideOrBuilder
        Returns:
        The bytes for metric.
      • getUnit

        public String getUnit()
         The limit unit of the limit to which this override 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 QuotaOverrideOrBuilder
        Returns:
        The unit.
      • getUnitBytes

        public com.google.protobuf.ByteString getUnitBytes()
         The limit unit of the limit to which this override 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 QuotaOverrideOrBuilder
        Returns:
        The bytes for unit.
      • getAdminOverrideAncestor

        public String getAdminOverrideAncestor()
         The resource name of the ancestor that requested the override. For example:
         `organizations/12345` or `folders/67890`.
         Used by admin overrides only.
         
        string admin_override_ancestor = 6;
        Specified by:
        getAdminOverrideAncestor in interface QuotaOverrideOrBuilder
        Returns:
        The adminOverrideAncestor.
      • getAdminOverrideAncestorBytes

        public com.google.protobuf.ByteString getAdminOverrideAncestorBytes()
         The resource name of the ancestor that requested the override. For example:
         `organizations/12345` or `folders/67890`.
         Used by admin overrides only.
         
        string admin_override_ancestor = 6;
        Specified by:
        getAdminOverrideAncestorBytes in interface QuotaOverrideOrBuilder
        Returns:
        The bytes for adminOverrideAncestor.
      • 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 QuotaOverride parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static QuotaOverride getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<QuotaOverride> parser()
      • getParserForType

        public com.google.protobuf.Parser<QuotaOverride> 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 QuotaOverride getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder