1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudFilestore
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsInstancesSnapshots

ProjectsLocationsInstancesSnapshots

class ProjectsLocationsInstancesSnapshots extends Resource (View source)

The "snapshots" collection of methods.

Typical usage is:

 $fileService = new Google\Service\CloudFilestore(...);
 $snapshots = $fileService->projects_locations_instances_snapshots;

Methods

Operation
create(string $parent, Snapshot $postBody, array $optParams = [])

Creates a snapshot. (snapshots.create)

Operation
delete(string $name, array $optParams = [])

Deletes a snapshot. (snapshots.delete)

Snapshot
get(string $name, array $optParams = [])

Gets the details of a specific snapshot. (snapshots.get)

ListSnapshotsResponse
listProjectsLocationsInstancesSnapshots(string $parent, array $optParams = [])

Lists all snapshots in a project for either a specified location or for all locations. (snapshots.listProjectsLocationsInstancesSnapshots)

Operation
patch(string $name, Snapshot $postBody, array $optParams = [])

Updates the settings of a specific snapshot. (snapshots.patch)

Details

at line 50
Operation create(string $parent, Snapshot $postBody, array $optParams = [])

Creates a snapshot. (snapshots.create)

Parameters

string $parent

Required. The Filestore Instance to create the snapshots of, in the format projects/{project_id}/locations/{location}/instances/{instance_id}
Snapshot $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 66
Operation delete(string $name, array $optParams = [])

Deletes a snapshot. (snapshots.delete)

Parameters

string $name

Required. The snapshot resource name, in the format proj ects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{sna pshot_id}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 82
Snapshot get(string $name, array $optParams = [])

Gets the details of a specific snapshot. (snapshots.get)

Parameters

string $name

Required. The snapshot resource name, in the format proj ects/{project_id}/locations/{location}/instances/{instance_id}/snapshots/{sna pshot_id}
array $optParams

Optional parameters.

Return Value

Snapshot

Exceptions

Exception

at line 106
ListSnapshotsResponse listProjectsLocationsInstancesSnapshots(string $parent, array $optParams = [])

Lists all snapshots in a project for either a specified location or for all locations. (snapshots.listProjectsLocationsInstancesSnapshots)

Parameters

string $parent

Required. The instance for which to retrieve snapshot information, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.
array $optParams

Optional parameters.

Return Value

ListSnapshotsResponse

Exceptions

Exception

at line 126
Operation patch(string $name, Snapshot $postBody, array $optParams = [])

Updates the settings of a specific snapshot. (snapshots.patch)

Parameters

string $name

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

Optional parameters.

Return Value

Operation

Exceptions

Exception