Google Cloud Bare Metal Solution V2 Client - Class NfsShare (0.5.2)

Reference documentation and code samples for the Google Cloud Bare Metal Solution V2 Client class NfsShare.

An NFS share.

Generated from protobuf message google.cloud.baremetalsolution.v2.NfsShare

Namespace

Google \ Cloud \ BareMetalSolution \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. The name of the NFS share.

↳ nfs_share_id string

Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use id instead.

↳ id string

Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.

↳ state int

Output only. The state of the NFS share.

↳ volume string

Output only. The underlying volume of the share. Created automatically during provisioning.

↳ allowed_clients array<Google\Cloud\BareMetalSolution\V2\NfsShare\AllowedClient>

List of allowed access points.

↳ labels array|Google\Protobuf\Internal\MapField

Labels as key value pairs.

↳ requested_size_gib int|string

The requested size, in GiB.

↳ storage_type int

Immutable. The storage type of the underlying volume.

getName

Immutable. The name of the NFS share.

Returns
TypeDescription
string

setName

Immutable. The name of the NFS share.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNfsShareId

Output only. An identifier for the NFS share, generated by the backend.

This field will be deprecated in the future, use id instead.

Returns
TypeDescription
string

setNfsShareId

Output only. An identifier for the NFS share, generated by the backend.

This field will be deprecated in the future, use id instead.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

Output only. An identifier for the NFS share, generated by the backend.

This is the same value as nfs_share_id and will replace it in the future.

Returns
TypeDescription
string

setId

Output only. An identifier for the NFS share, generated by the backend.

This is the same value as nfs_share_id and will replace it in the future.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The state of the NFS share.

Returns
TypeDescription
int

setState

Output only. The state of the NFS share.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getVolume

Output only. The underlying volume of the share. Created automatically during provisioning.

Returns
TypeDescription
string

setVolume

Output only. The underlying volume of the share. Created automatically during provisioning.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAllowedClients

List of allowed access points.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAllowedClients

List of allowed access points.

Parameter
NameDescription
var array<Google\Cloud\BareMetalSolution\V2\NfsShare\AllowedClient>
Returns
TypeDescription
$this

getLabels

Labels as key value pairs.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels as key value pairs.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getRequestedSizeGib

The requested size, in GiB.

Returns
TypeDescription
int|string

setRequestedSizeGib

The requested size, in GiB.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getStorageType

Immutable. The storage type of the underlying volume.

Returns
TypeDescription
int

setStorageType

Immutable. The storage type of the underlying volume.

Parameter
NameDescription
var int
Returns
TypeDescription
$this