Google Cloud Apigee Connect V1 Client - Class ListConnectionsRequest (1.2.5)

Reference documentation and code samples for the Google Cloud Apigee Connect V1 Client class ListConnectionsRequest.

The request for ListConnections.

Generated from protobuf message google.cloud.apigeeconnect.v1.ListConnectionsRequest

Namespace

Google \ Cloud \ ApigeeConnect \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Parent name of the form: projects/{project_number or project_id}/endpoints/{endpoint}.

↳ page_size int

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

↳ page_token string

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

getParent

Required. Parent name of the form: projects/{project_number or project_id}/endpoints/{endpoint}.

Returns
Type Description
string

setParent

Required. Parent name of the form: projects/{project_number or project_id}/endpoints/{endpoint}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of connections to return. The service may return fewer than this value. If unspecified, at most 100 connections will be returned.

The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

The maximum number of connections to return. The service may return fewer than this value. If unspecified, at most 100 connections 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

A page token, received from a previous ListConnections call.

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

Returns
Type Description
string

setPageToken

A page token, received from a previous ListConnections call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Parent name of the form: projects/{project_number or project_id}/endpoints/{endpoint}. Please see Google\Cloud\ApigeeConnect\V1\ConnectionServiceClient::endpointName() for help formatting this field.

Returns
Type Description
Google\Cloud\ApigeeConnect\V1\ListConnectionsRequest