Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest.ContentSearchSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchRequest.ContentSearchSpec.Builder>
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.Builder
All Implemented Interfaces:
SearchRequest.ContentSearchSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchRequest.ContentSearchSpec
public static final class SearchRequest.ContentSearchSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.ContentSearchSpec.Builder> implements SearchRequest.ContentSearchSpecOrBuilder
 A specification for configuring the behavior of content search.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec

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

    • clear

      public SearchRequest.ContentSearchSpec.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<SearchRequest.ContentSearchSpec.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<SearchRequest.ContentSearchSpec.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchRequest.ContentSearchSpec.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<SearchRequest.ContentSearchSpec.Builder>

    • mergeFrom

      public SearchRequest.ContentSearchSpec.Builder mergeFrom(SearchRequest.ContentSearchSpec other)

    • isInitialized

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

    • mergeFrom

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

    • hasSnippetSpec

      public boolean hasSnippetSpec()
       If `snippetSpec` is not specified, snippets are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;
      Specified by:
      hasSnippetSpec in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      Whether the snippetSpec field is set.

    • getSnippetSpec

      public SearchRequest.ContentSearchSpec.SnippetSpec getSnippetSpec()
       If `snippetSpec` is not specified, snippets are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;
      Specified by:
      getSnippetSpec in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      The snippetSpec.

    • setSnippetSpec

      public SearchRequest.ContentSearchSpec.Builder setSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec value)
       If `snippetSpec` is not specified, snippets are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

    • setSnippetSpec

      public SearchRequest.ContentSearchSpec.Builder setSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec.Builder builderForValue)
       If `snippetSpec` is not specified, snippets are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

    • mergeSnippetSpec

      public SearchRequest.ContentSearchSpec.Builder mergeSnippetSpec(SearchRequest.ContentSearchSpec.SnippetSpec value)
       If `snippetSpec` is not specified, snippets are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

    • clearSnippetSpec

      public SearchRequest.ContentSearchSpec.Builder clearSnippetSpec()
       If `snippetSpec` is not specified, snippets are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

    • getSnippetSpecBuilder

      public SearchRequest.ContentSearchSpec.SnippetSpec.Builder getSnippetSpecBuilder()
       If `snippetSpec` is not specified, snippets are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;

    • getSnippetSpecOrBuilder

      public SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder getSnippetSpecOrBuilder()
       If `snippetSpec` is not specified, snippets are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec snippet_spec = 1;
      Specified by:
      getSnippetSpecOrBuilder in interface SearchRequest.ContentSearchSpecOrBuilder

    • hasSummarySpec

      public boolean hasSummarySpec()
       If `summarySpec` is not specified, summaries are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;
      Specified by:
      hasSummarySpec in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      Whether the summarySpec field is set.

    • getSummarySpec

      public SearchRequest.ContentSearchSpec.SummarySpec getSummarySpec()
       If `summarySpec` is not specified, summaries are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;
      Specified by:
      getSummarySpec in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      The summarySpec.

    • setSummarySpec

      public SearchRequest.ContentSearchSpec.Builder setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)
       If `summarySpec` is not specified, summaries are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

    • setSummarySpec

      public SearchRequest.ContentSearchSpec.Builder setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.Builder builderForValue)
       If `summarySpec` is not specified, summaries are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

    • mergeSummarySpec

      public SearchRequest.ContentSearchSpec.Builder mergeSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)
       If `summarySpec` is not specified, summaries are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

    • clearSummarySpec

      public SearchRequest.ContentSearchSpec.Builder clearSummarySpec()
       If `summarySpec` is not specified, summaries are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

    • getSummarySpecBuilder

      public SearchRequest.ContentSearchSpec.SummarySpec.Builder getSummarySpecBuilder()
       If `summarySpec` is not specified, summaries are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;

    • getSummarySpecOrBuilder

      public SearchRequest.ContentSearchSpec.SummarySpecOrBuilder getSummarySpecOrBuilder()
       If `summarySpec` is not specified, summaries are not included in the
 search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 2;
      Specified by:
      getSummarySpecOrBuilder in interface SearchRequest.ContentSearchSpecOrBuilder

    • hasExtractiveContentSpec

      public boolean hasExtractiveContentSpec()
       If there is no extractive_content_spec provided, there will be no
 extractive answer in the search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;
      Specified by:
      hasExtractiveContentSpec in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      Whether the extractiveContentSpec field is set.

    • getExtractiveContentSpec

      public SearchRequest.ContentSearchSpec.ExtractiveContentSpec getExtractiveContentSpec()
       If there is no extractive_content_spec provided, there will be no
 extractive answer in the search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;
      Specified by:
      getExtractiveContentSpec in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      The extractiveContentSpec.

    • setExtractiveContentSpec

      public SearchRequest.ContentSearchSpec.Builder setExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec value)
       If there is no extractive_content_spec provided, there will be no
 extractive answer in the search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

    • setExtractiveContentSpec

      public SearchRequest.ContentSearchSpec.Builder setExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder builderForValue)
       If there is no extractive_content_spec provided, there will be no
 extractive answer in the search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

    • mergeExtractiveContentSpec

      public SearchRequest.ContentSearchSpec.Builder mergeExtractiveContentSpec(SearchRequest.ContentSearchSpec.ExtractiveContentSpec value)
       If there is no extractive_content_spec provided, there will be no
 extractive answer in the search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

    • clearExtractiveContentSpec

      public SearchRequest.ContentSearchSpec.Builder clearExtractiveContentSpec()
       If there is no extractive_content_spec provided, there will be no
 extractive answer in the search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

    • getExtractiveContentSpecBuilder

      public SearchRequest.ContentSearchSpec.ExtractiveContentSpec.Builder getExtractiveContentSpecBuilder()
       If there is no extractive_content_spec provided, there will be no
 extractive answer in the search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;

    • getExtractiveContentSpecOrBuilder

      public SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder getExtractiveContentSpecOrBuilder()
       If there is no extractive_content_spec provided, there will be no
 extractive answer in the search response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ExtractiveContentSpec extractive_content_spec = 3;
      Specified by:
      getExtractiveContentSpecOrBuilder in interface SearchRequest.ContentSearchSpecOrBuilder

    • getSearchResultModeValue

      public int getSearchResultModeValue()
       Specifies the search result mode. If unspecified, the
 search result mode defaults to `DOCUMENTS`.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;
      Specified by:
      getSearchResultModeValue in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      The enum numeric value on the wire for searchResultMode.

    • setSearchResultModeValue

      public SearchRequest.ContentSearchSpec.Builder setSearchResultModeValue(int value)
       Specifies the search result mode. If unspecified, the
 search result mode defaults to `DOCUMENTS`.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;
      Parameters:
      value - The enum numeric value on the wire for searchResultMode to set.
      Returns:
      This builder for chaining.

    • getSearchResultMode

      public SearchRequest.ContentSearchSpec.SearchResultMode getSearchResultMode()
       Specifies the search result mode. If unspecified, the
 search result mode defaults to `DOCUMENTS`.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;
      Specified by:
      getSearchResultMode in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      The searchResultMode.

    • setSearchResultMode

      public SearchRequest.ContentSearchSpec.Builder setSearchResultMode(SearchRequest.ContentSearchSpec.SearchResultMode value)
       Specifies the search result mode. If unspecified, the
 search result mode defaults to `DOCUMENTS`.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;
      Parameters:
      value - The searchResultMode to set.
      Returns:
      This builder for chaining.

    • clearSearchResultMode

      public SearchRequest.ContentSearchSpec.Builder clearSearchResultMode()
       Specifies the search result mode. If unspecified, the
 search result mode defaults to `DOCUMENTS`.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 4;
      Returns:
      This builder for chaining.

    • hasChunkSpec

      public boolean hasChunkSpec()
       Specifies the chunk spec to be returned from the search response.
 Only available if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;
      Specified by:
      hasChunkSpec in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      Whether the chunkSpec field is set.

    • getChunkSpec

      public SearchRequest.ContentSearchSpec.ChunkSpec getChunkSpec()
       Specifies the chunk spec to be returned from the search response.
 Only available if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;
      Specified by:
      getChunkSpec in interface SearchRequest.ContentSearchSpecOrBuilder
      Returns:
      The chunkSpec.

    • setChunkSpec

      public SearchRequest.ContentSearchSpec.Builder setChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec value)
       Specifies the chunk spec to be returned from the search response.
 Only available if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

    • setChunkSpec

      public SearchRequest.ContentSearchSpec.Builder setChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec.Builder builderForValue)
       Specifies the chunk spec to be returned from the search response.
 Only available if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

    • mergeChunkSpec

      public SearchRequest.ContentSearchSpec.Builder mergeChunkSpec(SearchRequest.ContentSearchSpec.ChunkSpec value)
       Specifies the chunk spec to be returned from the search response.
 Only available if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

    • clearChunkSpec

      public SearchRequest.ContentSearchSpec.Builder clearChunkSpec()
       Specifies the chunk spec to be returned from the search response.
 Only available if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

    • getChunkSpecBuilder

      public SearchRequest.ContentSearchSpec.ChunkSpec.Builder getChunkSpecBuilder()
       Specifies the chunk spec to be returned from the search response.
 Only available if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;

    • getChunkSpecOrBuilder

      public SearchRequest.ContentSearchSpec.ChunkSpecOrBuilder getChunkSpecOrBuilder()
       Specifies the chunk spec to be returned from the search response.
 Only available if the
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec chunk_spec = 5;
      Specified by:
      getChunkSpecOrBuilder in interface SearchRequest.ContentSearchSpecOrBuilder