Google Cloud Net App V1 Client - Class BlockDevice (1.10.1)

Reference documentation and code samples for the Google Cloud Net App V1 Client class BlockDevice.

Block device represents the device(s) which are stored in the block volume.

Generated from protobuf message google.cloud.netapp.v1.BlockDevice

Namespace

Google \ Cloud \ NetApp \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * * Be between 1 and 255 characters long. * * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * * Spaces are not allowed.

↳ host_groups array

Optional. A list of host groups that identify hosts that can mount the block volume. Format: projects/{project_id}/locations/{location}/hostGroups/{host_group_id} This field can be updated after the block device is created.

↳ identifier string

Output only. Device identifier of the block volume. This represents lun_serial_number for iSCSI volumes.

↳ size_gib int|string

Optional. The size of the block device in GiB. Any value provided for the size_gib field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's capacity_gib.

↳ os_type int

Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created.

getName

Optional. User-defined name for the block device, unique within the volume.

In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements:

  • Be between 1 and 255 characters long.
  • Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".".
  • Spaces are not allowed.
Returns
Type Description
string

hasName

clearName

setName

Optional. User-defined name for the block device, unique within the volume.

In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements:

  • Be between 1 and 255 characters long.
  • Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".".
  • Spaces are not allowed.
Parameter
Name Description
var string
Returns
Type Description
$this

getHostGroups

Optional. A list of host groups that identify hosts that can mount the block volume. Format: projects/{project_id}/locations/{location}/hostGroups/{host_group_id} This field can be updated after the block device is created.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setHostGroups

Optional. A list of host groups that identify hosts that can mount the block volume. Format: projects/{project_id}/locations/{location}/hostGroups/{host_group_id} This field can be updated after the block device is created.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getIdentifier

Output only. Device identifier of the block volume. This represents lun_serial_number for iSCSI volumes.

Returns
Type Description
string

setIdentifier

Output only. Device identifier of the block volume. This represents lun_serial_number for iSCSI volumes.

Parameter
Name Description
var string
Returns
Type Description
$this

getSizeGib

Optional. The size of the block device in GiB.

Any value provided for the size_gib field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's capacity_gib.

Returns
Type Description
int|string

hasSizeGib

clearSizeGib

setSizeGib

Optional. The size of the block device in GiB.

Any value provided for the size_gib field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's capacity_gib.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getOsType

Required. Immutable. The OS type of the volume.

This field can't be changed after the block device is created.

Returns
Type Description
int Enum of type OsType.

setOsType

Required. Immutable. The OS type of the volume.

This field can't be changed after the block device is created.

Parameter
Name Description
var int

Enum of type OsType.

Returns
Type Description
$this