Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest.ContentSearchSpec

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

  • Field Details

    • SNIPPET_SPEC_FIELD_NUMBER

      public static final int SNIPPET_SPEC_FIELD_NUMBER
      See Also:

    • SUMMARY_SPEC_FIELD_NUMBER

      public static final int SUMMARY_SPEC_FIELD_NUMBER
      See Also:

    • EXTRACTIVE_CONTENT_SPEC_FIELD_NUMBER

      public static final int EXTRACTIVE_CONTENT_SPEC_FIELD_NUMBER
      See Also:

    • SEARCH_RESULT_MODE_FIELD_NUMBER

      public static final int SEARCH_RESULT_MODE_FIELD_NUMBER
      See Also:

    • CHUNK_SPEC_FIELD_NUMBER

      public static final int CHUNK_SPEC_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

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

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

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

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

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

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

    • 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

    • 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 SearchRequest.ContentSearchSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static SearchRequest.ContentSearchSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SearchRequest.ContentSearchSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SearchRequest.ContentSearchSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static SearchRequest.ContentSearchSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchRequest.ContentSearchSpec.Builder newBuilder()

    • newBuilder

      public static SearchRequest.ContentSearchSpec.Builder newBuilder(SearchRequest.ContentSearchSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchRequest.ContentSearchSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchRequest.ContentSearchSpec> 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 SearchRequest.ContentSearchSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder