Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class ListBackupPlansRequest.
The request message for getting a list BackupPlan
.
Generated from protobuf message google.cloud.backupdr.v1.ListBackupPlansRequest
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The project and location for which to retrieve BackupPlans
information. 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 of BackupPlans
to 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's next_page_token
to determine if there are more instances left to be queried.
↳ page_token
string
Optional. The value of next_page_token
received from a previous ListBackupPlans
call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackupPlans
must 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 retrieve BackupPlans
information. 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.
string
setParent
Required. The project and location for which to retrieve BackupPlans
information. 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.
var
string
$this
getPageSize
Optional. The maximum number of BackupPlans
to 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's next_page_token to determine if there are more instances left to be queried.
int
setPageSize
Optional. The maximum number of BackupPlans
to 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's next_page_token to determine if there are more instances left to be queried.
var
int
$this
getPageToken
Optional. The value of next_page_token
received from a previous ListBackupPlans
call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to ListBackupPlans
must match the call that provided the page token.
string
setPageToken
Optional. The value of next_page_token
received from a previous ListBackupPlans
call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to ListBackupPlans
must match the call that provided the page token.
var
string
$this
getFilter
Optional. Field match expression used to filter the results.
string
setFilter
Optional. Field match expression used to filter the results.
var
string
$this
getOrderBy
Optional. Field by which to sort the results.
string
setOrderBy
Optional. Field by which to sort the results.
var
string
$this
static::build
parent
string
Required. The project and location for which to retrieve BackupPlans
information. 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 see BackupDRClient::locationName()
for help formatting this field.
