Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class ListBackupsRequest.
Request message for ListBackups.
Generated from protobuf messagegoogle.cloud.gkebackup.v1.ListBackupsRequest
Namespace
Google \ Cloud \ GkeBackup \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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'snext_page_tokento determine if there are more instances left to be queried.
↳ page_token
string
Optional. The value ofnext_page_tokenreceived from a previousListBackupscall. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided toListBackupsmust 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/*
Returns
Type
Description
string
setParent
Required. The BackupPlan that contains the Backups to list.
Format:projects/*/locations/*/backupPlans/*
Parameter
Name
Description
var
string
Returns
Type
Description
$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'snext_page_tokento determine if there are more instances left to be queried.
Returns
Type
Description
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'snext_page_tokento determine if there are more instances left to be queried.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. The value ofnext_page_tokenreceived from a previousListBackupscall.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided toListBackupsmust match the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. The value ofnext_page_tokenreceived from a previousListBackupscall.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided toListBackupsmust match the call that provided the page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. Field match expression used to filter the results.
Returns
Type
Description
string
setFilter
Optional. Field match expression used to filter the results.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Optional. Field by which to sort the results.
Returns
Type
Description
string
setOrderBy
Optional. Field by which to sort the results.
Parameter
Name
Description
var
string
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The BackupPlan that contains the Backups to list.
Format:projects/*/locations/*/backupPlans/*Please seeBackupForGKEClient::backupPlanName()for help formatting this field.
[[["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-04 UTC."],[],[],null,["# Google Cloud Gke Backup V1 Client - Class ListBackupsRequest (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-gke-backup/latest/V1.ListBackupsRequest)\n- [1.2.0](/php/docs/reference/cloud-gke-backup/1.2.0/V1.ListBackupsRequest)\n- [1.0.3](/php/docs/reference/cloud-gke-backup/1.0.3/V1.ListBackupsRequest)\n- [0.8.1](/php/docs/reference/cloud-gke-backup/0.8.1/V1.ListBackupsRequest)\n- [0.7.2](/php/docs/reference/cloud-gke-backup/0.7.2/V1.ListBackupsRequest)\n- [0.6.0](/php/docs/reference/cloud-gke-backup/0.6.0/V1.ListBackupsRequest)\n- [0.5.3](/php/docs/reference/cloud-gke-backup/0.5.3/V1.ListBackupsRequest)\n- [0.4.0](/php/docs/reference/cloud-gke-backup/0.4.0/V1.ListBackupsRequest)\n- [0.3.1](/php/docs/reference/cloud-gke-backup/0.3.1/V1.ListBackupsRequest)\n- [0.2.0](/php/docs/reference/cloud-gke-backup/0.2.0/V1.ListBackupsRequest)\n- [0.1.7](/php/docs/reference/cloud-gke-backup/0.1.7/V1.ListBackupsRequest) \nReference documentation and code samples for the Google Cloud Gke Backup V1 Client class ListBackupsRequest.\n\nRequest message for ListBackups.\n\nGenerated from protobuf message `google.cloud.gkebackup.v1.ListBackupsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeBackup \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The BackupPlan that contains the Backups to list.\n\nFormat: `projects/*/locations/*/backupPlans/*`\n\n### setParent\n\nRequired. The BackupPlan that contains the Backups to list.\n\nFormat: `projects/*/locations/*/backupPlans/*`\n\n### getPageSize\n\nOptional. The target number of results to return in a single response.\n\nIf not specified, a default value will be chosen by the service.\nNote that the response may include a partial list and a caller should\nonly rely on the response's\n[next_page_token](/php/docs/reference/cloud-gke-backup/latest/V1.ListBackupsResponse#_Google_Cloud_GkeBackup_V1_ListBackupsResponse__getNextPageToken__)\nto determine if there are more instances left to be queried.\n\n### setPageSize\n\nOptional. The target number of results to return in a single response.\n\nIf not specified, a default value will be chosen by the service.\nNote that the response may include a partial list and a caller should\nonly rely on the response's\n[next_page_token](/php/docs/reference/cloud-gke-backup/latest/V1.ListBackupsResponse#_Google_Cloud_GkeBackup_V1_ListBackupsResponse__getNextPageToken__)\nto determine if there are more instances left to be queried.\n\n### getPageToken\n\nOptional. The value of\n[next_page_token](/php/docs/reference/cloud-gke-backup/latest/V1.ListBackupsResponse#_Google_Cloud_GkeBackup_V1_ListBackupsResponse__getNextPageToken__)\nreceived from a previous `ListBackups` call.\n\nProvide this to retrieve the subsequent page in a multi-page list of\nresults. When paginating, all other parameters provided to\n`ListBackups` must match the call that provided the page token.\n\n### setPageToken\n\nOptional. The value of\n[next_page_token](/php/docs/reference/cloud-gke-backup/latest/V1.ListBackupsResponse#_Google_Cloud_GkeBackup_V1_ListBackupsResponse__getNextPageToken__)\nreceived from a previous `ListBackups` call.\n\nProvide this to retrieve the subsequent page in a multi-page list of\nresults. When paginating, all other parameters provided to\n`ListBackups` must match the call that provided the page token.\n\n### getFilter\n\nOptional. Field match expression used to filter the results.\n\n### setFilter\n\nOptional. Field match expression used to filter the results.\n\n### getOrderBy\n\nOptional. Field by which to sort the results.\n\n### setOrderBy\n\nOptional. Field by which to sort the results.\n\n### getReturnPartialSuccess\n\nOptional. If set to true, the response will return partial results when\nsome regions are unreachable and the unreachable field will be populated.\n\n### setReturnPartialSuccess\n\nOptional. If set to true, the response will return partial results when\nsome regions are unreachable and the unreachable field will be populated.\n\n### static::build"]]
