# Google Cloud Discovery Engine V1 Client - Class ChatEngineConfig (1.11.1)

1.11.1 (latest) 1.11.0 1.10.1 1.9.1 1.8.0 1.7.0 1.6.1 1.5.1 1.4.0 1.3.3 1.2.0 1.1.0 1.0.0 0.11.3 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.1 Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ChatEngineConfig.

Configurations for a Chat Engine.

Generated from protobuf message `google.cloud.discoveryengine.v1.Engine.ChatEngineConfig`

## Namespace

Google \\ Cloud \\ DiscoveryEngine \\ V1 \\ Engine

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ agent_creation_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineConfig.AgentCreationConfig` The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using [EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__) or [EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__) API after engine creation. |
| `↳ dialogflow_agent_to_link` | `string` The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using [EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__) or [EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__) API after engine creation. Use [ChatEngineMetadata.dialogflow_agent](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineMetadata#_Google_Cloud_DiscoveryEngine_V1_Engine_ChatEngineMetadata__getDialogflowAgent__) for actual agent association after Engine is created. |
| `↳ allow_cross_region` | `bool` Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to [EngineService.CreateEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__createEngine__). It means they cannot be retrieved using [EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__) or [EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__) API after engine creation. |

### getAgentCreationConfig

The configurationt generate the Dialogflow agent that is associated to
this Engine.

Note that these configurations are one-time consumed by
and passed to Dialogflow service. It means they cannot be retrieved using
[EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)
or
[EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)
API after engine creation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineConfig.AgentCreationConfig|null` |   |

### hasAgentCreationConfig

### clearAgentCreationConfig

### setAgentCreationConfig

The configurationt generate the Dialogflow agent that is associated to
this Engine.

Note that these configurations are one-time consumed by
and passed to Dialogflow service. It means they cannot be retrieved using
[EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)
or
[EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)
API after engine creation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineConfig.AgentCreationConfig` |

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

### getDialogflowAgentToLink

The resource name of an exist Dialogflow agent to link to this Chat
Engine. Customers can either provide `agent_creation_config` to create
agent or provide an agent name that links the agent with the Chat engine.

Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>`.
Note that the `dialogflow_agent_to_link` are one-time consumed by and
passed to Dialogflow service. It means they cannot be retrieved using
[EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)
or
[EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)
API after engine creation. Use
[ChatEngineMetadata.dialogflow_agent](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineMetadata#_Google_Cloud_DiscoveryEngine_V1_Engine_ChatEngineMetadata__getDialogflowAgent__)
for actual agent association after Engine is created.

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

### setDialogflowAgentToLink

The resource name of an exist Dialogflow agent to link to this Chat
Engine. Customers can either provide `agent_creation_config` to create
agent or provide an agent name that links the agent with the Chat engine.

Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>`.
Note that the `dialogflow_agent_to_link` are one-time consumed by and
passed to Dialogflow service. It means they cannot be retrieved using
[EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)
or
[EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)
API after engine creation. Use
[ChatEngineMetadata.dialogflow_agent](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineMetadata#_Google_Cloud_DiscoveryEngine_V1_Engine_ChatEngineMetadata__getDialogflowAgent__)
for actual agent association after Engine is created.

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

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

### getAllowCrossRegion

Optional. If the flag set to true, we allow the agent and engine are in
different locations, otherwise the agent and engine are required to be in
the same location. The flag is set to false by default.

Note that the `allow_cross_region` are one-time consumed by and
passed to
[EngineService.CreateEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__createEngine__).
It means they cannot be retrieved using
[EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)
or
[EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)
API after engine creation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setAllowCrossRegion

Optional. If the flag set to true, we allow the agent and engine are in
different locations, otherwise the agent and engine are required to be in
the same location. The flag is set to false by default.

Note that the `allow_cross_region` are one-time consumed by and
passed to
[EngineService.CreateEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__createEngine__).
It means they cannot be retrieved using
[EngineService.GetEngine](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)
or
[EngineService.ListEngines](https://docs.cloud.google.com/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)
API after engine creation.

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

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