com.google.cloud.discoveryengine.v1

Interface Engine.ChatEngineConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Engine.ChatEngineConfig, Engine.ChatEngineConfig.Builder

Enclosing class:

Engine

public static interface Engine.ChatEngineConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Engine.ChatEngineConfig.AgentCreationConfig	getAgentCreationConfig() The configurationt generate the Dialogflow agent that is associated to this Engine.
Engine.ChatEngineConfig.AgentCreationConfigOrBuilder	getAgentCreationConfigOrBuilder() The configurationt generate the Dialogflow agent that is associated to this Engine.
boolean	getAllowCrossRegion() Optional.
String	getDialogflowAgentToLink() The resource name of an exist Dialogflow agent to link to this Chat Engine.
com.google.protobuf.ByteString	getDialogflowAgentToLinkBytes() The resource name of an exist Dialogflow agent to link to this Chat Engine.
boolean	hasAgentCreationConfig() The configurationt generate the Dialogflow agent that is associated to this Engine.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasAgentCreationConfig

boolean hasAgentCreationConfig()

 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][google.cloud.discoveryengine.v1.EngineService.GetEngine]
 or
 [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
 API after engine creation.
 

.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig agent_creation_config = 1;

Returns:

Whether the agentCreationConfig field is set.

getAgentCreationConfig

Engine.ChatEngineConfig.AgentCreationConfig 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][google.cloud.discoveryengine.v1.EngineService.GetEngine]
 or
 [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
 API after engine creation.
 

.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig agent_creation_config = 1;

Returns:

The agentCreationConfig.

getAgentCreationConfigOrBuilder

Engine.ChatEngineConfig.AgentCreationConfigOrBuilder getAgentCreationConfigOrBuilder()

 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][google.cloud.discoveryengine.v1.EngineService.GetEngine]
 or
 [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
 API after engine creation.
 

.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig.AgentCreationConfig agent_creation_config = 1;

getDialogflowAgentToLink

String 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][google.cloud.discoveryengine.v1.EngineService.GetEngine]
 or
 [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
 API after engine creation. Use
 [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent]
 for actual agent association after Engine is created.
 

string dialogflow_agent_to_link = 2;

Returns:

The dialogflowAgentToLink.

getDialogflowAgentToLinkBytes

com.google.protobuf.ByteString getDialogflowAgentToLinkBytes()

 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][google.cloud.discoveryengine.v1.EngineService.GetEngine]
 or
 [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
 API after engine creation. Use
 [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent]
 for actual agent association after Engine is created.
 

string dialogflow_agent_to_link = 2;

Returns:

The bytes for dialogflowAgentToLink.

getAllowCrossRegion

boolean 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][google.cloud.discoveryengine.v1.EngineService.CreateEngine].
 It means they cannot be retrieved using
 [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine]
 or
 [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
 API after engine creation.
 

bool allow_cross_region = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The allowCrossRegion.