Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Conversation.
External conversation proto definition.
Generated from protobuf message google.cloud.discoveryengine.v1.Conversation
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 |
↳ state |
int
The state of the Conversation. |
↳ user_pseudo_id |
string
A unique identifier for tracking users. |
↳ messages |
array<ConversationMessage>
Conversation messages. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. The time the conversation started. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The time the conversation finished. |
getName
Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*
or
projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*
or
projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
The state of the Conversation.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
The state of the Conversation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| 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 |
|
getMessages
Conversation messages.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMessages
Conversation messages.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ConversationMessage>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Output only. The time the conversation started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Output only. The time the conversation started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Output only. The time the conversation finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Output only. The time the conversation finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|