Class StoragePool (0.15.0)

public final class StoragePool extends GeneratedMessageV3 implements StoragePoolOrBuilder

StoragePool is a container for volumes with a service level and capacity. Volumes can be created in a pool of sufficient available capacity. StoragePool capacity is what you are billed for.

Protobuf type google.cloud.netapp.v1.StoragePool

Static Fields

ACTIVE_DIRECTORY_FIELD_NUMBER

public static final int ACTIVE_DIRECTORY_FIELD_NUMBER
Field Value
TypeDescription
int

CAPACITY_GIB_FIELD_NUMBER

public static final int CAPACITY_GIB_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_TYPE_FIELD_NUMBER

public static final int ENCRYPTION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

GLOBAL_ACCESS_ALLOWED_FIELD_NUMBER

public static final int GLOBAL_ACCESS_ALLOWED_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_CONFIG_FIELD_NUMBER

public static final int KMS_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LDAP_ENABLED_FIELD_NUMBER

public static final int LDAP_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

PSA_RANGE_FIELD_NUMBER

public static final int PSA_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_LEVEL_FIELD_NUMBER

public static final int SERVICE_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_DETAILS_FIELD_NUMBER

public static final int STATE_DETAILS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

VOLUME_CAPACITY_GIB_FIELD_NUMBER

public static final int VOLUME_CAPACITY_GIB_FIELD_NUMBER
Field Value
TypeDescription
int

VOLUME_COUNT_FIELD_NUMBER

public static final int VOLUME_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StoragePool getDefaultInstance()
Returns
TypeDescription
StoragePool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StoragePool.Builder newBuilder()
Returns
TypeDescription
StoragePool.Builder

newBuilder(StoragePool prototype)

public static StoragePool.Builder newBuilder(StoragePool prototype)
Parameter
NameDescription
prototypeStoragePool
Returns
TypeDescription
StoragePool.Builder

parseDelimitedFrom(InputStream input)

public static StoragePool parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StoragePool parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StoragePool parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StoragePool parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StoragePool parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StoragePool parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StoragePool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StoragePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StoragePool> parser()
Returns
TypeDescription
Parser<StoragePool>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getActiveDirectory()

public String getActiveDirectory()

Specifies the Active Directory to be used for creating a SMB volume.

string active_directory = 12 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The activeDirectory.

getActiveDirectoryBytes()

public ByteString getActiveDirectoryBytes()

Specifies the Active Directory to be used for creating a SMB volume.

string active_directory = 12 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for activeDirectory.

getCapacityGib()

public long getCapacityGib()

Required. Capacity in GIB of the pool

int64 capacity_gib = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
long

The capacityGib.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time of the storage pool

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time of the storage pool

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public StoragePool getDefaultInstanceForType()
Returns
TypeDescription
StoragePool

getDescription()

public String getDescription()

Description of the storage pool

string description = 9;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the storage pool

string description = 9;

Returns
TypeDescription
ByteString

The bytes for description.

getEncryptionType()

public EncryptionType getEncryptionType()

Output only. Specifies the current pool encryption key source.

.google.cloud.netapp.v1.EncryptionType encryption_type = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EncryptionType

The encryptionType.

getEncryptionTypeValue()

public int getEncryptionTypeValue()

Output only. Specifies the current pool encryption key source.

.google.cloud.netapp.v1.EncryptionType encryption_type = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for encryptionType.

getGlobalAccessAllowed() (deprecated)

public boolean getGlobalAccessAllowed()

Deprecated. google.cloud.netapp.v1.StoragePool.global_access_allowed is deprecated. See google/cloud/netapp/v1/storage_pool.proto;l=222

Deprecated. Used to allow SO pool to access AD or DNS server from other regions.

optional bool global_access_allowed = 17 [deprecated = true];

Returns
TypeDescription
boolean

The globalAccessAllowed.

getKmsConfig()

public String getKmsConfig()

Specifies the KMS config to be used for volume encryption.

string kms_config = 13 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The kmsConfig.

getKmsConfigBytes()

public ByteString getKmsConfigBytes()

Specifies the KMS config to be used for volume encryption.

string kms_config = 13 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for kmsConfig.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 10;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 10;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 10;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLdapEnabled()

public boolean getLdapEnabled()

Flag indicating if the pool is NFS LDAP enabled or not.

bool ldap_enabled = 14;

Returns
TypeDescription
boolean

The ldapEnabled.

getName()

public String getName()

Identifier. Name of the storage pool

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the storage pool

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
TypeDescription
ByteString

The bytes for name.

getNetwork()

public String getNetwork()

Required. VPC Network name. Format: projects/{project}/global/networks/{network}

string network = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Required. VPC Network name. Format: projects/{project}/global/networks/{network}

string network = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for network.

getParserForType()

public Parser<StoragePool> getParserForType()
Returns
TypeDescription
Parser<StoragePool>
Overrides

getPsaRange()

public String getPsaRange()

Name of the Private Service Access allocated range. If not provided, any available range will be chosen.

string psa_range = 15;

Returns
TypeDescription
String

The psaRange.

getPsaRangeBytes()

public ByteString getPsaRangeBytes()

Name of the Private Service Access allocated range. If not provided, any available range will be chosen.

string psa_range = 15;

Returns
TypeDescription
ByteString

The bytes for psaRange.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServiceLevel()

public ServiceLevel getServiceLevel()

Required. Service level of the storage pool

.google.cloud.netapp.v1.ServiceLevel service_level = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ServiceLevel

The serviceLevel.

getServiceLevelValue()

public int getServiceLevelValue()

Required. Service level of the storage pool

.google.cloud.netapp.v1.ServiceLevel service_level = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for serviceLevel.

getState()

public StoragePool.State getState()

Output only. State of the storage pool

.google.cloud.netapp.v1.StoragePool.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
StoragePool.State

The state.

getStateDetails()

public String getStateDetails()

Output only. State details of the storage pool

string state_details = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The stateDetails.

getStateDetailsBytes()

public ByteString getStateDetailsBytes()

Output only. State details of the storage pool

string state_details = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for stateDetails.

getStateValue()

public int getStateValue()

Output only. State of the storage pool

.google.cloud.netapp.v1.StoragePool.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getVolumeCapacityGib()

public long getVolumeCapacityGib()

Output only. Allocated size of all volumes in GIB in the storage pool

int64 volume_capacity_gib = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
long

The volumeCapacityGib.

getVolumeCount()

public int getVolumeCount()

Output only. Volume count of the storage pool

int32 volume_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The volumeCount.

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time of the storage pool

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasGlobalAccessAllowed() (deprecated)

public boolean hasGlobalAccessAllowed()

Deprecated. google.cloud.netapp.v1.StoragePool.global_access_allowed is deprecated. See google/cloud/netapp/v1/storage_pool.proto;l=222

Deprecated. Used to allow SO pool to access AD or DNS server from other regions.

optional bool global_access_allowed = 17 [deprecated = true];

Returns
TypeDescription
boolean

Whether the globalAccessAllowed field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StoragePool.Builder newBuilderForType()
Returns
TypeDescription
StoragePool.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StoragePool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StoragePool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StoragePool.Builder toBuilder()
Returns
TypeDescription
StoragePool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException