com.google.api.services.compute.model

Class StoragePool

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.StoragePool

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class StoragePool
extends com.google.api.client.json.GenericJson

Represents a zonal storage pool resource.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
StoragePool()

Method Summary

Modifier and Type	Method and Description
StoragePool	clone()
byte[]	decodeLabelFingerprint() A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking.
StoragePool	encodeLabelFingerprint(byte[] labelFingerprint) A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking.
String	getCapacityProvisioningType() Provisioning type of the byte capacity of the pool.
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
String	getDescription() An optional description of this resource.
BigInteger	getId() [Output Only] The unique identifier for the resource.
String	getKind() [Output Only] Type of the resource.
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.
Map<String,String>	getLabels() Labels to apply to this storage pool.
String	getName() Name of the resource.
String	getPerformanceProvisioningType() Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
Long	getPoolProvisionedCapacityGb() Size of the storage pool in GiB.
Long	getPoolProvisionedIops() Provisioned IOPS of the storage pool.
Long	getPoolProvisionedThroughput() Provisioned throughput of the storage pool in MiB/s.
StoragePoolResourceStatus	getResourceStatus() [Output Only] Status information for the storage pool resource.
String	getSelfLink() [Output Only] Server-defined fully-qualified URL for this resource.
String	getSelfLinkWithId() [Output Only] Server-defined URL for this resource's resource id.
String	getState() [Output Only] The status of storage pool creation.
StoragePoolResourceStatus	getStatus() [Output Only] Status information for the storage pool resource.
String	getStoragePoolType() Type of the storage pool.
String	getZone() [Output Only] URL of the zone where the storage pool resides.
StoragePool	set(String fieldName, Object value)
StoragePool	setCapacityProvisioningType(String capacityProvisioningType) Provisioning type of the byte capacity of the pool.
StoragePool	setCreationTimestamp(String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
StoragePool	setDescription(String description) An optional description of this resource.
StoragePool	setId(BigInteger id) [Output Only] The unique identifier for the resource.
StoragePool	setKind(String kind) [Output Only] Type of the resource.
StoragePool	setLabelFingerprint(String labelFingerprint) A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking.
StoragePool	setLabels(Map<String,String> labels) Labels to apply to this storage pool.
StoragePool	setName(String name) Name of the resource.
StoragePool	setPerformanceProvisioningType(String performanceProvisioningType) Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.
StoragePool	setPoolProvisionedCapacityGb(Long poolProvisionedCapacityGb) Size of the storage pool in GiB.
StoragePool	setPoolProvisionedIops(Long poolProvisionedIops) Provisioned IOPS of the storage pool.
StoragePool	setPoolProvisionedThroughput(Long poolProvisionedThroughput) Provisioned throughput of the storage pool in MiB/s.
StoragePool	setResourceStatus(StoragePoolResourceStatus resourceStatus) [Output Only] Status information for the storage pool resource.
StoragePool	setSelfLink(String selfLink) [Output Only] Server-defined fully-qualified URL for this resource.
StoragePool	setSelfLinkWithId(String selfLinkWithId) [Output Only] Server-defined URL for this resource's resource id.
StoragePool	setState(String state) [Output Only] The status of storage pool creation.
StoragePool	setStatus(StoragePoolResourceStatus status) [Output Only] Status information for the storage pool resource.
StoragePool	setStoragePoolType(String storagePoolType) Type of the storage pool.
StoragePool	setZone(String zone) [Output Only] URL of the zone where the storage pool resides.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

StoragePool

public StoragePool()

Method Detail

getCapacityProvisioningType

public String getCapacityProvisioningType()

Provisioning type of the byte capacity of the pool.

Returns:

value or null for none

setCapacityProvisioningType

public StoragePool setCapacityProvisioningType(String capacityProvisioningType)

Provisioning type of the byte capacity of the pool.

Parameters:

capacityProvisioningType - capacityProvisioningType or null for none

getCreationTimestamp

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public StoragePool setCreationTimestamp(String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp or null for none

getDescription

public String getDescription()

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

Returns:

value or null for none

setDescription

public StoragePool setDescription(String description)

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

Parameters:

description - description or null for none

getId

public BigInteger getId()

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

Returns:

value or null for none

setId

public StoragePool setId(BigInteger id)

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

Parameters:

id - id or null for none

getKind

public String getKind()

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

Returns:

value or null for none

setKind

public StoragePool setKind(String kind)

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

Parameters:

kind - kind or null for none

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.

Returns:

value or null for none

See Also:

decodeLabelFingerprint()

decodeLabelFingerprint

public byte[] decodeLabelFingerprint()

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:

Base64 decoded value or null for none

Since:

1.14

See Also:

getLabelFingerprint()

setLabelFingerprint

public StoragePool setLabelFingerprint(String labelFingerprint)

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.

Parameters:

labelFingerprint - labelFingerprint or null for none

See Also:

#encodeLabelFingerprint()

encodeLabelFingerprint

public StoragePool encodeLabelFingerprint(byte[] labelFingerprint)

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.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getLabels

public Map<String,String> getLabels()

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

Returns:

value or null for none

setLabels

public StoragePool setLabels(Map<String,String> labels)

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

Parameters:

labels - labels or null for none

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]([-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:

value or null for none

setName

public StoragePool setName(String name)

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.

Parameters:

name - name or null for none

getPerformanceProvisioningType

public String getPerformanceProvisioningType()

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.

Returns:

value or null for none

setPerformanceProvisioningType

public StoragePool setPerformanceProvisioningType(String performanceProvisioningType)

Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.

Parameters:

performanceProvisioningType - performanceProvisioningType or null for none

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.

Returns:

value or null for none

setPoolProvisionedCapacityGb

public StoragePool setPoolProvisionedCapacityGb(Long poolProvisionedCapacityGb)

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

Parameters:

poolProvisionedCapacityGb - poolProvisionedCapacityGb or null for none

getPoolProvisionedIops

public Long getPoolProvisionedIops()

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

Returns:

value or null for none

setPoolProvisionedIops

public StoragePool setPoolProvisionedIops(Long poolProvisionedIops)

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

Parameters:

poolProvisionedIops - poolProvisionedIops or null for none

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.

Returns:

value or null for none

setPoolProvisionedThroughput

public StoragePool setPoolProvisionedThroughput(Long poolProvisionedThroughput)

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

Parameters:

poolProvisionedThroughput - poolProvisionedThroughput or null for none

getResourceStatus

public StoragePoolResourceStatus getResourceStatus()

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

Returns:

value or null for none

setResourceStatus

public StoragePool setResourceStatus(StoragePoolResourceStatus resourceStatus)

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

Parameters:

resourceStatus - resourceStatus or null for none

getSelfLink

public String getSelfLink()

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

Returns:

value or null for none

setSelfLink

public StoragePool setSelfLink(String selfLink)

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

Parameters:

selfLink - selfLink or null for none

getSelfLinkWithId

public String getSelfLinkWithId()

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

Returns:

value or null for none

setSelfLinkWithId

public StoragePool setSelfLinkWithId(String selfLinkWithId)

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

Parameters:

selfLinkWithId - selfLinkWithId or null for none

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.

Returns:

value or null for none

setState

public StoragePool setState(String state)

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

Parameters:

state - state or null for none

getStatus

public StoragePoolResourceStatus getStatus()

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

Returns:

value or null for none

setStatus

public StoragePool setStatus(StoragePoolResourceStatus status)

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

Parameters:

status - status or null for none

getStoragePoolType

public String getStoragePoolType()

Type of the storage pool.

Returns:

value or null for none

setStoragePoolType

public StoragePool setStoragePoolType(String storagePoolType)

Type of the storage pool.

Parameters:

storagePoolType - storagePoolType or null for none

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.

Returns:

value or null for none

setZone

public StoragePool setZone(String zone)

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

Parameters:

zone - zone or null for none

set

public StoragePool set(String fieldName,
                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public StoragePool clone()

Overrides:

clone in class com.google.api.client.json.GenericJson