Package com.google.cloud.retail.v2alpha

Class ConversationalSearchRequest.SearchParams

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams
All Implemented Interfaces:
ConversationalSearchRequest.SearchParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
ConversationalSearchRequest
public static final class ConversationalSearchRequest.SearchParams extends com.google.protobuf.GeneratedMessage implements ConversationalSearchRequest.SearchParamsOrBuilder
 Search parameters.
Protobuf type google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams
See Also:

  • Field Details

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • CANONICAL_FILTER_FIELD_NUMBER

      public static final int CANONICAL_FILTER_FIELD_NUMBER
      See Also:

    • SORT_BY_FIELD_NUMBER

      public static final int SORT_BY_FIELD_NUMBER
      See Also:

    • BOOST_SPEC_FIELD_NUMBER

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

    • getFilter

      public String getFilter()
       Optional. The filter string to restrict search results.

 The syntax of the filter string is the same as
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
      string filter = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface ConversationalSearchRequest.SearchParamsOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. The filter string to restrict search results.

 The syntax of the filter string is the same as
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
      string filter = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface ConversationalSearchRequest.SearchParamsOrBuilder
      Returns:
      The bytes for filter.

    • getCanonicalFilter

      public String getCanonicalFilter()
       Optional. The canonical filter string to restrict search results.

 The syntax of the canonical filter string is the same as
 [SearchRequest.canonical_filter][google.cloud.retail.v2alpha.SearchRequest.canonical_filter].
      string canonical_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCanonicalFilter in interface ConversationalSearchRequest.SearchParamsOrBuilder
      Returns:
      The canonicalFilter.

    • getCanonicalFilterBytes

      public com.google.protobuf.ByteString getCanonicalFilterBytes()
       Optional. The canonical filter string to restrict search results.

 The syntax of the canonical filter string is the same as
 [SearchRequest.canonical_filter][google.cloud.retail.v2alpha.SearchRequest.canonical_filter].
      string canonical_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCanonicalFilterBytes in interface ConversationalSearchRequest.SearchParamsOrBuilder
      Returns:
      The bytes for canonicalFilter.

    • getSortBy

      public String getSortBy()
       Optional. The sort string to specify the sorting of search results.

 The syntax of the sort string is the same as
 [SearchRequest.sort][].
      string sort_by = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSortBy in interface ConversationalSearchRequest.SearchParamsOrBuilder
      Returns:
      The sortBy.

    • getSortByBytes

      public com.google.protobuf.ByteString getSortByBytes()
       Optional. The sort string to specify the sorting of search results.

 The syntax of the sort string is the same as
 [SearchRequest.sort][].
      string sort_by = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSortByBytes in interface ConversationalSearchRequest.SearchParamsOrBuilder
      Returns:
      The bytes for sortBy.

    • hasBoostSpec

      public boolean hasBoostSpec()
       Optional. The boost spec to specify the boosting of search results.

 The syntax of the boost spec is the same as
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec].
      .google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBoostSpec in interface ConversationalSearchRequest.SearchParamsOrBuilder
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      public SearchRequest.BoostSpec getBoostSpec()
       Optional. The boost spec to specify the boosting of search results.

 The syntax of the boost spec is the same as
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec].
      .google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostSpec in interface ConversationalSearchRequest.SearchParamsOrBuilder
      Returns:
      The boostSpec.

    • getBoostSpecOrBuilder

      public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
       Optional. The boost spec to specify the boosting of search results.

 The syntax of the boost spec is the same as
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec].
      .google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostSpecOrBuilder in interface ConversationalSearchRequest.SearchParamsOrBuilder

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

    • parseFrom

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

    • parseFrom

      public static ConversationalSearchRequest.SearchParams parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ConversationalSearchRequest.SearchParams parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ConversationalSearchRequest.SearchParams parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static ConversationalSearchRequest.SearchParams parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ConversationalSearchRequest.SearchParams.Builder newBuilder()

    • newBuilder

      public static ConversationalSearchRequest.SearchParams.Builder newBuilder(ConversationalSearchRequest.SearchParams prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ConversationalSearchRequest.SearchParams getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ConversationalSearchRequest.SearchParams> parser()

    • getParserForType

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