Google Cloud Filestore V1 Client - Class Snapshot (1.1.2)

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

Methods

__construct

Constructor.

Parameters
Name
Description
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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this

getDescription

A description of the snapshot with 2048 characters or less.

Requests with longer descriptions will be rejected.

Returns
Type
Description
string

setDescription

A description of the snapshot with 2048 characters or less.

Requests with longer descriptions will be rejected.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. The snapshot state.

Returns
Type
Description
int

setState

Output only. The snapshot state.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getCreateTime

Output only. The time when the snapshot was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the snapshot was created.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Resource labels to represent user provided metadata.

Returns
Type
Description

setLabels

Resource labels to represent user provided metadata.

Parameter
Name
Description
Returns
Type
Description
$this

getFilesystemUsedBytes

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

Returns
Type
Description
int|string

setFilesystemUsedBytes

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

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: