Package com.google.cloud.discoveryengine.v1

Class Engine.ChatEngineConfig.Builder

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

  • 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.Builder<Engine.ChatEngineConfig.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Engine.ChatEngineConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Engine.ChatEngineConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.ChatEngineConfig.Builder>

    • mergeFrom

      public Engine.ChatEngineConfig.Builder mergeFrom(Engine.ChatEngineConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Engine.ChatEngineConfig.Builder>

    • mergeFrom

      public Engine.ChatEngineConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.ChatEngineConfig.Builder>
      Throws:
      IOException

    • 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.

    • setAgentCreationConfig

      public Engine.ChatEngineConfig.Builder setAgentCreationConfig(Engine.ChatEngineConfig.AgentCreationConfig value)
       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;

    • setAgentCreationConfig

      public Engine.ChatEngineConfig.Builder setAgentCreationConfig(Engine.ChatEngineConfig.AgentCreationConfig.Builder builderForValue)
       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;

    • mergeAgentCreationConfig

      public Engine.ChatEngineConfig.Builder mergeAgentCreationConfig(Engine.ChatEngineConfig.AgentCreationConfig value)
       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;

    • clearAgentCreationConfig

      public Engine.ChatEngineConfig.Builder clearAgentCreationConfig()
       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;

    • getAgentCreationConfigBuilder

      public Engine.ChatEngineConfig.AgentCreationConfig.Builder getAgentCreationConfigBuilder()
       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;

    • 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.

    • setDialogflowAgentToLink

      public Engine.ChatEngineConfig.Builder setDialogflowAgentToLink(String value)
       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;
      Parameters:
      value - The dialogflowAgentToLink to set.
      Returns:
      This builder for chaining.

    • clearDialogflowAgentToLink

      public Engine.ChatEngineConfig.Builder clearDialogflowAgentToLink()
       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:
      This builder for chaining.

    • setDialogflowAgentToLinkBytes

      public Engine.ChatEngineConfig.Builder setDialogflowAgentToLinkBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for dialogflowAgentToLink to set.
      Returns:
      This builder for chaining.

    • 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.

    • setAllowCrossRegion

      public Engine.ChatEngineConfig.Builder setAllowCrossRegion(boolean value)
       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];
      Parameters:
      value - The allowCrossRegion to set.
      Returns:
      This builder for chaining.

    • clearAllowCrossRegion

      public Engine.ChatEngineConfig.Builder clearAllowCrossRegion()
       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:
      This builder for chaining.