Google Cloud Lustre V1 Client - Class Instance (0.2.0)

Reference documentation and code samples for the Google Cloud Lustre V1 Client class Instance.

A Managed Lustre instance.

Generated from protobuf message google.cloud.lustre.v1.Instance

Namespace

Google \ Cloud \ Lustre \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The name of the instance.
`↳ filesystem`	`string` Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.
`↳ capacity_gib`	`int\|string` Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from `18000` to `954000`, in increments of 9000.
`↳ network`	`string` Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format `projects/{project_id}/global/networks/{network_name}`.
`↳ state`	`int` Output only. The state of the instance.
`↳ mount_point`	`string` Output only. Mount point of the instance in the format `IP_ADDRESS@tcp:/FILESYSTEM`.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when the instance was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when the instance was last updated.
`↳ description`	`string` Optional. A user-readable description of the instance.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. Labels as key value pairs.
`↳ per_unit_storage_throughput`	`int\|string` Required. The throughput of the instance in MB/s/TiB. Valid values are 125, 250, 500, 1000.
`↳ gke_support_enabled`	`bool` Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported. Deprecated. No longer required for GKE instance creation.

getName

Identifier. The name of the instance.

Returns
Type	Description
`string`

setName

Identifier. The name of the instance.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilesystem

Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.

Returns
Type	Description
`string`

setFilesystem

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCapacityGib

Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.

Returns
Type	Description
`int\|string`

setCapacityGib

Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getNetwork

Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.

Returns
Type	Description
`string`

setNetwork

Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. The state of the instance.

Returns
Type	Description
`int`

setState

Output only. The state of the instance.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getMountPoint

Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.

Returns
Type	Description
`string`

setMountPoint

Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Timestamp when the instance was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when the instance was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Timestamp when the instance was last updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime