Google Cloud Filestore V1 Client - Class Instance (1.2.1)

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

A Filestore instance.

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

Namespace

Google \ Cloud \ Filestore \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

↳ description string

The description of the instance (2048 characters or less).

↳ state int

Output only. The instance state.

↳ status_message string

Output only. Additional information about the instance state, if available.

↳ create_time Google\Protobuf\Timestamp

Output only. The time when the instance was created.

↳ tier int

The service tier of the instance.

↳ labels array|Google\Protobuf\Internal\MapField

Resource labels to represent user provided metadata.

↳ file_shares array<Google\Cloud\Filestore\V1\FileShareConfig>

File system shares on the instance. For this version, only a single file share is supported.

↳ networks array<Google\Cloud\Filestore\V1\NetworkConfig>

VPC networks to which the instance is connected. For this version, only a single network is supported.

↳ etag string

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

↳ satisfies_pzs Google\Protobuf\BoolValue

Output only. Reserved for future use.

↳ kms_key_name string

KMS key name used for data encryption.

↳ suspension_reasons array

Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.

getName

Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

Returns
TypeDescription
string

setName

Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

The description of the instance (2048 characters or less).

Returns
TypeDescription
string

setDescription

The description of the instance (2048 characters or less).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The instance state.

Returns
TypeDescription
int

setState

Output only. The instance state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStatusMessage

Output only. Additional information about the instance state, if available.

Returns
TypeDescription
string

setStatusMessage

Output only. Additional information about the instance state, if available.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The time when the instance was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the instance was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getTier

The service tier of the instance.

Returns
TypeDescription
int

setTier

The service tier of the instance.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLabels

Resource labels to represent user provided metadata.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Resource labels to represent user provided metadata.

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

getFileShares

File system shares on the instance.

For this version, only a single file share is supported.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFileShares

File system shares on the instance.

For this version, only a single file share is supported.

Parameter
NameDescription
var array<Google\Cloud\Filestore\V1\FileShareConfig>
Returns
TypeDescription
$this

getNetworks

VPC networks to which the instance is connected.

For this version, only a single network is supported.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNetworks

VPC networks to which the instance is connected.

For this version, only a single network is supported.

Parameter
NameDescription
var array<Google\Cloud\Filestore\V1\NetworkConfig>
Returns
TypeDescription
$this

getEtag

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

Returns
TypeDescription
string

setEtag

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
TypeDescription
Google\Protobuf\BoolValue|null

hasSatisfiesPzs

clearSatisfiesPzs

getSatisfiesPzsValue

Returns the unboxed value from getSatisfiesPzs()

Output only. Reserved for future use.

Returns
TypeDescription
bool|null

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$this

setSatisfiesPzsValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Output only. Reserved for future use.

Parameter
NameDescription
var bool|null
Returns
TypeDescription
$this

getKmsKeyName

KMS key name used for data encryption.

Returns
TypeDescription
string

setKmsKeyName

KMS key name used for data encryption.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSuspensionReasons

Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSuspensionReasons

Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this