Package com.google.cloud.discoveryengine.v1beta

Class SearchInfo.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchInfo.Builder>
com.google.cloud.discoveryengine.v1beta.SearchInfo.Builder
All Implemented Interfaces:
SearchInfoOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchInfo
public static final class SearchInfo.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchInfo.Builder> implements SearchInfoOrBuilder
 Detailed search information.
Protobuf type google.cloud.discoveryengine.v1beta.SearchInfo

  • Method Summary

    Modifier and Type
    Method
    Description
    SearchInfo
    build()
     
    SearchInfo
    buildPartial()
     
    SearchInfo.Builder
    clear()
     
    SearchInfo.Builder
    clearOffset()
    An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
    SearchInfo.Builder
    clearOrderBy()
    The order in which products are returned, if applicable.
    SearchInfo.Builder
    clearSearchQuery()
    The user's search query.
    SearchInfo
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    int
    getOffset()
    An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
    String
    getOrderBy()
    The order in which products are returned, if applicable.
    com.google.protobuf.ByteString
    getOrderByBytes()
    The order in which products are returned, if applicable.
    String
    getSearchQuery()
    The user's search query.
    com.google.protobuf.ByteString
    getSearchQueryBytes()
    The user's search query.
    boolean
    hasOffset()
    An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    SearchInfo.Builder
    mergeFrom(SearchInfo other)
     
    SearchInfo.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    SearchInfo.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    SearchInfo.Builder
    setOffset(int value)
    An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
    SearchInfo.Builder
    setOrderBy(String value)
    The order in which products are returned, if applicable.
    SearchInfo.Builder
    setOrderByBytes(com.google.protobuf.ByteString value)
    The order in which products are returned, if applicable.
    SearchInfo.Builder
    setSearchQuery(String value)
    The user's search query.
    SearchInfo.Builder
    setSearchQueryBytes(com.google.protobuf.ByteString value)
    The user's search query.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public SearchInfo.Builder mergeFrom(SearchInfo other)

    • isInitialized

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

    • mergeFrom

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

    • getSearchQuery

      public String getSearchQuery()
       The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query]
 for definition.

 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 At least one of
 [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
 is required for `search` events. Other event types should not set this
 field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string search_query = 1;
      Specified by:
      getSearchQuery in interface SearchInfoOrBuilder
      Returns:
      The searchQuery.

    • getSearchQueryBytes

      public com.google.protobuf.ByteString getSearchQueryBytes()
       The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query]
 for definition.

 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 At least one of
 [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
 is required for `search` events. Other event types should not set this
 field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string search_query = 1;
      Specified by:
      getSearchQueryBytes in interface SearchInfoOrBuilder
      Returns:
      The bytes for searchQuery.

    • setSearchQuery

      public SearchInfo.Builder setSearchQuery(String value)
       The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query]
 for definition.

 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 At least one of
 [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
 is required for `search` events. Other event types should not set this
 field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string search_query = 1;
      Parameters:
      value - The searchQuery to set.
      Returns:
      This builder for chaining.

    • clearSearchQuery

      public SearchInfo.Builder clearSearchQuery()
       The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query]
 for definition.

 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 At least one of
 [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
 is required for `search` events. Other event types should not set this
 field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string search_query = 1;
      Returns:
      This builder for chaining.

    • setSearchQueryBytes

      public SearchInfo.Builder setSearchQueryBytes(com.google.protobuf.ByteString value)
       The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1beta.SearchRequest.query]
 for definition.

 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 At least one of
 [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
 is required for `search` events. Other event types should not set this
 field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string search_query = 1;
      Parameters:
      value - The bytes for searchQuery to set.
      Returns:
      This builder for chaining.

    • getOrderBy

      public String getOrderBy()
       The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string order_by = 2;
      Specified by:
      getOrderBy in interface SearchInfoOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string order_by = 2;
      Specified by:
      getOrderByBytes in interface SearchInfoOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      public SearchInfo.Builder setOrderBy(String value)
       The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string order_by = 2;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public SearchInfo.Builder clearOrderBy()
       The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string order_by = 2;
      Returns:
      This builder for chaining.

    • setOrderByBytes

      public SearchInfo.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.SearchRequest.order_by]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string order_by = 2;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.

    • hasOffset

      public boolean hasOffset()
       An integer that specifies the current offset for pagination (the 0-indexed
 starting location, amongst the products deemed by the API as relevant).

 See
 [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset]
 for definition.

 If this field is negative, an `INVALID_ARGUMENT` is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      optional int32 offset = 3;
      Specified by:
      hasOffset in interface SearchInfoOrBuilder
      Returns:
      Whether the offset field is set.

    • getOffset

      public int getOffset()
       An integer that specifies the current offset for pagination (the 0-indexed
 starting location, amongst the products deemed by the API as relevant).

 See
 [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset]
 for definition.

 If this field is negative, an `INVALID_ARGUMENT` is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      optional int32 offset = 3;
      Specified by:
      getOffset in interface SearchInfoOrBuilder
      Returns:
      The offset.

    • setOffset

      public SearchInfo.Builder setOffset(int value)
       An integer that specifies the current offset for pagination (the 0-indexed
 starting location, amongst the products deemed by the API as relevant).

 See
 [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset]
 for definition.

 If this field is negative, an `INVALID_ARGUMENT` is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      optional int32 offset = 3;
      Parameters:
      value - The offset to set.
      Returns:
      This builder for chaining.

    • clearOffset

      public SearchInfo.Builder clearOffset()
       An integer that specifies the current offset for pagination (the 0-indexed
 starting location, amongst the products deemed by the API as relevant).

 See
 [SearchRequest.offset][google.cloud.discoveryengine.v1beta.SearchRequest.offset]
 for definition.

 If this field is negative, an `INVALID_ARGUMENT` is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
      optional int32 offset = 3;
      Returns:
      This builder for chaining.