Class SearchResponse.Facet (2.17.0)

public static final class SearchResponse.Facet extends GeneratedMessageV3 implements SearchResponse.FacetOrBuilder

A facet result.

Protobuf type google.cloud.retail.v2.SearchResponse.Facet

Static Fields

DYNAMIC_FACET_FIELD_NUMBER

public static final int DYNAMIC_FACET_FIELD_NUMBER
Field Value
TypeDescription
int

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
TypeDescription
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchResponse.Facet getDefaultInstance()
Returns
TypeDescription
SearchResponse.Facet

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchResponse.Facet.Builder newBuilder()
Returns
TypeDescription
SearchResponse.Facet.Builder

newBuilder(SearchResponse.Facet prototype)

public static SearchResponse.Facet.Builder newBuilder(SearchResponse.Facet prototype)
Parameter
NameDescription
prototypeSearchResponse.Facet
Returns
TypeDescription
SearchResponse.Facet.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.Facet parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Facet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchResponse.Facet parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Facet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.Facet parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Facet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.Facet parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Facet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchResponse.Facet parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Facet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.Facet parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Facet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Facet
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse.Facet> parser()
Returns
TypeDescription
Parser<Facet>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchResponse.Facet getDefaultInstanceForType()
Returns
TypeDescription
SearchResponse.Facet

getDynamicFacet()

public boolean getDynamicFacet()

Whether the facet is dynamically generated.

bool dynamic_facet = 3;

Returns
TypeDescription
boolean

The dynamicFacet.

getKey()

public String getKey()

The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1".

string key = 1;

Returns
TypeDescription
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1".

string key = 1;

Returns
TypeDescription
ByteString

The bytes for key.

getParserForType()

public Parser<SearchResponse.Facet> getParserForType()
Returns
TypeDescription
Parser<Facet>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValues(int index)

public SearchResponse.Facet.FacetValue getValues(int index)

The facet values for this field.

repeated .google.cloud.retail.v2.SearchResponse.Facet.FacetValue values = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Facet.FacetValue

getValuesCount()

public int getValuesCount()

The facet values for this field.

repeated .google.cloud.retail.v2.SearchResponse.Facet.FacetValue values = 2;

Returns
TypeDescription
int

getValuesList()

public List<SearchResponse.Facet.FacetValue> getValuesList()

The facet values for this field.

repeated .google.cloud.retail.v2.SearchResponse.Facet.FacetValue values = 2;

Returns
TypeDescription
List<FacetValue>

getValuesOrBuilder(int index)

public SearchResponse.Facet.FacetValueOrBuilder getValuesOrBuilder(int index)

The facet values for this field.

repeated .google.cloud.retail.v2.SearchResponse.Facet.FacetValue values = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Facet.FacetValueOrBuilder

getValuesOrBuilderList()

public List<? extends SearchResponse.Facet.FacetValueOrBuilder> getValuesOrBuilderList()

The facet values for this field.

repeated .google.cloud.retail.v2.SearchResponse.Facet.FacetValue values = 2;

Returns
TypeDescription
List<? extends com.google.cloud.retail.v2.SearchResponse.Facet.FacetValueOrBuilder>

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchResponse.Facet.Builder newBuilderForType()
Returns
TypeDescription
SearchResponse.Facet.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Facet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchResponse.Facet.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchResponse.Facet.Builder toBuilder()
Returns
TypeDescription
SearchResponse.Facet.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException