Class StoragePool.Builder (1.101.0)

public static final class StoragePool.Builder extends GeneratedMessage.Builder<StoragePool.Builder> implements StoragePoolOrBuilder

Represents a zonal storage pool resource.

Protobuf type google.cloud.compute.v1.StoragePool

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public StoragePool build()
Returns
Type Description
StoragePool

buildPartial()

public StoragePool buildPartial()
Returns
Type Description
StoragePool

clear()

public StoragePool.Builder clear()
Returns
Type Description
StoragePool.Builder
Overrides

clearCapacityProvisioningType()

public StoragePool.Builder clearCapacityProvisioningType()

Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.

optional string capacity_provisioning_type = 251610375;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearCreationTimestamp()

public StoragePool.Builder clearCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearDescription()

public StoragePool.Builder clearDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearExapoolProvisionedCapacityGb()

public StoragePool.Builder clearExapoolProvisionedCapacityGb()

Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB

optional .google.cloud.compute.v1.StoragePoolExapoolProvisionedCapacityGb exapool_provisioned_capacity_gb = 345174240;

Returns
Type Description
StoragePool.Builder

clearId()

public StoragePool.Builder clearId()

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearKind()

public StoragePool.Builder clearKind()

Output only. [Output Only] Type of the resource. Always compute#storagePool for storage pools.

optional string kind = 3292052;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearLabelFingerprint()

public StoragePool.Builder clearLabelFingerprint()

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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a storage pool.

optional string label_fingerprint = 178124825;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearLabels()

public StoragePool.Builder clearLabels()
Returns
Type Description
StoragePool.Builder

clearName()

public StoragePool.Builder clearName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearParams()

public StoragePool.Builder clearParams()

Input only. Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.StoragePoolParams params = 78313862;

Returns
Type Description
StoragePool.Builder

clearPerformanceProvisioningType()

public StoragePool.Builder clearPerformanceProvisioningType()

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.

optional string performance_provisioning_type = 468553469;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearPoolProvisionedCapacityGb()

public StoragePool.Builder clearPoolProvisionedCapacityGb()

Size of the storage pool in GiB. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools.

optional int64 pool_provisioned_capacity_gb = 478537682;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearPoolProvisionedIops()

public StoragePool.Builder clearPoolProvisionedIops()

Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.

optional int64 pool_provisioned_iops = 112092311;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearPoolProvisionedThroughput()

public StoragePool.Builder clearPoolProvisionedThroughput()

Provisioned throughput of the storage pool in MiB/s. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.

optional int64 pool_provisioned_throughput = 169215640;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearResourceStatus()

public StoragePool.Builder clearResourceStatus()

Output only. [Output Only] Status information for the storage pool resource.

optional .google.cloud.compute.v1.StoragePoolResourceStatus resource_status = 249429315;

Returns
Type Description
StoragePool.Builder
public StoragePool.Builder clearSelfLink()

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearSelfLinkWithId()

public StoragePool.Builder clearSelfLinkWithId()

Output only. [Output Only] Server-defined URL for this resource's resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearState()

public StoragePool.Builder clearState()

Output only. [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.

optional string state = 109757585;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearStatus()

public StoragePool.Builder clearStatus()

Output only. [Output Only] Status information for the storage pool resource.

optional .google.cloud.compute.v1.StoragePoolResourceStatus status = 181260274;

Returns
Type Description
StoragePool.Builder

clearStoragePoolType()

public StoragePool.Builder clearStoragePoolType()

Type of the storage pool.

optional string storage_pool_type = 285999289;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

clearZone()

public StoragePool.Builder clearZone()

Output only. [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.

optional string zone = 3744684;

Returns
Type Description
StoragePool.Builder

This builder for chaining.

containsLabels(String key)

public boolean containsLabels(String key)

Labels to apply to this storage pool. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCapacityProvisioningType()

public String getCapacityProvisioningType()

Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.

optional string capacity_provisioning_type = 251610375;

Returns
Type Description
String

The capacityProvisioningType.

getCapacityProvisioningTypeBytes()

public ByteString getCapacityProvisioningTypeBytes()

Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.

optional string capacity_provisioning_type = 251610375;

Returns
Type Description
ByteString

The bytes for capacityProvisioningType.

getCreationTimestamp()

public String getCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public StoragePool getDefaultInstanceForType()
Returns
Type Description
StoragePool

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExapoolProvisionedCapacityGb()

public StoragePoolExapoolProvisionedCapacityGb getExapoolProvisionedCapacityGb()

Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB

optional .google.cloud.compute.v1.StoragePoolExapoolProvisionedCapacityGb exapool_provisioned_capacity_gb = 345174240;

Returns
Type Description
StoragePoolExapoolProvisionedCapacityGb

The exapoolProvisionedCapacityGb.

getExapoolProvisionedCapacityGbBuilder()

public StoragePoolExapoolProvisionedCapacityGb.Builder getExapoolProvisionedCapacityGbBuilder()

Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB

optional .google.cloud.compute.v1.StoragePoolExapoolProvisionedCapacityGb exapool_provisioned_capacity_gb = 345174240;

Returns
Type Description
StoragePoolExapoolProvisionedCapacityGb.Builder

getExapoolProvisionedCapacityGbOrBuilder()

public StoragePoolExapoolProvisionedCapacityGbOrBuilder getExapoolProvisionedCapacityGbOrBuilder()

Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB

optional .google.cloud.compute.v1.StoragePoolExapoolProvisionedCapacityGb exapool_provisioned_capacity_gb = 345174240;

Returns
Type Description
StoragePoolExapoolProvisionedCapacityGbOrBuilder

getId()

public long getId()

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

Output only. [Output Only] Type of the resource. Always compute#storagePool for storage pools.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

Output only. [Output Only] Type of the resource. Always compute#storagePool for storage pools.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getLabelFingerprint()

public String getLabelFingerprint()

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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a storage pool.

optional string label_fingerprint = 178124825;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a storage pool.

optional string label_fingerprint = 178124825;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels to apply to this storage pool. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels to apply to this storage pool. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to this storage pool. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels to apply to this storage pool. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParams()

public StoragePoolParams getParams()

Input only. Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.StoragePoolParams params = 78313862;

Returns
Type Description
StoragePoolParams

The params.

getParamsBuilder()

public StoragePoolParams.Builder getParamsBuilder()

Input only. Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.StoragePoolParams params = 78313862;

Returns
Type Description
StoragePoolParams.Builder

getParamsOrBuilder()

public StoragePoolParamsOrBuilder getParamsOrBuilder()

Input only. Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.StoragePoolParams params = 78313862;

Returns
Type Description
StoragePoolParamsOrBuilder

getPerformanceProvisioningType()

public String getPerformanceProvisioningType()

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.

optional string performance_provisioning_type = 468553469;

Returns
Type Description
String

The performanceProvisioningType.

getPerformanceProvisioningTypeBytes()

public ByteString getPerformanceProvisioningTypeBytes()

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.

optional string performance_provisioning_type = 468553469;

Returns
Type Description
ByteString

The bytes for performanceProvisioningType.

getPoolProvisionedCapacityGb()

public long getPoolProvisionedCapacityGb()

Size of the storage pool in GiB. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools.

optional int64 pool_provisioned_capacity_gb = 478537682;

Returns
Type Description
long

The poolProvisionedCapacityGb.

getPoolProvisionedIops()

public long getPoolProvisionedIops()

Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.

optional int64 pool_provisioned_iops = 112092311;

Returns
Type Description
long

The poolProvisionedIops.

getPoolProvisionedThroughput()

public long getPoolProvisionedThroughput()

Provisioned throughput of the storage pool in MiB/s. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.

optional int64 pool_provisioned_throughput = 169215640;

Returns
Type Description
long

The poolProvisionedThroughput.

getResourceStatus()

public StoragePoolResourceStatus getResourceStatus()

Output only. [Output Only] Status information for the storage pool resource.

optional .google.cloud.compute.v1.StoragePoolResourceStatus resource_status = 249429315;

Returns
Type Description
StoragePoolResourceStatus

The resourceStatus.

getResourceStatusBuilder()

public StoragePoolResourceStatus.Builder getResourceStatusBuilder()

Output only. [Output Only] Status information for the storage pool resource.

optional .google.cloud.compute.v1.StoragePoolResourceStatus resource_status = 249429315;

Returns
Type Description
StoragePoolResourceStatus.Builder

getResourceStatusOrBuilder()

public StoragePoolResourceStatusOrBuilder getResourceStatusOrBuilder()

Output only. [Output Only] Status information for the storage pool resource.

optional .google.cloud.compute.v1.StoragePoolResourceStatus resource_status = 249429315;

Returns
Type Description
StoragePoolResourceStatusOrBuilder
public String getSelfLink()

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

Output only. [Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSelfLinkWithId()

public String getSelfLinkWithId()

Output only. [Output Only] Server-defined URL for this resource's resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public ByteString getSelfLinkWithIdBytes()

Output only. [Output Only] Server-defined URL for this resource's resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
ByteString

The bytes for selfLinkWithId.

getState()

public String getState()

Output only. [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.

optional string state = 109757585;

Returns
Type Description
String

The state.

getStateBytes()

public ByteString getStateBytes()

Output only. [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.

optional string state = 109757585;

Returns
Type Description
ByteString

The bytes for state.

getStatus()

public StoragePoolResourceStatus getStatus()

Output only. [Output Only] Status information for the storage pool resource.

optional .google.cloud.compute.v1.StoragePoolResourceStatus status = 181260274;

Returns
Type Description
StoragePoolResourceStatus

The status.

getStatusBuilder()

public StoragePoolResourceStatus.Builder getStatusBuilder()

Output only. [Output Only] Status information for the storage pool resource.

optional .google.cloud.compute.v1.StoragePoolResourceStatus status = 181260274;

Returns
Type Description
StoragePoolResourceStatus.Builder

getStatusOrBuilder()

public StoragePoolResourceStatusOrBuilder getStatusOrBuilder()

Output only. [Output Only] Status information for the storage pool resource.

optional .google.cloud.compute.v1.StoragePoolResourceStatus status = 181260274;

Returns
Type Description
StoragePoolResourceStatusOrBuilder

getStoragePoolType()

public String getStoragePoolType()

Type of the storage pool.

optional string storage_pool_type = 285999289;

Returns
Type Description
String

The storagePoolType.

getStoragePoolTypeBytes()

public ByteString getStoragePoolTypeBytes()

Type of the storage pool.

optional string storage_pool_type = 285999289;

Returns
Type Description
ByteString

The bytes for storagePoolType.

getZone()

public String getZone()

Output only. [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.

optional string zone = 3744684;

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

Output only. [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.

optional string zone = 3744684;

Returns
Type Description
ByteString

The bytes for zone.

hasCapacityProvisioningType()

public boolean hasCapacityProvisioningType()

Provisioning type of the byte capacity of the pool. Check the CapacityProvisioningType enum for the list of possible values.

optional string capacity_provisioning_type = 251610375;

Returns
Type Description
boolean

Whether the capacityProvisioningType field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

Output only. [Output Only] Creation timestamp inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasExapoolProvisionedCapacityGb()

public boolean hasExapoolProvisionedCapacityGb()

Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB

optional .google.cloud.compute.v1.StoragePoolExapoolProvisionedCapacityGb exapool_provisioned_capacity_gb = 345174240;

Returns
Type Description
boolean

Whether the exapoolProvisionedCapacityGb field is set.

hasId()

public boolean hasId()

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

Output only. [Output Only] Type of the resource. Always compute#storagePool for storage pools.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLabelFingerprint()

public boolean hasLabelFingerprint()

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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a storage pool.

optional string label_fingerprint = 178124825;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasName()

public boolean hasName()

Name of the resource. Provided by the clie