Class VolumeConfig (0.47.0) 

public final class VolumeConfig extends GeneratedMessageV3 implements VolumeConfigOrBuilder

Configuration parameters for a new volume.

Protobuf type google.cloud.baremetalsolution.v2.VolumeConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > VolumeConfig

Static Fields

GCP_SERVICE_FIELD_NUMBER

public static final int GCP_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

LUN_RANGES_FIELD_NUMBER

public static final int LUN_RANGES_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_IDS_FIELD_NUMBER

public static final int MACHINE_IDS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NFS_EXPORTS_FIELD_NUMBER

public static final int NFS_EXPORTS_FIELD_NUMBER
Field Value
Type Description
int

PERFORMANCE_TIER_FIELD_NUMBER

public static final int PERFORMANCE_TIER_FIELD_NUMBER
Field Value
Type Description
int

PROTOCOL_FIELD_NUMBER

public static final int PROTOCOL_FIELD_NUMBER
Field Value
Type Description
int

SIZE_GB_FIELD_NUMBER

public static final int SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOTS_ENABLED_FIELD_NUMBER

public static final int SNAPSHOTS_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

USER_NOTE_FIELD_NUMBER

public static final int USER_NOTE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VolumeConfig getDefaultInstance()
Returns
Type Description
VolumeConfig

getDescriptor()

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

newBuilder()

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

newBuilder(VolumeConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public VolumeConfig getDefaultInstanceForType()
Returns
Type Description
VolumeConfig

getGcpService()

public String getGcpService()

The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.

string gcp_service = 11;

Returns
Type Description
String

The gcpService.

getGcpServiceBytes()

public ByteString getGcpServiceBytes()

The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.

string gcp_service = 11;

Returns
Type Description
ByteString

The bytes for gcpService.

getId()

public String getId()

A transient unique identifier to identify a volume within an ProvisioningConfig request.

string id = 2;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

A transient unique identifier to identify a volume within an ProvisioningConfig request.

string id = 2;

Returns
Type Description
ByteString

The bytes for id.

getLunRanges(int index)

public VolumeConfig.LunRange getLunRanges(int index)

LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.LunRange lun_ranges = 7;

Parameter
Name Description
index int
Returns
Type Description
VolumeConfig.LunRange

getLunRangesCount()

public int getLunRangesCount()

LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.LunRange lun_ranges = 7;

Returns
Type Description
int

getLunRangesList()

public List<VolumeConfig.LunRange> getLunRangesList()

LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.LunRange lun_ranges = 7;

Returns
Type Description
List<LunRange>

getLunRangesOrBuilder(int index)

public VolumeConfig.LunRangeOrBuilder getLunRangesOrBuilder(int index)

LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.LunRange lun_ranges = 7;

Parameter
Name Description
index int
Returns
Type Description
VolumeConfig.LunRangeOrBuilder

getLunRangesOrBuilderList()

public List<? extends VolumeConfig.LunRangeOrBuilder> getLunRangesOrBuilderList()

LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.LunRange lun_ranges = 7;

Returns
Type Description
List<? extends com.google.cloud.baremetalsolution.v2.VolumeConfig.LunRangeOrBuilder>

getMachineIds(int index)

public String getMachineIds(int index)

Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.

repeated string machine_ids = 8;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The machineIds at the given index.

getMachineIdsBytes(int index)

public ByteString getMachineIdsBytes(int index)

Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.

repeated string machine_ids = 8;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the machineIds at the given index.

getMachineIdsCount()

public int getMachineIdsCount()

Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.

repeated string machine_ids = 8;

Returns
Type Description
int

The count of machineIds.

getMachineIdsList()

public ProtocolStringList getMachineIdsList()

Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.

repeated string machine_ids = 8;

Returns
Type Description
ProtocolStringList

A list containing the machineIds.

getName()

public String getName()

Output only. The name of the volume config.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of the volume config.

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

Returns
Type Description
ByteString

The bytes for name.

getNfsExports(int index)

public VolumeConfig.NfsExport getNfsExports(int index)

NFS exports. Set only when protocol is PROTOCOL_NFS.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.NfsExport nfs_exports = 9;

Parameter
Name Description
index int
Returns
Type Description
VolumeConfig.NfsExport

getNfsExportsCount()

public int getNfsExportsCount()

NFS exports. Set only when protocol is PROTOCOL_NFS.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.NfsExport nfs_exports = 9;

Returns
Type Description
int

getNfsExportsList()

public List<VolumeConfig.NfsExport> getNfsExportsList()

NFS exports. Set only when protocol is PROTOCOL_NFS.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.NfsExport nfs_exports = 9;

Returns
Type Description
List<NfsExport>

getNfsExportsOrBuilder(int index)

public VolumeConfig.NfsExportOrBuilder getNfsExportsOrBuilder(int index)

NFS exports. Set only when protocol is PROTOCOL_NFS.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.NfsExport nfs_exports = 9;

Parameter
Name Description
index int
Returns
Type Description
VolumeConfig.NfsExportOrBuilder

getNfsExportsOrBuilderList()

public List<? extends VolumeConfig.NfsExportOrBuilder> getNfsExportsOrBuilderList()

NFS exports. Set only when protocol is PROTOCOL_NFS.

repeated .google.cloud.baremetalsolution.v2.VolumeConfig.NfsExport nfs_exports = 9;

Returns
Type Description
List<? extends com.google.cloud.baremetalsolution.v2.VolumeConfig.NfsExportOrBuilder>

getParserForType()

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

getPerformanceTier()

public VolumePerformanceTier getPerformanceTier()

Performance tier of the Volume. Default is SHARED.

.google.cloud.baremetalsolution.v2.VolumePerformanceTier performance_tier = 12;

Returns
Type Description
VolumePerformanceTier

The performanceTier.

getPerformanceTierValue()

public int getPerformanceTierValue()

Performance tier of the Volume. Default is SHARED.

.google.cloud.baremetalsolution.v2.VolumePerformanceTier performance_tier = 12;

Returns
Type Description
int

The enum numeric value on the wire for performanceTier.

getProtocol()

public VolumeConfig.Protocol getProtocol()

Volume protocol.

.google.cloud.baremetalsolution.v2.VolumeConfig.Protocol protocol = 5;

Returns
Type Description
VolumeConfig.Protocol

The protocol.

getProtocolValue()

public int getProtocolValue()

Volume protocol.

.google.cloud.baremetalsolution.v2.VolumeConfig.Protocol protocol = 5;

Returns
Type Description
int

The enum numeric value on the wire for protocol.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSizeGb()

public int getSizeGb()

The requested size of this volume, in GB.

int32 size_gb = 6;

Returns
Type Description
int

The sizeGb.

getSnapshotsEnabled()

public boolean getSnapshotsEnabled()

Whether snapshots should be enabled.

bool snapshots_enabled = 3;

Returns
Type Description
boolean

The snapshotsEnabled.

getType()

public VolumeConfig.Type getType()

The type of this Volume.

.google.cloud.baremetalsolution.v2.VolumeConfig.Type type = 4;

Returns
Type Description
VolumeConfig.Type

The type.

getTypeValue()

public int getTypeValue()

The type of this Volume.

.google.cloud.baremetalsolution.v2.VolumeConfig.Type type = 4;

Returns
Type Description
int

The enum numeric value on the wire for type.

getUserNote()

public String getUserNote()

User note field, it can be used by customers to add additional information for the BMS Ops team .

string user_note = 10;

Returns
Type Description
String

The userNote.

getUserNoteBytes()

public ByteString getUserNoteBytes()

User note field, it can be used by customers to add additional information for the BMS Ops team .

string user_note = 10;

Returns
Type Description
ByteString

The bytes for userNote.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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