Google Cloud Filestore V1 Client - Class Snapshot (1.4.0)

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

A Filestore snapshot.

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

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 snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

↳ description string

A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.

↳ state int

Output only. The snapshot state.

↳ create_time Google\Protobuf\Timestamp

Output only. The time when the snapshot was created.

↳ labels array|Google\Protobuf\Internal\MapField

Resource labels to represent user provided metadata.

↳ filesystem_used_bytes int|string

Output only. The amount of bytes needed to allocate a full copy of the snapshot content

getName

Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

Returns
TypeDescription
string

setName

Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

A description of the snapshot with 2048 characters or less.

Requests with longer descriptions will be rejected.

Returns
TypeDescription
string

setDescription

A description of the snapshot with 2048 characters or less.

Requests with longer descriptions will be rejected.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The snapshot state.

Returns
TypeDescription
int

setState

Output only. The snapshot state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. The time when the snapshot was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the snapshot was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
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

getFilesystemUsedBytes

Output only. The amount of bytes needed to allocate a full copy of the snapshot content

Returns
TypeDescription
int|string

setFilesystemUsedBytes

Output only. The amount of bytes needed to allocate a full copy of the snapshot content

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this