Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1 Client class Conversation.
Message for a conversation.
Generated from protobuf message google.cloud.geminidataanalytics.v1.Conversation
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Optional. Identifier. The unique resource name of a conversation. Format: |
↳ agents |
string[]
Required. Agent(s) in the conversation. Currently, only one agent is supported. This field is repeated to allow for future support of multiple agents in a conversation. Format: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Creation timestamp. |
↳ last_used_time |
Google\Protobuf\Timestamp
Output only. Timestamp of the last used conversation. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Open-ended and user-defined labels that can be set by the client to tag a conversation (e.g. to filter conversations for specific surfaces/products). |
↳ kms_key |
string
Optional. Customer managed encryption key (CMEK) to use for encrypting the Conversation resources. Encryption will happen at Titan layer, we will pass the KMS key to Titan. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_name}/cryptoKeys/{key_name}. |
↳ memory_paused |
bool
Optional. Whether memory is paused for this conversation. |
getName
Optional. Identifier. The unique resource name of a conversation. Format:
projects/{project}/locations/{location}/conversations/{conversation_id}
{conversation_id} is the resource id and should be 63 characters or less
and must match the format described in
https://google.aip.dev/122#resource-id-segments
Example:
projects/1234567890/locations/global/conversations/my-conversation.
It is recommended to skip setting this field during conversation creation as it will be inferred automatically and overwritten with the {parent}/conversations/{conversation_id}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Optional. Identifier. The unique resource name of a conversation. Format:
projects/{project}/locations/{location}/conversations/{conversation_id}
{conversation_id} is the resource id and should be 63 characters or less
and must match the format described in
https://google.aip.dev/122#resource-id-segments
Example:
projects/1234567890/locations/global/conversations/my-conversation.
It is recommended to skip setting this field during conversation creation as it will be inferred automatically and overwritten with the {parent}/conversations/{conversation_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAgents
Required. Agent(s) in the conversation.
Currently, only one agent is supported. This field is repeated to allow
for future support of multiple agents in a conversation.
Format: projects/{project}/locations/{location}/dataAgents/{agent}
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAgents
Required. Agent(s) in the conversation.
Currently, only one agent is supported. This field is repeated to allow
for future support of multiple agents in a conversation.
Format: projects/{project}/locations/{location}/dataAgents/{agent}
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Creation timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastUsedTime
Output only. Timestamp of the last used conversation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastUsedTime
clearLastUsedTime
setLastUsedTime
Output only. Timestamp of the last used conversation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Open-ended and user-defined labels that can be set by the client to tag a conversation (e.g. to filter conversations for specific surfaces/products).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Open-ended and user-defined labels that can be set by the client to tag a conversation (e.g. to filter conversations for specific surfaces/products).
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKey
Optional. Customer managed encryption key (CMEK) to use for encrypting the Conversation resources. Encryption will happen at Titan layer, we will pass the KMS key to Titan.
Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_name}/cryptoKeys/{key_name}.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKmsKey
clearKmsKey
setKmsKey
Optional. Customer managed encryption key (CMEK) to use for encrypting the Conversation resources. Encryption will happen at Titan layer, we will pass the KMS key to Titan.
Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_name}/cryptoKeys/{key_name}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMemoryPaused
Optional. Whether memory is paused for this conversation.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasMemoryPaused
clearMemoryPaused
setMemoryPaused
Optional. Whether memory is paused for this conversation.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|