Package com.google.cloud.discoveryengine.v1

Class Engine.ChatEngineConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig
All Implemented Interfaces:
Engine.ChatEngineConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Engine
public static final class Engine.ChatEngineConfig extends com.google.protobuf.GeneratedMessage implements Engine.ChatEngineConfigOrBuilder
 Configurations for a Chat Engine.
Protobuf type google.cloud.discoveryengine.v1.Engine.ChatEngineConfig
See Also:

  • Field Details

    • AGENT_CREATION_CONFIG_FIELD_NUMBER

      public static final int AGENT_CREATION_CONFIG_FIELD_NUMBER
      See Also:

    • ALLOW_CROSS_REGION_FIELD_NUMBER

      public static final int ALLOW_CROSS_REGION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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][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;
      Specified by:
      hasAgentCreationConfig in interface Engine.ChatEngineConfigOrBuilder
      Returns:
      Whether the agentCreationConfig field is set.

    • 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][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;
      Specified by:
      getAgentCreationConfig in interface Engine.ChatEngineConfigOrBuilder
      Returns:
      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][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;
      Specified by:
      getAgentCreationConfigOrBuilder in interface Engine.ChatEngineConfigOrBuilder

    • getDialogflowAgentToLink

      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][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;
      Specified by:
      getDialogflowAgentToLink in interface Engine.ChatEngineConfigOrBuilder
      Returns:
      The dialogflowAgentToLink.

    • getDialogflowAgentToLinkBytes

      public 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;
      Specified by:
      getDialogflowAgentToLinkBytes in interface Engine.ChatEngineConfigOrBuilder
      Returns:
      The bytes for dialogflowAgentToLink.

    • getAllowCrossRegion

      public 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];
      Specified by:
      getAllowCrossRegion in interface Engine.ChatEngineConfigOrBuilder
      Returns:
      The allowCrossRegion.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Engine.ChatEngineConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Engine.ChatEngineConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Engine.ChatEngineConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Engine.ChatEngineConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Engine.ChatEngineConfig.Builder newBuilder()

    • newBuilder

      public static Engine.ChatEngineConfig.Builder newBuilder(Engine.ChatEngineConfig prototype)

    • toBuilder

      public Engine.ChatEngineConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Engine.ChatEngineConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Engine.ChatEngineConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Engine.ChatEngineConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<Engine.ChatEngineConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Engine.ChatEngineConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder