Class: Google::Cloud::CloudQuotas::V1::QuotaInfo

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

Overview

QuotaInfo represents information about a particular quota for a given project, folder or organization.

Defined Under Namespace

Modules: ContainerType

Instance Attribute Summary collapse

Instance Attribute Details

#container_type ⇒ ::Google::Cloud::CloudQuotas::V1::QuotaInfo::ContainerType

Returns The container type of the QuotaInfo.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#dimensions ⇒ ::Array<::String>

Returns The dimensions the quota is defined on.

Returns:

  • (::Array<::String>) —

    The dimensions the quota is defined on.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#dimensions_infos ⇒ ::Array<::Google::Cloud::CloudQuotas::V1::DimensionsInfo>

Returns The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#is_concurrent ⇒ ::Boolean

Returns Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.

Returns:

  • (::Boolean) —

    Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#is_fixed ⇒ ::Boolean

Returns Whether the quota value is fixed or adjustable.

Returns:

  • (::Boolean) —

    Whether the quota value is fixed or adjustable



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#is_precise ⇒ ::Boolean

Returns Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.

Returns:

  • (::Boolean) —

    Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#metric ⇒ ::String

Returns The metric of the quota. It specifies the resources consumption the quota is defined for. Example: compute.googleapis.com/cpus.

Returns:

  • (::String) —

    The metric of the quota. It specifies the resources consumption the quota is defined for. Example: compute.googleapis.com/cpus



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#metric_display_name ⇒ ::String

Returns The display name of the quota metric.

Returns:

  • (::String) —

    The display name of the quota metric



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#metric_unit ⇒ ::String

Returns The unit in which the metric value is reported, e.g., "MByte".

Returns:

  • (::String) —

    The unit in which the metric value is reported, e.g., "MByte".



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#name ⇒ ::String

Returns Resource name of this QuotaInfo. The ID component following "locations/" must be "global". Example: projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion.

Returns:

  • (::String) —

    Resource name of this QuotaInfo. The ID component following "locations/" must be "global". Example: projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#quota_display_name ⇒ ::String

Returns The display name of the quota.

Returns:

  • (::String) —

    The display name of the quota.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#quota_id ⇒ ::String

Returns The id of the quota, which is unquie within the service. Example: CpusPerProjectPerRegion.

Returns:

  • (::String) —

    The id of the quota, which is unquie within the service. Example: CpusPerProjectPerRegion



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#quota_increase_eligibility ⇒ ::Google::Cloud::CloudQuotas::V1::QuotaIncreaseEligibility

Returns Whether it is eligible to request a higher quota value for this quota.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#refresh_interval ⇒ ::String

Returns The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.

Returns:

  • (::String) —

    The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#service ⇒ ::String

Returns The name of the service in which the quota is defined. Example: compute.googleapis.com.

Returns:

  • (::String) —

    The name of the service in which the quota is defined. Example: compute.googleapis.com



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end

#service_request_quota_uri ⇒ ::String

Returns URI to the page where users can request more quota for the cloud service—for example, https://console.cloud.google.com/iam-admin/quotas.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/api/cloudquotas/v1/resources.rb', line 89

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

  # The enumeration of the types of a cloud resource container.
  module ContainerType
    # Unspecified container type.
    CONTAINER_TYPE_UNSPECIFIED = 0

    # consumer project
    PROJECT = 1

    # folder
    FOLDER = 2

    # organization
    ORGANIZATION = 3
  end
end