Google Cloud Filestore V1 Client - Class ListSnapshotsRequest (1.4.0)

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

ListSnapshotsRequest lists snapshots.

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

Namespace

Google \ Cloud \ Filestore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The instance for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.
`↳ page_size`	`int` The maximum number of items to return.
`↳ page_token`	`string` The next_page_token value to use if there are additional results to retrieve for this list request.
`↳ order_by`	`string` Sort results. Supported values are "name", "name desc" or "" (unsorted).
`↳ filter`	`string` List filter.

getParent

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

Returns
Type	Description
`string`

setParent

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The maximum number of items to return.

Returns
Type	Description
`int`

setPageSize

The maximum number of items to return.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

The next_page_token value to use if there are additional results to retrieve for this list request.

Returns
Type	Description
`string`

setPageToken

The next_page_token value to use if there are additional results to retrieve for this list request.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Sort results. Supported values are "name", "name desc" or "" (unsorted).

Returns
Type	Description
`string`

setOrderBy

Sort results. Supported values are "name", "name desc" or "" (unsorted).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

List filter.

Returns
Type	Description
`string`

setFilter

List filter.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The instance for which to retrieve snapshot information, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`. Please see Google\Cloud\Filestore\V1\CloudFilestoreManagerClient::instanceName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Filestore\V1\ListSnapshotsRequest`