Google Cloud Backup Dr V1 Client - Class ListBackupPlansRequest (0.4.0)

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 \ 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 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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Field match expression used to filter the results.

Returns
Type Description
string

setFilter

Optional. Field match expression used to filter the results.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Field by which to sort the results.

Returns
Type Description
string

setOrderBy

Optional. Field by which to sort the results.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
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 Google\Cloud\BackupDR\V1\BackupDRClient::locationName() for help formatting this field.
Returns
Type Description
Google\Cloud\BackupDR\V1\ListBackupPlansRequest