Cloud Quotas V1 API - Class Google::Cloud::CloudQuotas::V1::QuotaPreference (v1.0.0)

Reference documentation and code samples for the Cloud Quotas V1 API class Google::Cloud::CloudQuotas::V1::QuotaPreference.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#contact_email

def contact_email() -> ::String
Returns
  • (::String) — 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.

#contact_email=

def contact_email=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#dimensions

def dimensions() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#dimensions=

def dimensions=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#justification

def justification() -> ::String
Returns
  • (::String) — The reason / justification for this quota preference.

#justification=

def justification=(value) -> ::String
Parameter
  • value (::String) — The reason / justification for this quota preference.
Returns
  • (::String) — The reason / justification for this quota preference.

#name

def name() -> ::String
Returns
  • (::String) — 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

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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
Returns
  • (::String) — 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

#quota_config

def quota_config() -> ::Google::Cloud::CloudQuotas::V1::QuotaConfig
Returns

#quota_config=

def quota_config=(value) -> ::Google::Cloud::CloudQuotas::V1::QuotaConfig
Parameter
Returns

#quota_id

def quota_id() -> ::String
Returns
  • (::String) — Required. The id of the quota to which the quota preference is applied. A quota name is unique in the service. Example: CpusPerProjectPerRegion

#quota_id=

def quota_id=(value) -> ::String
Parameter
  • value (::String) — Required. The id of the quota to which the quota preference is applied. A quota name is unique in the service. Example: CpusPerProjectPerRegion
Returns
  • (::String) — Required. The id of the quota to which the quota preference is applied. A quota name is unique in the service. Example: CpusPerProjectPerRegion

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — Output only. Is the quota preference pending Google Cloud approval and fulfillment.

#service

def service() -> ::String
Returns
  • (::String) — Required. The name of the service to which the quota preference is applied.

#service=

def service=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the service to which the quota preference is applied.
Returns
  • (::String) — Required. The name of the service to which the quota preference is applied.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns