Google Cloud Dialogflow Cx V3 Client - Class ListEnvironmentsRequest (0.2.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class ListEnvironmentsRequest.

The request message for Environments.ListEnvironments.

Generated from protobuf message google.cloud.dialogflow.cx.v3.ListEnvironmentsRequest

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The Agent to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

↳ page_size int

The maximum number of items to return in a single page. By default 20 and at most 100.

↳ page_token string

The next_page_token value returned from a previous list request.

getParent

Required. The Agent to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Returns
TypeDescription
string

setParent

Required. The Agent to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of items to return in a single page. By default 20 and at most 100.

Returns
TypeDescription
int

setPageSize

The maximum number of items to return in a single page. By default 20 and at most 100.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The next_page_token value returned from a previous list request.

Returns
TypeDescription
string

setPageToken

The next_page_token value returned from a previous list request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The Agent to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. Please see Google\Cloud\Dialogflow\Cx\V3\EnvironmentsClient::agentName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Dialogflow\Cx\V3\ListEnvironmentsRequest