Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface VolumeConfigOrBuilder (0.48.0)

public interface VolumeConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGcpService()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> getMachineIdsList()

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

repeated string machine_ids = 8;

Returns
Type	Description
`List<String>`	A list containing the machineIds.

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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>`

getPerformanceTier()

public abstract 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 abstract 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 abstract VolumeConfig.Protocol getProtocol()

Volume protocol.

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

Returns
Type	Description
`VolumeConfig.Protocol`	The protocol.

getProtocolValue()

public abstract 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.

getSizeGb()

public abstract int getSizeGb()

The requested size of this volume, in GB.

int32 size_gb = 6;

Returns
Type	Description
`int`	The sizeGb.

getSnapshotsEnabled()

public abstract boolean getSnapshotsEnabled()

Whether snapshots should be enabled.

bool snapshots_enabled = 3;

Returns
Type	Description
`boolean`	The snapshotsEnabled.

getType()

public abstract 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 abstract 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 abstract 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 abstract 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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.