Class StoragePool (1.54.0)

public final class StoragePool extends GeneratedMessageV3 implements StoragePoolOrBuilder

Represents a zonal storage pool resource.

Protobuf type google.cloud.compute.v1.StoragePool

Static Fields

CAPACITY_PROVISIONING_TYPE_FIELD_NUMBER

public static final int CAPACITY_PROVISIONING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PERFORMANCE_PROVISIONING_TYPE_FIELD_NUMBER

public static final int PERFORMANCE_PROVISIONING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

POOL_PROVISIONED_CAPACITY_GB_FIELD_NUMBER

public static final int POOL_PROVISIONED_CAPACITY_GB_FIELD_NUMBER
Field Value
Type Description
int

POOL_PROVISIONED_IOPS_FIELD_NUMBER

public static final int POOL_PROVISIONED_IOPS_FIELD_NUMBER
Field Value
Type Description
int

POOL_PROVISIONED_THROUGHPUT_FIELD_NUMBER

public static final int POOL_PROVISIONED_THROUGHPUT_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_STATUS_FIELD_NUMBER

public static final int RESOURCE_STATUS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_POOL_TYPE_FIELD_NUMBER

public static final int STORAGE_POOL_TYPE_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StoragePool getDefaultInstance()
Returns
Type Description
StoragePool

getDescriptor()

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

newBuilder()

public static StoragePool.Builder newBuilder()
Returns
Type Description
StoragePool.Builder

newBuilder(StoragePool prototype)

public static StoragePool.Builder newBuilder(StoragePool prototype)
Parameter
Name Description
prototype StoragePool
Returns
Type Description
StoragePool.Builder

parseDelimitedFrom(InputStream input)

public static StoragePool parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StoragePool
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StoragePool
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StoragePool parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StoragePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StoragePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StoragePool parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StoragePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StoragePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StoragePool parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StoragePool
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StoragePool
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StoragePool parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StoragePool
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StoragePool
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StoragePool parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StoragePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StoragePool
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StoragePool> parser()
Returns
Type Description
Parser<StoragePool>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 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.

getId()

public long getId()

[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] 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] 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 error 412 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 error 412 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

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 with RFC1035. 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 with RFC1035. 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.

getParserForType()

public Parser<StoragePool> getParserForType()
Returns
Type Description
Parser<StoragePool>
Overrides

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, in GiB, of the storage pool.

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. 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] Status information for the storage pool resource.

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

Returns
Type Description
StoragePoolResourceStatus

The resourceStatus.

getResourceStatusOrBuilder()

public StoragePoolResourceStatusOrBuilder getResourceStatusOrBuilder()

[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] 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] 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] 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] Server-defined URL for this resource's resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
ByteString

The bytes for selfLinkWithId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public String getState()

[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] 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] Status information for the storage pool resource.

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

Returns
Type Description
StoragePoolResourceStatus

The status.

getStatusOrBuilder()

public StoragePoolResourceStatusOrBuilder getStatusOrBuilder()

[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] 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] 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] Creation timestamp in RFC3339 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.

hasId()

public boolean hasId()

[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] 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 error 412 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 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? 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
boolean

Whether the name field is set.

hasPerformanceProvisioningType()

public boolean hasPerformanceProvisioningType()

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
boolean

Whether the performanceProvisioningType field is set.

hasPoolProvisionedCapacityGb()

public boolean hasPoolProvisionedCapacityGb()

Size, in GiB, of the storage pool.

optional int64 pool_provisioned_capacity_gb = 478537682;

Returns
Type Description
boolean

Whether the poolProvisionedCapacityGb field is set.

hasPoolProvisionedIops()

public boolean hasPoolProvisionedIops()

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
boolean

Whether the poolProvisionedIops field is set.

hasPoolProvisionedThroughput()

public boolean hasPoolProvisionedThroughput()

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

optional int64 pool_provisioned_throughput = 169215640;

Returns
Type Description
boolean

Whether the poolProvisionedThroughput field is set.

hasResourceStatus()

public boolean hasResourceStatus()

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

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

Returns
Type Description
boolean

Whether the resourceStatus field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSelfLinkWithId()

public boolean hasSelfLinkWithId()

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

optional string self_link_with_id = 44520962;

Returns
Type Description
boolean

Whether the selfLinkWithId field is set.

hasState()

public boolean hasState()

[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
boolean

Whether the state field is set.

hasStatus()

public boolean hasStatus()

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

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

Returns
Type Description
boolean

Whether the status field is set.

hasStoragePoolType()

public boolean hasStoragePoolType()

Type of the storage pool.

optional string storage_pool_type = 285999289;

Returns
Type Description
boolean

Whether the storagePoolType field is set.

hasZone()

public boolean hasZone()

[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
boolean

Whether the zone field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StoragePool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StoragePool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException