Google Cloud Discovery Engine V1 Client - Class CreateSessionRequest (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CreateSessionRequest.

Request for CreateSession method.

Generated from protobuf message google.cloud.discoveryengine.v1.CreateSessionRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Full resource name of parent data store. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

↳ session Session

Required. The session to create.

↳ session_id string

Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-]{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.

getParent

Required. Full resource name of parent data store. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

Returns
Type Description
string

setParent

Required. Full resource name of parent data store. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getSession

Required. The session to create.

Returns
Type Description
Session|null

hasSession

clearSession

setSession

Required. The session to create.

Parameter
Name Description
var Session
Returns
Type Description
$this

getSessionId

Optional. The ID to use for the session, which will become the final component of the session's resource name.

This value should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-]{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.

Returns
Type Description
string

setSessionId

Optional. The ID to use for the session, which will become the final component of the session's resource name.

This value should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-]{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. Full resource name of parent data store. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id} Please see ConversationalSearchServiceClient::dataStoreName() for help formatting this field.

session Session

Required. The session to create.

Returns
Type Description
CreateSessionRequest