Google Cloud Backup Dr V1beta Client - Class ListBindingMatchingResourcesRequest (0.15.1)

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

Request message for List BindingMatchingResources.

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

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The project, location, auto protection policy and binding for which to retrieve BindingMatchingResources information. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1.
↳ page_size int

Optional. The maximum number of BindingMatchingResources to return in a single response. The default page size is 100 and maximum page size is 200. 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 ListBindingMatchingResources call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBindingMatchingResources 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, location, auto protection policy and binding for which to retrieve BindingMatchingResources information. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}.

In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1.

Returns
Type Description
string

setParent

Required. The project, location, auto protection policy and binding for which to retrieve BindingMatchingResources information. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}.

In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of BindingMatchingResources to return in a single response. The default page size is 100 and maximum page size is 200.

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 BindingMatchingResources to return in a single response. The default page size is 100 and maximum page size is 200.

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 ListBindingMatchingResources call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBindingMatchingResources 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 ListBindingMatchingResources call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBindingMatchingResources 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, location, auto protection policy and binding for which to retrieve BindingMatchingResources information. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. Please see BackupDRClient::autoProtectionPolicyBindingName() for help formatting this field.
Returns
Type Description
ListBindingMatchingResourcesRequest