0.16.0 (latest) 0.15.0 0.14.1 0.11.1 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.1 Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1 Client class SystemMessage.

A message from the system in response to the user. This message can also be a
message from the user as historical context for multi-turn conversations with
the system.

Generated from protobuf message `google.cloud.geminidataanalytics.v1.SystemMessage`

## Namespace

Google \\ Cloud \\ GeminiDataAnalytics \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ text` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.TextMessage` A direct natural language response to the user message. |
| `↳ schema` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.SchemaMessage` A message produced during schema resolution. |
| `↳ data` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.DataMessage` A message produced during data retrieval. |
| `↳ analysis` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.AnalysisMessage` A message produced during analysis. |
| `↳ chart` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ChartMessage` A message produced during chart generation. |
| `↳ error` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ErrorMessage` An error message. |
| `↳ example_queries` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ExampleQueries` Optional. A message containing example queries. |
| `↳ group_id` | `int` Identifies the group that the event belongs to. Similar events are deemed to be logically relevant to each other and should be shown together in the UI. |
| `↳ citation` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.Citation` Output only. Citation information for the system message. |

### getText

A direct natural language response to the user message.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.TextMessage|null` |   |

### hasText

### setText

A direct natural language response to the user message.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.TextMessage` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSchema

A message produced during schema resolution.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.SchemaMessage|null` |   |

### hasSchema

### setSchema

A message produced during schema resolution.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.SchemaMessage` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getData

A message produced during data retrieval.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.DataMessage|null` |   |

### hasData

### setData

A message produced during data retrieval.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.DataMessage` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAnalysis

A message produced during analysis.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.AnalysisMessage|null` |   |

### hasAnalysis

### setAnalysis

A message produced during analysis.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.AnalysisMessage` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getChart

A message produced during chart generation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ChartMessage|null` |   |

### hasChart

### setChart

A message produced during chart generation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ChartMessage` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getError

An error message.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ErrorMessage|null` |   |

### hasError

### setError

An error message.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ErrorMessage` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getExampleQueries

Optional. A message containing example queries.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ExampleQueries|null` |   |

### hasExampleQueries

### setExampleQueries

Optional. A message containing example queries.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.ExampleQueries` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getGroupId

Identifies the group that the event belongs to. Similar events are deemed
to be logically relevant to each other and should be shown together in
the UI.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### hasGroupId

### clearGroupId

### setGroupId

Identifies the group that the event belongs to. Similar events are deemed
to be logically relevant to each other and should be shown together in
the UI.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCitation

Output only. Citation information for the system message.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.Citation|null` |   |

### hasCitation

### clearCitation

### setCitation

Output only. Citation information for the system message.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-geminidataanalytics/latest/V1.Citation` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getKind

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |