Google Cloud Backup Dr V1 Client - Class ListManagementServersRequest (0.3.0)

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

Request message for listing management servers.

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

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 management servers information, in the format projects/{project_id}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for example us-central1. To retrieve management servers for all locations, use "-" for the {location} value.
↳ page_size int

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
↳ page_token string

Optional. A token identifying a page of results the server should return.
↳ filter string

Optional. Filtering results.
↳ order_by string

Optional. Hint for how to order the results.

getParent

Required. The project and location for which to retrieve management servers information, in the format projects/{project_id}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for example us-central1.

To retrieve management servers for all locations, use "-" for the {location} value.

Returns
Type Description
string

setParent

Required. The project and location for which to retrieve management servers information, in the format projects/{project_id}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for example us-central1.

To retrieve management servers for all locations, use "-" for the {location} value.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Returns
Type Description
int

setPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A token identifying a page of results the server should return.

Returns
Type Description
string

setPageToken

Optional. A token identifying a page of results the server should return.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filtering results.

Returns
Type Description
string

hasFilter

clearFilter

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

hasOrderBy

clearOrderBy

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 project and location for which to retrieve management servers information, in the format projects/{project_id}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for example us-central1. To retrieve management servers 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\ListManagementServersRequest