Package com.google.api.cloudquotas.v1

Interface QuotaPreferenceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
QuotaPreference, QuotaPreference.Builder
@Generated public interface QuotaPreferenceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

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

    • getNameBytes

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

    • getDimensionsCount

      int getDimensionsCount()
       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];

    • containsDimensions

      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];

    • getDimensions

      @Deprecated Map<String,String> getDimensions()
      Deprecated.
      Use getDimensionsMap() instead.

    • getDimensionsMap

      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];

    • getDimensionsOrDefault

      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];

    • getDimensionsOrThrow

      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];

    • hasQuotaConfig

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

    • getQuotaConfig

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

    • getQuotaConfigOrBuilder

      QuotaConfigOrBuilder getQuotaConfigOrBuilder()
       Required. Preferred quota configuration.
      .google.api.cloudquotas.v1.QuotaConfig quota_config = 3 [(.google.api.field_behavior) = REQUIRED];

    • getEtag

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

    • getEtagBytes

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

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Create time stamp
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

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

    • getUpdateTime

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

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Update time stamp
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getService

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

    • getServiceBytes

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

    • getQuotaId

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

    • getQuotaIdBytes

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

    • getReconciling

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

    • getJustification

      String getJustification()
       The reason / justification for this quota preference.
      string justification = 11;
      Returns:
      The justification.

    • getJustificationBytes

      com.google.protobuf.ByteString getJustificationBytes()
       The reason / justification for this quota preference.
      string justification = 11;
      Returns:
      The bytes for justification.

    • getContactEmail

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

    • getContactEmailBytes

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