Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest.ContentSearchSpec.SnippetSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder>
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.Builder
All Implemented Interfaces:
SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchRequest.ContentSearchSpec.SnippetSpec
public static final class SearchRequest.ContentSearchSpec.SnippetSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder> implements SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
 A specification for configuring snippets in a search response.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • mergeFrom

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

    • mergeFrom

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

    • getMaxSnippetCount

      @Deprecated public int getMaxSnippetCount()
      Deprecated.
      google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=446
       [DEPRECATED] This field is deprecated. To control snippet return, use
 `return_snippet` field. For backwards compatibility, we will return
 snippet if max_snippet_count > 0.
      int32 max_snippet_count = 1 [deprecated = true];
      Specified by:
      getMaxSnippetCount in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
      Returns:
      The maxSnippetCount.

    • setMaxSnippetCount

      @Deprecated public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setMaxSnippetCount(int value)
      Deprecated.
      google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=446
       [DEPRECATED] This field is deprecated. To control snippet return, use
 `return_snippet` field. For backwards compatibility, we will return
 snippet if max_snippet_count > 0.
      int32 max_snippet_count = 1 [deprecated = true];
      Parameters:
      value - The maxSnippetCount to set.
      Returns:
      This builder for chaining.

    • clearMaxSnippetCount

      @Deprecated public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearMaxSnippetCount()
      Deprecated.
      google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=446
       [DEPRECATED] This field is deprecated. To control snippet return, use
 `return_snippet` field. For backwards compatibility, we will return
 snippet if max_snippet_count > 0.
      int32 max_snippet_count = 1 [deprecated = true];
      Returns:
      This builder for chaining.

    • getReferenceOnly

      @Deprecated public boolean getReferenceOnly()
      Deprecated.
      google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=450
       [DEPRECATED] This field is deprecated and will have no affect on the
 snippet.
      bool reference_only = 2 [deprecated = true];
      Specified by:
      getReferenceOnly in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
      Returns:
      The referenceOnly.

    • setReferenceOnly

      @Deprecated public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setReferenceOnly(boolean value)
      Deprecated.
      google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=450
       [DEPRECATED] This field is deprecated and will have no affect on the
 snippet.
      bool reference_only = 2 [deprecated = true];
      Parameters:
      value - The referenceOnly to set.
      Returns:
      This builder for chaining.

    • clearReferenceOnly

      @Deprecated public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearReferenceOnly()
      Deprecated.
      google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=450
       [DEPRECATED] This field is deprecated and will have no affect on the
 snippet.
      bool reference_only = 2 [deprecated = true];
      Returns:
      This builder for chaining.

    • getReturnSnippet

      public boolean getReturnSnippet()
       If `true`, then return snippet. If no snippet can be generated, we
 return "No snippet is available for this page." A `snippet_status` with
 `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
      bool return_snippet = 3;
      Specified by:
      getReturnSnippet in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
      Returns:
      The returnSnippet.

    • setReturnSnippet

      public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setReturnSnippet(boolean value)
       If `true`, then return snippet. If no snippet can be generated, we
 return "No snippet is available for this page." A `snippet_status` with
 `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
      bool return_snippet = 3;
      Parameters:
      value - The returnSnippet to set.
      Returns:
      This builder for chaining.

    • clearReturnSnippet

      public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearReturnSnippet()
       If `true`, then return snippet. If no snippet can be generated, we
 return "No snippet is available for this page." A `snippet_status` with
 `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
      bool return_snippet = 3;
      Returns:
      This builder for chaining.