Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class TaskStatusUpdateEvent.
TaskStatusUpdateEvent is a delta event on a task indicating that a task has changed.
Generated from protobuf message google.cloud.geminidataanalytics.v1beta.TaskStatusUpdateEvent
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ task_id |
string
Optional. The id of the task that is changed. |
↳ context_id |
string
Optional. The id of the context that the task belongs to. |
↳ status |
TaskStatus
Optional. The new status of the task. |
↳ final |
bool
Optional. Whether this is the last status update expected for this task. |
↳ metadata |
Google\Protobuf\Struct
Optional. Optional metadata to associate with the task update. |
getTaskId
Optional. The id of the task that is changed.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTaskId
Optional. The id of the task that is changed.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContextId
Optional. The id of the context that the task belongs to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setContextId
Optional. The id of the context that the task belongs to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Optional. The new status of the task.
| Returns | |
|---|---|
| Type | Description |
TaskStatus|null |
|
hasStatus
clearStatus
setStatus
Optional. The new status of the task.
| Parameter | |
|---|---|
| Name | Description |
var |
TaskStatus
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFinal
Optional. Whether this is the last status update expected for this task.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setFinal
Optional. Whether this is the last status update expected for this task.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetadata
Optional. Optional metadata to associate with the task update.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasMetadata
clearMetadata
setMetadata
Optional. Optional metadata to associate with the task update.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|