Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::StoragePool (v2.11.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::StoragePool.

Represents a zonal storage pool resource.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#capacity_provisioning_type

def capacity_provisioning_type() -> ::String
Returns
  • (::String) — Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.

#capacity_provisioning_type=

def capacity_provisioning_type=(value) -> ::String
Parameter
  • value (::String) — Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.
Returns
  • (::String) — Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#id

def id() -> ::Integer
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#storagePool for storage pools.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Type of the resource. Always compute#storagePool for storage pools.
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#storagePool for storage pools.

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::String) — A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::String) — A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.
Returns
  • (::String) — A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this storage pool. These can be later modified by the setLabels method.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this storage pool. These can be later modified by the setLabels method.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this storage pool. These can be later modified by the setLabels method.

#name

def name() -> ::String
Returns
  • (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Returns
  • (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

#performance_provisioning_type

def performance_provisioning_type() -> ::String
Returns
  • (::String) — Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. Check the PerformanceProvisioningType enum for the list of possible values.

#performance_provisioning_type=

def performance_provisioning_type=(value) -> ::String
Parameter
  • value (::String) — Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. Check the PerformanceProvisioningType enum for the list of possible values.
Returns
  • (::String) — Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. Check the PerformanceProvisioningType enum for the list of possible values.

#pool_provisioned_capacity_gb

def pool_provisioned_capacity_gb() -> ::Integer
Returns
  • (::Integer) — Size, in GiB, of the storage pool.

#pool_provisioned_capacity_gb=

def pool_provisioned_capacity_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — Size, in GiB, of the storage pool.
Returns
  • (::Integer) — Size, in GiB, of the storage pool.

#pool_provisioned_iops

def pool_provisioned_iops() -> ::Integer
Returns
  • (::Integer) — Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.

#pool_provisioned_iops=

def pool_provisioned_iops=(value) -> ::Integer
Parameter
  • value (::Integer) — Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.
Returns
  • (::Integer) — Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.

#pool_provisioned_throughput

def pool_provisioned_throughput() -> ::Integer
Returns
  • (::Integer) — Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.

#pool_provisioned_throughput=

def pool_provisioned_throughput=(value) -> ::Integer
Parameter
  • value (::Integer) — Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.
Returns
  • (::Integer) — Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.

#resource_status

def resource_status() -> ::Google::Cloud::Compute::V1::StoragePoolResourceStatus
Returns

#resource_status=

def resource_status=(value) -> ::Google::Cloud::Compute::V1::StoragePoolResourceStatus
Parameter
Returns

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined fully-qualified URL for this resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined fully-qualified URL for this resource.
Returns
  • (::String) — [Output Only] Server-defined fully-qualified URL for this resource.

#self_link_with_id

def self_link_with_id() -> ::String
Returns
  • (::String) — [Output Only] Server-defined URL for this resource's resource id.

#self_link_with_id=

def self_link_with_id=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined URL for this resource's resource id.
Returns
  • (::String) — [Output Only] Server-defined URL for this resource's resource id.

#state

def state() -> ::String
Returns
  • (::String) — [Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. Check the State enum for the list of possible values.

#state=

def state=(value) -> ::String
Parameter
  • value (::String) — [Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. Check the State enum for the list of possible values.
Returns
  • (::String) — [Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. Check the State enum for the list of possible values.

#status

def status() -> ::Google::Cloud::Compute::V1::StoragePoolResourceStatus
Returns

#status=

def status=(value) -> ::Google::Cloud::Compute::V1::StoragePoolResourceStatus
Parameter
Returns

#storage_pool_type

def storage_pool_type() -> ::String
Returns
  • (::String) — Type of the storage pool.

#storage_pool_type=

def storage_pool_type=(value) -> ::String
Parameter
  • value (::String) — Type of the storage pool.
Returns
  • (::String) — Type of the storage pool.

#zone

def zone() -> ::String
Returns
  • (::String) — [Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

#zone=

def zone=(value) -> ::String
Parameter
  • value (::String) — [Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Returns
  • (::String) — [Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.