Package com.google.api.cloudquotas.v1

Class QuotaPreference

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.api.cloudquotas.v1.QuotaPreference
All Implemented Interfaces:
QuotaPreferenceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class QuotaPreference extends com.google.protobuf.GeneratedMessage implements QuotaPreferenceOrBuilder
 QuotaPreference represents the preferred quota configuration specified for
 a project, folder or organization. There is only one QuotaPreference
 resource for a quota value targeting a unique set of dimensions.
Protobuf type google.api.cloudquotas.v1.QuotaPreference
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DIMENSIONS_FIELD_NUMBER

      public static final int DIMENSIONS_FIELD_NUMBER
      See Also:

    • QUOTA_CONFIG_FIELD_NUMBER

      public static final int QUOTA_CONFIG_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • SERVICE_FIELD_NUMBER

      public static final int SERVICE_FIELD_NUMBER
      See Also:

    • QUOTA_ID_FIELD_NUMBER

      public static final int QUOTA_ID_FIELD_NUMBER
      See Also:

    • RECONCILING_FIELD_NUMBER

      public static final int RECONCILING_FIELD_NUMBER
      See Also:

    • JUSTIFICATION_FIELD_NUMBER

      public static final int JUSTIFICATION_FIELD_NUMBER
      See Also:

    • CONTACT_EMAIL_FIELD_NUMBER

      public static final int CONTACT_EMAIL_FIELD_NUMBER
      See Also:

  • 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

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Required except in the CREATE requests.
 The resource name of the quota preference.
 The ID component following "locations/" must be "global".
 Example:
 `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`
      string name = 1;
      Specified by:
      getName in interface QuotaPreferenceOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required except in the CREATE requests.
 The resource name of the quota preference.
 The ID component following "locations/" must be "global".
 Example:
 `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`
      string name = 1;
      Specified by:
      getNameBytes in interface QuotaPreferenceOrBuilder
      Returns:
      The bytes for name.

    • getDimensionsCount

      public int getDimensionsCount()
      Description copied from interface: QuotaPreferenceOrBuilder
       Immutable. The dimensions that this quota preference applies to. The key of
 the map entry is the name of a dimension, such as "region", "zone",
 "network_id", and the value of the map entry is the dimension value.

 If a dimension is missing from the map of dimensions, the quota preference
 applies to all the dimension values except for those that have other quota
 preferences configured for the specific value.

 NOTE: QuotaPreferences can only be applied across all values of "user" and
 "resource" dimension. Do not set values for "user" or "resource" in the
 dimension map.

 Example: {"provider", "Foo Inc"} where "provider" is a service specific
 dimension.
      map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getDimensionsCount in interface QuotaPreferenceOrBuilder

    • containsDimensions

      public boolean containsDimensions(String key)
       Immutable. The dimensions that this quota preference applies to. The key of
 the map entry is the name of a dimension, such as "region", "zone",
 "network_id", and the value of the map entry is the dimension value.

 If a dimension is missing from the map of dimensions, the quota preference
 applies to all the dimension values except for those that have other quota
 preferences configured for the specific value.

 NOTE: QuotaPreferences can only be applied across all values of "user" and
 "resource" dimension. Do not set values for "user" or "resource" in the
 dimension map.

 Example: {"provider", "Foo Inc"} where "provider" is a service specific
 dimension.
      map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      containsDimensions in interface QuotaPreferenceOrBuilder

    • getDimensions

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

    • getDimensionsMap

      public Map<String,String> getDimensionsMap()
       Immutable. The dimensions that this quota preference applies to. The key of
 the map entry is the name of a dimension, such as "region", "zone",
 "network_id", and the value of the map entry is the dimension value.

 If a dimension is missing from the map of dimensions, the quota preference
 applies to all the dimension values except for those that have other quota
 preferences configured for the specific value.

 NOTE: QuotaPreferences can only be applied across all values of "user" and
 "resource" dimension. Do not set values for "user" or "resource" in the
 dimension map.

 Example: {"provider", "Foo Inc"} where "provider" is a service specific
 dimension.
      map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getDimensionsMap in interface QuotaPreferenceOrBuilder

    • getDimensionsOrDefault

      public String getDimensionsOrDefault(String key, String defaultValue)
       Immutable. The dimensions that this quota preference applies to. The key of
 the map entry is the name of a dimension, such as "region", "zone",
 "network_id", and the value of the map entry is the dimension value.

 If a dimension is missing from the map of dimensions, the quota preference
 applies to all the dimension values except for those that have other quota
 preferences configured for the specific value.

 NOTE: QuotaPreferences can only be applied across all values of "user" and
 "resource" dimension. Do not set values for "user" or "resource" in the
 dimension map.

 Example: {"provider", "Foo Inc"} where "provider" is a service specific
 dimension.
      map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getDimensionsOrDefault in interface QuotaPreferenceOrBuilder

    • getDimensionsOrThrow

      public String getDimensionsOrThrow(String key)
       Immutable. The dimensions that this quota preference applies to. The key of
 the map entry is the name of a dimension, such as "region", "zone",
 "network_id", and the value of the map entry is the dimension value.

 If a dimension is missing from the map of dimensions, the quota preference
 applies to all the dimension values except for those that have other quota
 preferences configured for the specific value.

 NOTE: QuotaPreferences can only be applied across all values of "user" and
 "resource" dimension. Do not set values for "user" or "resource" in the
 dimension map.

 Example: {"provider", "Foo Inc"} where "provider" is a service specific
 dimension.
      map<string, string> dimensions = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getDimensionsOrThrow in interface QuotaPreferenceOrBuilder

    • hasQuotaConfig

      public boolean hasQuotaConfig()
       Required. Preferred quota configuration.
      .google.api.cloudquotas.v1.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasQuotaConfig in interface QuotaPreferenceOrBuilder
      Returns:
      Whether the quotaConfig field is set.

    • getQuotaConfig

      public QuotaConfig getQuotaConfig()
       Required. Preferred quota configuration.
      .google.api.cloudquotas.v1.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuotaConfig in interface QuotaPreferenceOrBuilder
      Returns:
      The quotaConfig.

    • getQuotaConfigOrBuilder

      public QuotaConfigOrBuilder getQuotaConfigOrBuilder()
       Required. Preferred quota configuration.
      .google.api.cloudquotas.v1.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuotaConfigOrBuilder in interface QuotaPreferenceOrBuilder

    • getEtag

      public String getEtag()
       Optional. The current etag of the quota preference. If an etag is provided
 on update and does not match the current server's etag of the quota
 preference, the request will be blocked and an ABORTED error will be
 returned. See https://google.aip.dev/134#etags for more details on etags.
      string etag = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtag in interface QuotaPreferenceOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Optional. The current etag of the quota preference. If an etag is provided
 on update and does not match the current server's etag of the quota
 preference, the request will be blocked and an ABORTED error will be
 returned. See https://google.aip.dev/134#etags for more details on etags.
      string etag = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtagBytes in interface QuotaPreferenceOrBuilder
      Returns:
      The bytes for etag.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Create time stamp
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface QuotaPreferenceOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Create time stamp
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface QuotaPreferenceOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Create time stamp
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface QuotaPreferenceOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. Update time stamp
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface QuotaPreferenceOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Update time stamp
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface QuotaPreferenceOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Update time stamp
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface QuotaPreferenceOrBuilder

    • getService

      public String getService()
       Required. The name of the service to which the quota preference is applied.
      string service = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getService in interface QuotaPreferenceOrBuilder
      Returns:
      The service.

    • getServiceBytes

      public com.google.protobuf.ByteString getServiceBytes()
       Required. The name of the service to which the quota preference is applied.
      string service = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getServiceBytes in interface QuotaPreferenceOrBuilder
      Returns:
      The bytes for service.

    • getQuotaId

      public String getQuotaId()
       Required. The id of the quota to which the quota preference is applied. A
 quota name is unique in the service. Example: `CpusPerProjectPerRegion`
      string quota_id = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuotaId in interface QuotaPreferenceOrBuilder
      Returns:
      The quotaId.

    • getQuotaIdBytes

      public com.google.protobuf.ByteString getQuotaIdBytes()
       Required. The id of the quota to which the quota preference is applied. A
 quota name is unique in the service. Example: `CpusPerProjectPerRegion`
      string quota_id = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuotaIdBytes in interface QuotaPreferenceOrBuilder
      Returns:
      The bytes for quotaId.

    • getReconciling

      public boolean getReconciling()
       Output only. Is the quota preference pending Google Cloud approval and
 fulfillment.
      bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReconciling in interface QuotaPreferenceOrBuilder
      Returns:
      The reconciling.

    • getJustification

      public String getJustification()
       The reason / justification for this quota preference.
      string justification = 11;
      Specified by:
      getJustification in interface QuotaPreferenceOrBuilder
      Returns:
      The justification.

    • getJustificationBytes

      public com.google.protobuf.ByteString getJustificationBytes()
       The reason / justification for this quota preference.
      string justification = 11;
      Specified by:
      getJustificationBytes in interface QuotaPreferenceOrBuilder
      Returns:
      The bytes for justification.

    • getContactEmail

      public String getContactEmail()
       Input only. An email address that can be used to contact the the user, in
 case Google Cloud needs more information to make a decision before
 additional quota can be granted.

 When requesting a quota increase, the email address is required.
 When requesting a quota decrease, the email address is optional.
 For example, the email address is optional when the
 `QuotaConfig.preferred_value` is smaller than the
 `QuotaDetails.reset_value`.
      string contact_email = 12 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getContactEmail in interface QuotaPreferenceOrBuilder
      Returns:
      The contactEmail.

    • getContactEmailBytes

      public com.google.protobuf.ByteString getContactEmailBytes()
       Input only. An email address that can be used to contact the the user, in
 case Google Cloud needs more information to make a decision before
 additional quota can be granted.

 When requesting a quota increase, the email address is required.
 When requesting a quota decrease, the email address is optional.
 For example, the email address is optional when the
 `QuotaConfig.preferred_value` is smaller than the
 `QuotaDetails.reset_value`.
      string contact_email = 12 [(.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getContactEmailBytes in interface QuotaPreferenceOrBuilder
      Returns:
      The bytes for contactEmail.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 QuotaPreference parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static QuotaPreference parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QuotaPreference parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QuotaPreference parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QuotaPreference parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QuotaPreference parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static QuotaPreference.Builder newBuilder()

    • newBuilder

      public static QuotaPreference.Builder newBuilder(QuotaPreference prototype)

    • toBuilder

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

    • newBuilderForType

      protected QuotaPreference.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static QuotaPreference getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<QuotaPreference> parser()

    • getParserForType

      public com.google.protobuf.Parser<QuotaPreference> 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.GeneratedMessage

    • getDefaultInstanceForType

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