Class Engine.ChatEngineConfig (0.39.0)

public static final class Engine.ChatEngineConfig extends GeneratedMessageV3 implements Engine.ChatEngineConfigOrBuilder

Configurations for a Chat Engine.

Protobuf type google.cloud.discoveryengine.v1alpha.Engine.ChatEngineConfig

Static Fields

AGENT_CREATION_CONFIG_FIELD_NUMBER

public static final int AGENT_CREATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
public static final int DIALOGFLOW_AGENT_TO_LINK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Engine.ChatEngineConfig getDefaultInstance()
Returns
Type Description
Engine.ChatEngineConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Engine.ChatEngineConfig.Builder newBuilder()
Returns
Type Description
Engine.ChatEngineConfig.Builder

newBuilder(Engine.ChatEngineConfig prototype)

public static Engine.ChatEngineConfig.Builder newBuilder(Engine.ChatEngineConfig prototype)
Parameter
Name Description
prototype Engine.ChatEngineConfig
Returns
Type Description
Engine.ChatEngineConfig.Builder

parseDelimitedFrom(InputStream input)

public static Engine.ChatEngineConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine.ChatEngineConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Engine.ChatEngineConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Engine.ChatEngineConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Engine.ChatEngineConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Engine.ChatEngineConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Engine.ChatEngineConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine.ChatEngineConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Engine.ChatEngineConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Engine.ChatEngineConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Engine.ChatEngineConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Engine.ChatEngineConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Engine.ChatEngineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Engine.ChatEngineConfig> parser()
Returns
Type Description
Parser<ChatEngineConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAgentCreationConfig()

public 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 or EngineService.ListEngines API after engine creation.

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

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfig

The agentCreationConfig.

getAgentCreationConfigOrBuilder()

public 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 or EngineService.ListEngines API after engine creation.

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

Returns
Type Description
Engine.ChatEngineConfig.AgentCreationConfigOrBuilder

getDefaultInstanceForType()

public Engine.ChatEngineConfig getDefaultInstanceForType()
Returns
Type Description
Engine.ChatEngineConfig
public 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 or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.

string dialogflow_agent_to_link = 2;

Returns
Type Description
String

The dialogflowAgentToLink.

getDialogflowAgentToLinkBytes()

public 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 or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.

string dialogflow_agent_to_link = 2;

Returns
Type Description
ByteString

The bytes for dialogflowAgentToLink.

getParserForType()

public Parser<Engine.ChatEngineConfig> getParserForType()
Returns
Type Description
Parser<ChatEngineConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAgentCreationConfig()

public 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 or EngineService.ListEngines API after engine creation.

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

Returns
Type Description
boolean

Whether the agentCreationConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Engine.ChatEngineConfig.Builder newBuilderForType()
Returns
Type Description
Engine.ChatEngineConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Engine.ChatEngineConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Engine.ChatEngineConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Engine.ChatEngineConfig.Builder toBuilder()
Returns
Type Description
Engine.ChatEngineConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException