Reference documentation and code samples for the Google Cloud Filestore V1 Client class Snapshot.
A Filestore snapshot.
Generated from protobuf messagegoogle.cloud.filestore.v1.Snapshot
Namespace
Google \ Cloud \ Filestore \ V1
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 formatprojects/{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.
Output only. The resource name of the snapshot, in the formatprojects/{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 formatprojects/{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
Enum of typeState.
setState
Output only. The snapshot state.
Parameter
Name
Description
var
int
Enum of typeState.
Returns
Type
Description
$this
getCreateTime
Output only. The time when the snapshot was created.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Filestore V1 Client - Class Snapshot (2.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.1 (latest)](/php/docs/reference/cloud-filestore/latest/V1.Snapshot)\n- [2.1.0](/php/docs/reference/cloud-filestore/2.1.0/V1.Snapshot)\n- [2.0.4](/php/docs/reference/cloud-filestore/2.0.4/V1.Snapshot)\n- [1.5.7](/php/docs/reference/cloud-filestore/1.5.7/V1.Snapshot)\n- [1.4.0](/php/docs/reference/cloud-filestore/1.4.0/V1.Snapshot)\n- [1.3.2](/php/docs/reference/cloud-filestore/1.3.2/V1.Snapshot)\n- [1.2.1](/php/docs/reference/cloud-filestore/1.2.1/V1.Snapshot)\n- [1.1.2](/php/docs/reference/cloud-filestore/1.1.2/V1.Snapshot)\n- [1.0.3](/php/docs/reference/cloud-filestore/1.0.3/V1.Snapshot) \nReference documentation and code samples for the Google Cloud Filestore V1 Client class Snapshot.\n\nA Filestore snapshot.\n\nGenerated from protobuf message `google.cloud.filestore.v1.Snapshot`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Filestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The resource name of the snapshot, in the format\n`projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`.\n\n### setName\n\nOutput only. The resource name of the snapshot, in the format\n`projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`.\n\n### getDescription\n\nA description of the snapshot with 2048 characters or less.\n\nRequests with longer descriptions will be rejected.\n\n### setDescription\n\nA description of the snapshot with 2048 characters or less.\n\nRequests with longer descriptions will be rejected.\n\n### getState\n\nOutput only. The snapshot state.\n\n### setState\n\nOutput only. The snapshot state.\n\n### getCreateTime\n\nOutput only. The time when the snapshot was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The time when the snapshot was created.\n\n### getLabels\n\nResource labels to represent user provided metadata.\n\n### setLabels\n\nResource labels to represent user provided metadata.\n\n### getFilesystemUsedBytes\n\nOutput only. The amount of bytes needed to allocate a full copy of the\nsnapshot content\n\n### setFilesystemUsedBytes\n\nOutput only. The amount of bytes needed to allocate a full copy of the\nsnapshot content\n\n### getTags\n\nOptional. Input only. Immutable. Tag key-value pairs bound to this\nresource. Each key must be a namespaced name and each value a short name.\n\nExample:\n\"123456789012/environment\" : \"production\",\n\"123456789013/costCenter\" : \"marketing\"\nSee the documentation for more information:\n\n- Namespaced name: \u003chttps://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key\u003e\n- Short name: \u003chttps://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value\u003e\n\n### setTags\n\nOptional. Input only. Immutable. Tag key-value pairs bound to this\nresource. Each key must be a namespaced name and each value a short name.\n\nExample:\n\"123456789012/environment\" : \"production\",\n\"123456789013/costCenter\" : \"marketing\"\nSee the documentation for more information:\n\n- Namespaced name: \u003chttps://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key\u003e\n- Short name: \u003chttps://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value\u003e"]]
