Google Cloud Dialogflow V2 Client - Class ListContextsRequest (1.14.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ListContextsRequest.

The request message for Contexts.ListContexts.

Generated from protobuf message google.cloud.dialogflow.v2.ListContextsRequest

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.
↳ page_size int

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
↳ page_token string

Optional. The next_page_token value returned from a previous list request.

getParent

Required. The session to list all contexts from.

Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

Returns
Type Description
string

setParent

Required. The session to list all contexts from.

Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

Returns
Type Description
int

setPageSize

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

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The next_page_token value returned from a previous list request.

Returns
Type Description
string

setPageToken

Optional. The next_page_token value returned from a previous list request.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The session to list all contexts from. Format: projects/<Project ID>/agent/sessions/<Session ID> or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. Please see Google\Cloud\Dialogflow\V2\ContextsClient::sessionName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dialogflow\V2\ListContextsRequest