Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class ListBackupVaultsRequest.
Request message for listing backupvault stores.
Generated from protobuf message google.cloud.backupdr.v1.ListBackupVaultsRequest
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__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 example us-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 example us-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 example us-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 example us-central1*. To retrieve backupvault stores for all locations, use "-" for the '{location}' value. Please see BackupDRClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListBackupVaultsRequest |
|