Class SearchRequest.TileNavigationSpec (2.64.0) 

public static final class SearchRequest.TileNavigationSpec extends GeneratedMessageV3 implements SearchRequest.TileNavigationSpecOrBuilder

This field specifies tile navigation related parameters.

Protobuf type google.cloud.retail.v2alpha.SearchRequest.TileNavigationSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.TileNavigationSpec

Static Fields

APPLIED_TILES_FIELD_NUMBER

public static final int APPLIED_TILES_FIELD_NUMBER
Field Value
Type Description
int

TILE_NAVIGATION_REQUESTED_FIELD_NUMBER

public static final int TILE_NAVIGATION_REQUESTED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.TileNavigationSpec getDefaultInstance()
Returns
Type Description
SearchRequest.TileNavigationSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchRequest.TileNavigationSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.TileNavigationSpec.Builder

newBuilder(SearchRequest.TileNavigationSpec prototype)

public static SearchRequest.TileNavigationSpec.Builder newBuilder(SearchRequest.TileNavigationSpec prototype)
Parameter
Name Description
prototype SearchRequest.TileNavigationSpec
Returns
Type Description
SearchRequest.TileNavigationSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.TileNavigationSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.TileNavigationSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest.TileNavigationSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.TileNavigationSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.TileNavigationSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.TileNavigationSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.TileNavigationSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.TileNavigationSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest.TileNavigationSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.TileNavigationSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.TileNavigationSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.TileNavigationSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.TileNavigationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.TileNavigationSpec> parser()
Returns
Type Description
Parser<TileNavigationSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAppliedTiles(int index)

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.

repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;

Parameter
Name Description
index int
Returns
Type Description
Tile

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.

repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;

Returns
Type Description
int

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.

repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;

Returns
Type Description
List<Tile>

getAppliedTilesOrBuilder(int index)

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.

repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;

Parameter
Name Description
index int
Returns
Type Description
TileOrBuilder

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.

repeated .google.cloud.retail.v2alpha.Tile applied_tiles = 2;

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.TileOrBuilder>

getDefaultInstanceForType()

public SearchRequest.TileNavigationSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.TileNavigationSpec

getParserForType()

public Parser<SearchRequest.TileNavigationSpec> getParserForType()
Returns
Type Description
Parser<TileNavigationSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTileNavigationRequested()

public boolean getTileNavigationRequested()

This field specifies whether the customer would like to request tile navigation.

bool tile_navigation_requested = 1;

Returns
Type Description
boolean

The tileNavigationRequested.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchRequest.TileNavigationSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.TileNavigationSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.TileNavigationSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.TileNavigationSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchRequest.TileNavigationSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.TileNavigationSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException