Google Cloud Lustre V1 Client - Class ListMirrorsRequest (0.6.0)

Reference documentation and code samples for the Google Cloud Lustre V1 Client class ListMirrorsRequest.

Request for ListMirrors.

Generated from protobuf message google.cloud.lustre.v1.ListMirrorsRequest

Namespace

Google \ Cloud \ Lustre \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Parent instance resource where the mirrors will be listed, in the format: projects/{project}/locations/{location}/instances/{instance}

↳ page_size int

Optional. Requested page size. The server might return fewer items than requested. If unspecified, the default page size is 10. The maximum value is 1000.

↳ page_token string

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

↳ order_by string

Optional. Desired order of results.

↳ filter string

Optional. Filtering results.

getParent

Required. Parent instance resource where the mirrors will be listed, in the format: projects/{project}/locations/{location}/instances/{instance}

Returns
Type Description
string

setParent

Required. Parent instance resource where the mirrors will be listed, in the format: projects/{project}/locations/{location}/instances/{instance}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Requested page size. The server might return fewer items than requested. If unspecified, the default page size is 10. The maximum value is 1000.

Returns
Type Description
int

setPageSize

Optional. Requested page size. The server might return fewer items than requested. If unspecified, the default page size is 10. The maximum value is 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

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

Returns
Type Description
string

setPageToken

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Desired order of results.

Returns
Type Description
string

setOrderBy

Optional. Desired order of results.

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

static::build

Parameter
Name Description
parent string

Required. Parent instance resource where the mirrors will be listed, in the format: projects/{project}/locations/{location}/instances/{instance} Please see LustreClient::instanceName() for help formatting this field.

Returns
Type Description
ListMirrorsRequest