Google Cloud Gke Backup V1 Client - Class ListBackupsRequest (0.3.1)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class ListBackupsRequest.

Request message for ListBackups.

Generated from protobuf message google.cloud.gkebackup.v1.ListBackupsRequest

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The BackupPlan that contains the Backups to list. Format: projects/*/locations/*/backupPlans/*

↳ page_size int

The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

↳ page_token string

The value of next_page_token received from a previous ListBackups call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackups must match the call that provided the page token.

↳ filter string

Field match expression used to filter the results.

↳ order_by string

Field by which to sort the results.

getParent

Required. The BackupPlan that contains the Backups to list.

Format: projects/*/locations/*/backupPlans/*

Returns
TypeDescription
string

setParent

Required. The BackupPlan that contains the Backups to list.

Format: projects/*/locations/*/backupPlans/*

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The target number of results to return in a single response.

If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

Returns
TypeDescription
int

setPageSize

The target number of results to return in a single response.

If not specified, a default value will be chosen by the service. Note that the response may inclue a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The value of next_page_token received from a previous ListBackups call.

Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackups must match the call that provided the page token.

Returns
TypeDescription
string

setPageToken

The value of next_page_token received from a previous ListBackups call.

Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackups must match the call that provided the page token.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Field match expression used to filter the results.

Returns
TypeDescription
string

setFilter

Field match expression used to filter the results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Field by which to sort the results.

Returns
TypeDescription
string

setOrderBy

Field by which to sort the results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The BackupPlan that contains the Backups to list. Format: projects/*/locations/*/backupPlans/* Please see Google\Cloud\GkeBackup\V1\BackupForGKEClient::backupPlanName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\ListBackupsRequest