Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Session.
External session proto definition.
Generated from protobuf message google.cloud.discoveryengine.v1.Session
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. Fully qualified name |
↳ display_name |
string
Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. |
↳ state |
int
The state of the session. |
↳ user_pseudo_id |
string
A unique identifier for tracking users. |
↳ turns |
array<Session\Turn>
Turns. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. The time the session started. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The time the session finished. |
↳ is_pinned |
bool
Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. |
getName
Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. The display name of the session.
This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. The display name of the session.
This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
The state of the session.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
The state of the session.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserPseudoId
A unique identifier for tracking users.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUserPseudoId
A unique identifier for tracking users.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTurns
Turns.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTurns
Turns.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Session\Turn>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Output only. The time the session started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Output only. The time the session started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. The time the session finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. The time the session finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsPinned
Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsPinned
Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|