Google Cloud Backup Dr V1beta Client - Class ListRestoreVerificationPlanAssociationsRequest (0.17.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class ListRestoreVerificationPlanAssociationsRequest.

Request message for ListRestoreVerificationPlanAssociations.

Generated from protobuf message google.cloud.backupdr.v1beta.ListRestoreVerificationPlanAssociationsRequest

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent RestoreVerificationPlan name. Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}

↳ page_size int

Optional. The maximum number of associations to return. The service may return fewer than this value. If unspecified, at most 500 associations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

Optional. A page token, received from a previous ListRestoreVerificationPlanAssociations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRestoreVerificationPlanAssociations must match the call that provided the page token.

↳ filter string

Optional. Filtering results.

↳ order_by string

Optional. Hint for how to order the results.

getParent

Required. The parent RestoreVerificationPlan name.

Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}

Returns
Type Description
string

setParent

Required. The parent RestoreVerificationPlan name.

Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of associations to return. The service may return fewer than this value.

If unspecified, at most 500 associations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of associations to return. The service may return fewer than this value.

If unspecified, at most 500 associations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous ListRestoreVerificationPlanAssociations call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRestoreVerificationPlanAssociations must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListRestoreVerificationPlanAssociations call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRestoreVerificationPlanAssociations must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filtering results.

Returns
Type Description
string

setFilter

Optional. Filtering results.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Hint for how to order the results.

Returns
Type Description
string

setOrderBy

Optional. Hint for how to order the results.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent RestoreVerificationPlan name. Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan} Please see BackupDRClient::restoreVerificationPlanName() for help formatting this field.

Returns
Type Description
ListRestoreVerificationPlanAssociationsRequest