Reference documentation and code samples for the Google Cloud Net App V1 Client class ListBackupsRequest.
ListBackupsRequest lists backups.
Generated from protobuf message google.cloud.netapp.v1.ListBackupsRequest
Namespace
Google \ Cloud \ NetApp \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The backupVault for which to retrieve backup information, in the format |
↳ page_size |
int
The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
The next_page_token value to use if there are additional results to retrieve for this list request. |
↳ order_by |
string
Sort results. Supported values are "name", "name desc" or "" (unsorted). |
↳ filter |
string
The standard list filter. If specified, backups will be returned based on the attribute name that matches the filter expression. If empty, then no backups are filtered out. See https://google.aip.dev/160 |
getParent
Required. The backupVault for which to retrieve backup information,
in the format
projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}.
To retrieve backup information for all locations, use "-" for the
{location} value.
To retrieve backup information for all backupVaults, use "-" for the
{backup_vault_id} value.
To retrieve backup information for a volume, use "-" for the
{backup_vault_id} value and specify volume full name with the filter.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The backupVault for which to retrieve backup information,
in the format
projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}.
To retrieve backup information for all locations, use "-" for the
{location} value.
To retrieve backup information for all backupVaults, use "-" for the
{backup_vault_id} value.
To retrieve backup information for a volume, use "-" for the
{backup_vault_id} value and specify volume full name with the filter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
The next_page_token value to use if there are additional results to retrieve for this list request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
The next_page_token value to use if there are additional results to retrieve for this list request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Sort results. Supported values are "name", "name desc" or "" (unsorted).
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Sort results. Supported values are "name", "name desc" or "" (unsorted).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
The standard list filter.
If specified, backups will be returned based on the attribute name that matches the filter expression. If empty, then no backups are filtered out. See https://google.aip.dev/160
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
The standard list filter.
If specified, backups will be returned based on the attribute name that matches the filter expression. If empty, then no backups are filtered out. See https://google.aip.dev/160
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The backupVault for which to retrieve backup information,
in the format
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetApp\V1\ListBackupsRequest |
|