Class SearchRequest.TileNavigationSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.SearchRequest.TileNavigationSpec
All Implemented Interfaces:
SearchRequest.TileNavigationSpecOrBuilder, 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.TileNavigationSpec extends com.google.protobuf.GeneratedMessage implements SearchRequest.TileNavigationSpecOrBuilder
 This field specifies tile navigation related parameters.
 
Protobuf type google.cloud.retail.v2alpha.SearchRequest.TileNavigationSpec
See Also:
  • Field Details

    • TILE_NAVIGATION_REQUESTED_FIELD_NUMBER

      public static final int TILE_NAVIGATION_REQUESTED_FIELD_NUMBER
      See Also:
    • APPLIED_TILES_FIELD_NUMBER

      public static final int APPLIED_TILES_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
    • getTileNavigationRequested

      public boolean getTileNavigationRequested()
       This field specifies whether the customer would like to request tile
       navigation.
       
      bool tile_navigation_requested = 1;
      Specified by:
      getTileNavigationRequested in interface SearchRequest.TileNavigationSpecOrBuilder
      Returns:
      The tileNavigationRequested.
    • getAppliedTilesList

      public List<Tile> getAppliedTilesList()
       This optional field specifies the tiles which are already clicked in
       client side. While the feature works without this field set, particularly
       for an initial query, it is highly recommended to set this field because
       it can improve the quality of the search response and removes possible
       duplicate tiles.
      
       NOTE: This field is not being used for filtering search
       products. Client side should also put all the applied tiles in
       [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
       
      repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;
      Specified by:
      getAppliedTilesList in interface SearchRequest.TileNavigationSpecOrBuilder
    • getAppliedTilesOrBuilderList

      public List<? extends TileOrBuilder> getAppliedTilesOrBuilderList()
       This optional field specifies the tiles which are already clicked in
       client side. While the feature works without this field set, particularly
       for an initial query, it is highly recommended to set this field because
       it can improve the quality of the search response and removes possible
       duplicate tiles.
      
       NOTE: This field is not being used for filtering search
       products. Client side should also put all the applied tiles in
       [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
       
      repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;
      Specified by:
      getAppliedTilesOrBuilderList in interface SearchRequest.TileNavigationSpecOrBuilder
    • getAppliedTilesCount

      public int getAppliedTilesCount()
       This optional field specifies the tiles which are already clicked in
       client side. While the feature works without this field set, particularly
       for an initial query, it is highly recommended to set this field because
       it can improve the quality of the search response and removes possible
       duplicate tiles.
      
       NOTE: This field is not being used for filtering search
       products. Client side should also put all the applied tiles in
       [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
       
      repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;
      Specified by:
      getAppliedTilesCount in interface SearchRequest.TileNavigationSpecOrBuilder
    • getAppliedTiles

      public Tile getAppliedTiles(int index)
       This optional field specifies the tiles which are already clicked in
       client side. While the feature works without this field set, particularly
       for an initial query, it is highly recommended to set this field because
       it can improve the quality of the search response and removes possible
       duplicate tiles.
      
       NOTE: This field is not being used for filtering search
       products. Client side should also put all the applied tiles in
       [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
       
      repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;
      Specified by:
      getAppliedTiles in interface SearchRequest.TileNavigationSpecOrBuilder
    • getAppliedTilesOrBuilder

      public TileOrBuilder getAppliedTilesOrBuilder(int index)
       This optional field specifies the tiles which are already clicked in
       client side. While the feature works without this field set, particularly
       for an initial query, it is highly recommended to set this field because
       it can improve the quality of the search response and removes possible
       duplicate tiles.
      
       NOTE: This field is not being used for filtering search
       products. Client side should also put all the applied tiles in
       [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
       
      repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;
      Specified by:
      getAppliedTilesOrBuilder in interface SearchRequest.TileNavigationSpecOrBuilder
    • 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.TileNavigationSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

      public static SearchRequest.TileNavigationSpec 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.TileNavigationSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

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

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

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

      public static SearchRequest.TileNavigationSpec.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

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

      public static SearchRequest.TileNavigationSpec getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SearchRequest.TileNavigationSpec> parser()
    • getParserForType

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