Google Cloud Game Servers V1 Client - Class ListRealmsRequest (1.2.6)

Version latest

• 1.2.6 (latest)
• 1.2.5
• 1.1.1
• 1.0.5

Reference documentation and code samples for the Google Cloud Game Servers V1 Client class ListRealmsRequest.

Request message for RealmsService.ListRealms.

Generated from protobuf message google.cloud.gaming.v1.ListRealmsRequest

Namespace

Google \ Cloud \ Gaming \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent resource name, in the following form: projects/{project}/locations/{location}.
↳ page_size	int Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more realms left to be queried.
↳ page_token	string Optional. The next_page_token value returned from a previous List request, if any.
↳ filter	string Optional. The filter to apply to list results.
↳ order_by	string Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

getParent

Required. The parent resource name, in the following form: projects/{project}/locations/{location}.

Returns
Type	Description
string

setParent

Required. The parent resource name, in the following form: projects/{project}/locations/{location}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more realms left to be queried.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more realms left to be queried.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. The next_page_token value returned from a previous List request, if any.

Returns
Type	Description
string

setPageToken

Optional. The next_page_token value returned from a previous List request, if any.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Optional. The filter to apply to list results.

Returns
Type	Description
string

setFilter

Optional. The filter to apply to list results.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Returns
Type	Description
string

setOrderBy

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The parent resource name, in the following form: projects/{project}/locations/{location}. Please see Google\Cloud\Gaming\V1\RealmsServiceClient::locationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Gaming\V1\ListRealmsRequest