Class: Google::Cloud::CloudQuotas::V1::QuotaPreference

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/cloudquotas/v1/resources.rb

Overview

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.

Defined Under Namespace

Classes: DimensionsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#contact_email ⇒ ::String

Returns Required. Input only. An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted.

The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.

Returns:

  • (::String) —

    Required. Input only. An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted.

    The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Create time stamp.

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dimensions ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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}) —

    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.



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::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.



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#justification ⇒ ::String

Returns The reason / justification for this quota preference.

Returns:

  • (::String) —

    The reason / justification for this quota preference.



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns 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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#quota_config ⇒ ::Google::Cloud::CloudQuotas::V1::QuotaConfig

Returns Required. Preferred quota configuration.

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#quota_id ⇒ ::String

Returns 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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#reconciling ⇒ ::Boolean (readonly)

Returns Output only. Is the quota preference pending Google Cloud approval and fulfillment.

Returns:

  • (::Boolean) —

    Output only. Is the quota preference pending Google Cloud approval and fulfillment.



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service ⇒ ::String

Returns 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.



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Update time stamp.

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 206

class QuotaPreference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DimensionsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end