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.
data
array
Optional. Data for populating the Message object.
↳ parent
string
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.
↳ 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.
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.
var
string
$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.
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.
var
int
$this
getPageToken
The next_page_token value to use if there are additional results to retrieve for this list request.
string
setPageToken
The next_page_token value to use if there are additional results to retrieve for this list request.
var
string
$this
getOrderBy
Sort results. Supported values are "name", "name desc" or "" (unsorted).
string
setOrderBy
Sort results. Supported values are "name", "name desc" or "" (unsorted).
var
string
$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
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
var
string
$this
static::build
parent
string
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. Please see NetAppClient::backupVaultName()
for help formatting this field.