Package com.google.cloud.discoveryengine.v1beta

Class Engine.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Engine.Builder>
com.google.cloud.discoveryengine.v1beta.Engine.Builder
All Implemented Interfaces:
EngineOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Engine
public static final class Engine.Builder extends com.google.protobuf.GeneratedMessage.Builder<Engine.Builder> implements EngineOrBuilder
 Metadata that describes the training and serving parameters of an
 [Engine][google.cloud.discoveryengine.v1beta.Engine].
Protobuf type google.cloud.discoveryengine.v1beta.Engine

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

    • clear

      public Engine.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.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.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Engine.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.Builder>

    • mergeFrom

      public Engine.Builder mergeFrom(Engine 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.Builder>

    • mergeFrom

      public Engine.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.Builder>
      Throws:
      IOException

    • getEngineConfigCase

      public Engine.EngineConfigCase getEngineConfigCase()
      Specified by:
      getEngineConfigCase in interface EngineOrBuilder

    • clearEngineConfig

      public Engine.Builder clearEngineConfig()

    • getEngineMetadataCase

      public Engine.EngineMetadataCase getEngineMetadataCase()
      Specified by:
      getEngineMetadataCase in interface EngineOrBuilder

    • clearEngineMetadata

      public Engine.Builder clearEngineMetadata()

    • hasChatEngineConfig

      public boolean hasChatEngineConfig()
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;
      Specified by:
      hasChatEngineConfig in interface EngineOrBuilder
      Returns:
      Whether the chatEngineConfig field is set.

    • getChatEngineConfig

      public Engine.ChatEngineConfig getChatEngineConfig()
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;
      Specified by:
      getChatEngineConfig in interface EngineOrBuilder
      Returns:
      The chatEngineConfig.

    • setChatEngineConfig

      public Engine.Builder setChatEngineConfig(Engine.ChatEngineConfig value)
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;

    • setChatEngineConfig

      public Engine.Builder setChatEngineConfig(Engine.ChatEngineConfig.Builder builderForValue)
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;

    • mergeChatEngineConfig

      public Engine.Builder mergeChatEngineConfig(Engine.ChatEngineConfig value)
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;

    • clearChatEngineConfig

      public Engine.Builder clearChatEngineConfig()
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;

    • getChatEngineConfigBuilder

      public Engine.ChatEngineConfig.Builder getChatEngineConfigBuilder()
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;

    • getChatEngineConfigOrBuilder

      public Engine.ChatEngineConfigOrBuilder getChatEngineConfigOrBuilder()
       Configurations for the Chat Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig chat_engine_config = 11;
      Specified by:
      getChatEngineConfigOrBuilder in interface EngineOrBuilder

    • hasSearchEngineConfig

      public boolean hasSearchEngineConfig()
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;
      Specified by:
      hasSearchEngineConfig in interface EngineOrBuilder
      Returns:
      Whether the searchEngineConfig field is set.

    • getSearchEngineConfig

      public Engine.SearchEngineConfig getSearchEngineConfig()
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;
      Specified by:
      getSearchEngineConfig in interface EngineOrBuilder
      Returns:
      The searchEngineConfig.

    • setSearchEngineConfig

      public Engine.Builder setSearchEngineConfig(Engine.SearchEngineConfig value)
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;

    • setSearchEngineConfig

      public Engine.Builder setSearchEngineConfig(Engine.SearchEngineConfig.Builder builderForValue)
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;

    • mergeSearchEngineConfig

      public Engine.Builder mergeSearchEngineConfig(Engine.SearchEngineConfig value)
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;

    • clearSearchEngineConfig

      public Engine.Builder clearSearchEngineConfig()
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;

    • getSearchEngineConfigBuilder

      public Engine.SearchEngineConfig.Builder getSearchEngineConfigBuilder()
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;

    • getSearchEngineConfigOrBuilder

      public Engine.SearchEngineConfigOrBuilder getSearchEngineConfigOrBuilder()
       Configurations for the Search Engine. Only applicable if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
      .google.cloud.discoveryengine.v1beta.Engine.SearchEngineConfig search_engine_config = 13;
      Specified by:
      getSearchEngineConfigOrBuilder in interface EngineOrBuilder

    • hasChatEngineMetadata

      public boolean hasChatEngineMetadata()
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasChatEngineMetadata in interface EngineOrBuilder
      Returns:
      Whether the chatEngineMetadata field is set.

    • getChatEngineMetadata

      public Engine.ChatEngineMetadata getChatEngineMetadata()
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getChatEngineMetadata in interface EngineOrBuilder
      Returns:
      The chatEngineMetadata.

    • setChatEngineMetadata

      public Engine.Builder setChatEngineMetadata(Engine.ChatEngineMetadata value)
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setChatEngineMetadata

      public Engine.Builder setChatEngineMetadata(Engine.ChatEngineMetadata.Builder builderForValue)
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeChatEngineMetadata

      public Engine.Builder mergeChatEngineMetadata(Engine.ChatEngineMetadata value)
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearChatEngineMetadata

      public Engine.Builder clearChatEngineMetadata()
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getChatEngineMetadataBuilder

      public Engine.ChatEngineMetadata.Builder getChatEngineMetadataBuilder()
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getChatEngineMetadataOrBuilder

      public Engine.ChatEngineMetadataOrBuilder getChatEngineMetadataOrBuilder()
       Output only. Additional information of the Chat Engine. Only applicable
 if
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
      .google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getChatEngineMetadataOrBuilder in interface EngineOrBuilder

    • getName

      public String getName()
       Immutable. The fully qualified resource name of the engine.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 engine should be 1-63 characters, and valid characters are
 /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getName in interface EngineOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Immutable. The fully qualified resource name of the engine.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 engine should be 1-63 characters, and valid characters are
 /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getNameBytes in interface EngineOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Engine.Builder setName(String value)
       Immutable. The fully qualified resource name of the engine.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 engine should be 1-63 characters, and valid characters are
 /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Engine.Builder clearName()
       Immutable. The fully qualified resource name of the engine.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 engine should be 1-63 characters, and valid characters are
 /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Engine.Builder setNameBytes(com.google.protobuf.ByteString value)
       Immutable. The fully qualified resource name of the engine.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 engine should be 1-63 characters, and valid characters are
 /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDisplayName

      public String getDisplayName()
       Required. The display name of the engine. Should be human readable. UTF-8
 encoded string with limit of 1024 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface EngineOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the engine. Should be human readable. UTF-8
 encoded string with limit of 1024 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface EngineOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public Engine.Builder setDisplayName(String value)
       Required. The display name of the engine. Should be human readable. UTF-8
 encoded string with limit of 1024 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public Engine.Builder clearDisplayName()
       Required. The display name of the engine. Should be human readable. UTF-8
 encoded string with limit of 1024 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public Engine.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       Required. The display name of the engine. Should be human readable. UTF-8
 encoded string with limit of 1024 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface EngineOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface EngineOrBuilder
      Returns:
      The createTime.

    • setCreateTime

      public Engine.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setCreateTime

      public Engine.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeCreateTime

      public Engine.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearCreateTime

      public Engine.Builder clearCreateTime()
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp the Recommendation Engine was created at.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface EngineOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface EngineOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface EngineOrBuilder
      Returns:
      The updateTime.

    • setUpdateTime

      public Engine.Builder setUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setUpdateTime

      public Engine.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeUpdateTime

      public Engine.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearUpdateTime

      public Engine.Builder clearUpdateTime()
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp the Recommendation Engine was last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface EngineOrBuilder

    • getDataStoreIdsList

      public com.google.protobuf.ProtocolStringList getDataStoreIdsList()
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Specified by:
      getDataStoreIdsList in interface EngineOrBuilder
      Returns:
      A list containing the dataStoreIds.

    • getDataStoreIdsCount

      public int getDataStoreIdsCount()
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Specified by:
      getDataStoreIdsCount in interface EngineOrBuilder
      Returns:
      The count of dataStoreIds.

    • getDataStoreIds

      public String getDataStoreIds(int index)
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Specified by:
      getDataStoreIds in interface EngineOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The dataStoreIds at the given index.

    • getDataStoreIdsBytes

      public com.google.protobuf.ByteString getDataStoreIdsBytes(int index)
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Specified by:
      getDataStoreIdsBytes in interface EngineOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the dataStoreIds at the given index.

    • setDataStoreIds

      public Engine.Builder setDataStoreIds(int index, String value)
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Parameters:
      index - The index to set the value at.
      value - The dataStoreIds to set.
      Returns:
      This builder for chaining.

    • addDataStoreIds

      public Engine.Builder addDataStoreIds(String value)
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Parameters:
      value - The dataStoreIds to add.
      Returns:
      This builder for chaining.

    • addAllDataStoreIds

      public Engine.Builder addAllDataStoreIds(Iterable<String> values)
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Parameters:
      values - The dataStoreIds to add.
      Returns:
      This builder for chaining.

    • clearDataStoreIds

      public Engine.Builder clearDataStoreIds()
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Returns:
      This builder for chaining.

    • addDataStoreIdsBytes

      public Engine.Builder addDataStoreIdsBytes(com.google.protobuf.ByteString value)
       The data stores associated with this engine.

 For
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
 and
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
 type of engines, they can only associate with at most one data store.

 If
 [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
 is
 [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
 multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
 same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
 associated here.

 Note that when used in
 [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
 one DataStore id must be provided as the system will use it for necessary
 initializations.
      repeated string data_store_ids = 5;
      Parameters:
      value - The bytes of the dataStoreIds to add.
      Returns:
      This builder for chaining.

    • getSolutionTypeValue

      public int getSolutionTypeValue()
       Required. The solutions of the engine.
      .google.cloud.discoveryengine.v1beta.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSolutionTypeValue in interface EngineOrBuilder
      Returns:
      The enum numeric value on the wire for solutionType.

    • setSolutionTypeValue

      public Engine.Builder setSolutionTypeValue(int value)
       Required. The solutions of the engine.
      .google.cloud.discoveryengine.v1beta.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for solutionType to set.
      Returns:
      This builder for chaining.

    • getSolutionType

      public SolutionType getSolutionType()
       Required. The solutions of the engine.
      .google.cloud.discoveryengine.v1beta.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSolutionType in interface EngineOrBuilder
      Returns:
      The solutionType.

    • setSolutionType

      public Engine.Builder setSolutionType(SolutionType value)
       Required. The solutions of the engine.
      .google.cloud.discoveryengine.v1beta.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The solutionType to set.
      Returns:
      This builder for chaining.

    • clearSolutionType

      public Engine.Builder clearSolutionType()
       Required. The solutions of the engine.
      .google.cloud.discoveryengine.v1beta.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • getIndustryVerticalValue

      public int getIndustryVerticalValue()
       The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
 default to `GENERIC`. Vertical on Engine has to match vertical of the
 DataStore linked to the engine.
      .google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 16;
      Specified by:
      getIndustryVerticalValue in interface EngineOrBuilder
      Returns:
      The enum numeric value on the wire for industryVertical.

    • setIndustryVerticalValue

      public Engine.Builder setIndustryVerticalValue(int value)
       The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
 default to `GENERIC`. Vertical on Engine has to match vertical of the
 DataStore linked to the engine.
      .google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 16;
      Parameters:
      value - The enum numeric value on the wire for industryVertical to set.
      Returns:
      This builder for chaining.

    • getIndustryVertical

      public IndustryVertical getIndustryVertical()
       The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
 default to `GENERIC`. Vertical on Engine has to match vertical of the
 DataStore linked to the engine.
      .google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 16;
      Specified by:
      getIndustryVertical in interface EngineOrBuilder
      Returns:
      The industryVertical.

    • setIndustryVertical

      public Engine.Builder setIndustryVertical(IndustryVertical value)
       The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
 default to `GENERIC`. Vertical on Engine has to match vertical of the
 DataStore linked to the engine.
      .google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 16;
      Parameters:
      value - The industryVertical to set.
      Returns:
      This builder for chaining.

    • clearIndustryVertical

      public Engine.Builder clearIndustryVertical()
       The industry vertical that the engine registers.
 The restriction of the Engine industry vertical is based on
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
 default to `GENERIC`. Vertical on Engine has to match vertical of the
 DataStore linked to the engine.
      .google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 16;
      Returns:
      This builder for chaining.

    • hasCommonConfig

      public boolean hasCommonConfig()
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;
      Specified by:
      hasCommonConfig in interface EngineOrBuilder
      Returns:
      Whether the commonConfig field is set.

    • getCommonConfig

      public Engine.CommonConfig getCommonConfig()
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;
      Specified by:
      getCommonConfig in interface EngineOrBuilder
      Returns:
      The commonConfig.

    • setCommonConfig

      public Engine.Builder setCommonConfig(Engine.CommonConfig value)
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;

    • setCommonConfig

      public Engine.Builder setCommonConfig(Engine.CommonConfig.Builder builderForValue)
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;

    • mergeCommonConfig

      public Engine.Builder mergeCommonConfig(Engine.CommonConfig value)
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;

    • clearCommonConfig

      public Engine.Builder clearCommonConfig()
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;

    • getCommonConfigBuilder

      public Engine.CommonConfig.Builder getCommonConfigBuilder()
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;

    • getCommonConfigOrBuilder

      public Engine.CommonConfigOrBuilder getCommonConfigOrBuilder()
       Common config spec that specifies the metadata of the engine.
      .google.cloud.discoveryengine.v1beta.Engine.CommonConfig common_config = 15;
      Specified by:
      getCommonConfigOrBuilder in interface EngineOrBuilder

    • getDisableAnalytics

      public boolean getDisableAnalytics()
       Optional. Whether to disable analytics for searches performed on this
 engine.
      bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisableAnalytics in interface EngineOrBuilder
      Returns:
      The disableAnalytics.

    • setDisableAnalytics

      public Engine.Builder setDisableAnalytics(boolean value)
       Optional. Whether to disable analytics for searches performed on this
 engine.
      bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The disableAnalytics to set.
      Returns:
      This builder for chaining.

    • clearDisableAnalytics

      public Engine.Builder clearDisableAnalytics()
       Optional. Whether to disable analytics for searches performed on this
 engine.
      bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.