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 \ V1Methods
__construct
Constructor.
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
Optional. 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 include 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
Optional. 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
Optional. Field match expression used to filter the results.
↳ order_by
string
Optional. Field by which to sort the results.
↳ return_partial_success
bool
Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated.
getParent
Required. The BackupPlan that contains the Backups to list.
Format: projects/*/locations/*/backupPlans/*
string
setParent
Required. The BackupPlan that contains the Backups to list.
Format: projects/*/locations/*/backupPlans/*
var
string
$this
getPageSize
Optional. 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 include 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.
int
setPageSize
Optional. 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 include 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.
var
int
$this
getPageToken
Optional. 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.
string
setPageToken
Optional. 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.
var
string
$this
getFilter
Optional. Field match expression used to filter the results.
string
setFilter
Optional. Field match expression used to filter the results.
var
string
$this
getOrderBy
Optional. Field by which to sort the results.
string
setOrderBy
Optional. Field by which to sort the results.
var
string
$this
getReturnPartialSuccess
Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated.
bool
setReturnPartialSuccess
Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field will be populated.
var
bool
$this
static::build
parent
string
Required. The BackupPlan that contains the Backups to list.
Format: projects/*/locations/*/backupPlans/*
Please see BackupForGKEClient::backupPlanName()
for help formatting this field.
