Google Cloud Backup Dr V1 Client - Class ListBackupPlanRevisionsRequest (0.7.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class ListBackupPlanRevisionsRequest.

The request message for getting a list of BackupPlanRevision.

Generated from protobuf message google.cloud.backupdr.v1.ListBackupPlanRevisionsRequest

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 BackupPlanRevisions information. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}. In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1.

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

getParent

Required. The project and location for which to retrieve BackupPlanRevisions information. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}. In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1.

Returns
Type Description
string

setParent

Required. The project and location for which to retrieve BackupPlanRevisions information. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}. In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1.

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

static::build

Parameter
Name Description
parent string

Required. The project and location for which to retrieve BackupPlanRevisions information. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}. In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1. Please see BackupDRClient::backupPlanName() for help formatting this field.

Returns
Type Description
ListBackupPlanRevisionsRequest