Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class ListBackupVaultsRequest.
Request message for listing backupvault stores.
Generated from protobuf messagegoogle.cloud.backupdr.v1.ListBackupVaultsRequest
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 retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for exampleus-central1. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
↳ page_size
int
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
↳ page_token
string
Optional. A token identifying a page of results the server should return.
↳ filter
string
Optional. Filtering results.
↳ order_by
string
Optional. Hint for how to order the results.
↳ view
int
Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.
getParent
Required. The project and location for which to retrieve backupvault stores
information, in the format 'projects/{project_id}/locations/{location}'. In
Cloud Backup and DR, locations map to Google Cloud regions, for exampleus-central1.
To retrieve backupvault stores for all locations, use "-" for the
'{location}' value.
Returns
Type
Description
string
setParent
Required. The project and location for which to retrieve backupvault stores
information, in the format 'projects/{project_id}/locations/{location}'. In
Cloud Backup and DR, locations map to Google Cloud regions, for exampleus-central1.
To retrieve backupvault stores for all locations, use "-" for the
'{location}' value.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. Requested page size. Server may return fewer items than
requested. If unspecified, server will pick an appropriate default.
Returns
Type
Description
int
setPageSize
Optional. Requested page size. Server may return fewer items than
requested. If unspecified, server will pick an appropriate default.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A token identifying a page of results the server should return.
Returns
Type
Description
string
setPageToken
Optional. A token identifying a page of results the server should return.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. Filtering results.
Returns
Type
Description
string
setFilter
Optional. Filtering results.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Optional. Hint for how to order the results.
Returns
Type
Description
string
setOrderBy
Optional. Hint for how to order the results.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getView
Optional. Reserved for future use to provide a BASIC & FULL view of Backup
Vault.
Returns
Type
Description
int
setView
Optional. Reserved for future use to provide a BASIC & FULL view of Backup
Vault.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The project and location for which to retrieve backupvault stores
information, in the format 'projects/{project_id}/locations/{location}'. In
Cloud Backup and DR, locations map to Google Cloud regions, for exampleus-central1*.
To retrieve backupvault stores 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 ListBackupVaultsRequest (0.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.7.0 (latest)](/php/docs/reference/cloud-backupdr/latest/V1.ListBackupVaultsRequest)\n- [0.6.2](/php/docs/reference/cloud-backupdr/0.6.2/V1.ListBackupVaultsRequest)\n- [0.5.1](/php/docs/reference/cloud-backupdr/0.5.1/V1.ListBackupVaultsRequest)\n- [0.4.2](/php/docs/reference/cloud-backupdr/0.4.2/V1.ListBackupVaultsRequest)\n- [0.3.0](/php/docs/reference/cloud-backupdr/0.3.0/V1.ListBackupVaultsRequest)\n- [0.2.0](/php/docs/reference/cloud-backupdr/0.2.0/V1.ListBackupVaultsRequest)\n- [0.1.0](/php/docs/reference/cloud-backupdr/0.1.0/V1.ListBackupVaultsRequest) \nReference documentation and code samples for the Google Cloud Backup Dr V1 Client class ListBackupVaultsRequest.\n\nRequest message for listing backupvault stores.\n\nGenerated from protobuf message `google.cloud.backupdr.v1.ListBackupVaultsRequest`\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 backupvault stores\ninformation, in the format 'projects/{project_id}/locations/{location}'. In\nCloud Backup and DR, locations map to Google Cloud regions, for example\n**us-central1**.\n\nTo retrieve backupvault stores for all locations, use \"-\" for the\n'{location}' value.\n\n### setParent\n\nRequired. The project and location for which to retrieve backupvault stores\ninformation, in the format 'projects/{project_id}/locations/{location}'. In\nCloud Backup and DR, locations map to Google Cloud regions, for example\n**us-central1**.\n\nTo retrieve backupvault stores for all locations, use \"-\" for the\n'{location}' value.\n\n### getPageSize\n\nOptional. Requested page size. Server may return fewer items than\nrequested. If unspecified, server will pick an appropriate default.\n\n### setPageSize\n\nOptional. Requested page size. Server may return fewer items than\nrequested. If unspecified, server will pick an appropriate default.\n\n### getPageToken\n\nOptional. A token identifying a page of results the server should return.\n\n### setPageToken\n\nOptional. A token identifying a page of results the server should return.\n\n### getFilter\n\nOptional. Filtering results.\n\n### setFilter\n\nOptional. Filtering results.\n\n### getOrderBy\n\nOptional. Hint for how to order the results.\n\n### setOrderBy\n\nOptional. Hint for how to order the results.\n\n### getView\n\nOptional. Reserved for future use to provide a BASIC \\& FULL view of Backup\nVault.\n\n### setView\n\nOptional. Reserved for future use to provide a BASIC \\& FULL view of Backup\nVault.\n\n### static::build"]]
