Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class ListBackupPlansRequest.
The request message for getting a listBackupPlan.
Generated from protobuf messagegoogle.cloud.backupdr.v1.ListBackupPlansRequest
Namespace
Google \ Cloud \ BackupDR \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The project and location for which to retrieveBackupPlansinformation. Format:projects/{project}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for e.g.us-central1. To retrieve backup plans for all locations, use "-" for the{location}value.
↳ page_size
int
Optional. The maximum number ofBackupPlansto 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 previousListBackupPlanscall. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided toListBackupPlansmust 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.
getParent
Required. The project and location for which to retrieveBackupPlansinformation. Format:projects/{project}/locations/{location}. In Cloud
BackupDR, locations map to GCP regions, for e.g.us-central1. To
retrieve backup plans for all locations, use "-" for the{location}value.
Returns
Type
Description
string
setParent
Required. The project and location for which to retrieveBackupPlansinformation. Format:projects/{project}/locations/{location}. In Cloud
BackupDR, locations map to GCP regions, for e.g.us-central1. To
retrieve backup plans for all locations, use "-" for the{location}value.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number ofBackupPlansto 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 maximum number ofBackupPlansto 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 previousListBackupPlanscall.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided toListBackupPlansmust match the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. The value ofnext_page_tokenreceived from a previousListBackupPlanscall.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided toListBackupPlansmust 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
static::build
Parameter
Name
Description
parent
string
Required. The project and location for which to retrieveBackupPlansinformation. Format:projects/{project}/locations/{location}. In Cloud
BackupDR, locations map to GCP regions, for e.g.us-central1. To
retrieve backup plans for all locations, use "-" for the{location}value. Please seeBackupDRClient::locationName()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 Backup Dr V1 Client - Class ListBackupPlansRequest (0.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.7.0 (latest)](/php/docs/reference/cloud-backupdr/latest/V1.ListBackupPlansRequest)\n- [0.6.2](/php/docs/reference/cloud-backupdr/0.6.2/V1.ListBackupPlansRequest)\n- [0.5.1](/php/docs/reference/cloud-backupdr/0.5.1/V1.ListBackupPlansRequest)\n- [0.4.2](/php/docs/reference/cloud-backupdr/0.4.2/V1.ListBackupPlansRequest)\n- [0.3.0](/php/docs/reference/cloud-backupdr/0.3.0/V1.ListBackupPlansRequest)\n- [0.2.0](/php/docs/reference/cloud-backupdr/0.2.0/V1.ListBackupPlansRequest)\n- [0.1.0](/php/docs/reference/cloud-backupdr/0.1.0/V1.ListBackupPlansRequest) \nReference documentation and code samples for the Google Cloud Backup Dr V1 Client class ListBackupPlansRequest.\n\nThe request message for getting a list `BackupPlan`.\n\nGenerated from protobuf message `google.cloud.backupdr.v1.ListBackupPlansRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BackupDR \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The project and location for which to retrieve `BackupPlans`\ninformation. Format: `projects/{project}/locations/{location}`. In Cloud\nBackupDR, locations map to GCP regions, for e.g. **us-central1** . To\nretrieve backup plans for all locations, use \"-\" for the\n`{location}` value.\n\n### setParent\n\nRequired. The project and location for which to retrieve `BackupPlans`\ninformation. Format: `projects/{project}/locations/{location}`. In Cloud\nBackupDR, locations map to GCP regions, for e.g. **us-central1** . To\nretrieve backup plans for all locations, use \"-\" for the\n`{location}` value.\n\n### getPageSize\n\nOptional. The maximum number of `BackupPlans` to return in a single\nresponse. If not specified, a default value will be chosen by the service.\n\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-backupdr/latest/V1.ListBackupPlansResponse#_Google_Cloud_BackupDR_V1_ListBackupPlansResponse__getNextPageToken__)\nto determine if there are more instances left to be queried.\n\n### setPageSize\n\nOptional. The maximum number of `BackupPlans` to return in a single\nresponse. If not specified, a default value will be chosen by the service.\n\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-backupdr/latest/V1.ListBackupPlansResponse#_Google_Cloud_BackupDR_V1_ListBackupPlansResponse__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-backupdr/latest/V1.ListBackupPlansResponse#_Google_Cloud_BackupDR_V1_ListBackupPlansResponse__getNextPageToken__)\nreceived from a previous `ListBackupPlans` call.\n\nProvide this to retrieve the subsequent page in a multi-page list of\nresults. When paginating, all other parameters provided to\n`ListBackupPlans` 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-backupdr/latest/V1.ListBackupPlansResponse#_Google_Cloud_BackupDR_V1_ListBackupPlansResponse__getNextPageToken__)\nreceived from a previous `ListBackupPlans` call.\n\nProvide this to retrieve the subsequent page in a multi-page list of\nresults. When paginating, all other parameters provided to\n`ListBackupPlans` 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### static::build"]]
