Package com.google.cloud.discoveryengine.v1

Class SearchResponse.Facet

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1.SearchResponse.Facet

All Implemented Interfaces:

SearchResponse.FacetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchResponse

public static final class SearchResponse.Facet
extends com.google.protobuf.GeneratedMessageV3
implements SearchResponse.FacetOrBuilder

 A facet result.
 

Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Facet

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchResponse.Facet.Builder	A facet result.
static class	SearchResponse.Facet.FacetValue	A facet value which contains value names and their count.
static interface	SearchResponse.Facet.FacetValueOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	DYNAMIC_FACET_FIELD_NUMBER
static int	KEY_FIELD_NUMBER
static int	VALUES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static SearchResponse.Facet	getDefaultInstance()
SearchResponse.Facet	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getDynamicFacet()	Whether the facet is dynamically generated.
String	getKey()	The key for this facet.
com.google.protobuf.ByteString	getKeyBytes()	The key for this facet.
com.google.protobuf.Parser<SearchResponse.Facet>	getParserForType()
int	getSerializedSize()
SearchResponse.Facet.FacetValue	getValues(int index)	The facet values for this field.
int	getValuesCount()	The facet values for this field.
List<SearchResponse.Facet.FacetValue>	getValuesList()	The facet values for this field.
SearchResponse.Facet.FacetValueOrBuilder	getValuesOrBuilder(int index)	The facet values for this field.
List<? extends SearchResponse.Facet.FacetValueOrBuilder>	getValuesOrBuilderList()	The facet values for this field.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchResponse.Facet.Builder	newBuilder()
static SearchResponse.Facet.Builder	newBuilder(SearchResponse.Facet prototype)
SearchResponse.Facet.Builder	newBuilderForType()
protected SearchResponse.Facet.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchResponse.Facet	parseDelimitedFrom(InputStream input)
static SearchResponse.Facet	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.Facet	parseFrom(byte[] data)
static SearchResponse.Facet	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.Facet	parseFrom(com.google.protobuf.ByteString data)
static SearchResponse.Facet	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.Facet	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchResponse.Facet	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.Facet	parseFrom(InputStream input)
static SearchResponse.Facet	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.Facet	parseFrom(ByteBuffer data)
static SearchResponse.Facet	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchResponse.Facet>	parser()
SearchResponse.Facet.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER

See Also:

Constant Field Values

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER

See Also:

Constant Field Values

DYNAMIC_FACET_FIELD_NUMBER

public static final int DYNAMIC_FACET_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getKey

public String getKey()

 The key for this facet. E.g., "colors" or "price". It matches
 [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.key].
 

string key = 1;

Specified by:

getKey in interface SearchResponse.FacetOrBuilder

Returns:

The key.

getKeyBytes

public com.google.protobuf.ByteString getKeyBytes()

 The key for this facet. E.g., "colors" or "price". It matches
 [SearchRequest.FacetSpec.FacetKey.key][google.cloud.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey.key].
 

string key = 1;

Specified by:

getKeyBytes in interface SearchResponse.FacetOrBuilder

Returns:

The bytes for key.

getValuesList

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

 The facet values for this field.
 

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Specified by:

getValuesList in interface SearchResponse.FacetOrBuilder

getValuesOrBuilderList

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

 The facet values for this field.
 

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Specified by:

getValuesOrBuilderList in interface SearchResponse.FacetOrBuilder

getValuesCount

public int getValuesCount()

 The facet values for this field.
 

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Specified by:

getValuesCount in interface SearchResponse.FacetOrBuilder

getValues

public SearchResponse.Facet.FacetValue getValues(int index)

 The facet values for this field.
 

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Specified by:

getValues in interface SearchResponse.FacetOrBuilder

getValuesOrBuilder

public SearchResponse.Facet.FacetValueOrBuilder getValuesOrBuilder(int index)

 The facet values for this field.
 

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Specified by:

getValuesOrBuilder in interface SearchResponse.FacetOrBuilder

getDynamicFacet

public boolean getDynamicFacet()

 Whether the facet is dynamically generated.
 

bool dynamic_facet = 3;

Specified by:

getDynamicFacet in interface SearchResponse.FacetOrBuilder

Returns:

The dynamicFacet.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 SearchResponse.Facet parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.Facet parseFrom(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.Facet parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.Facet parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.Facet parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.Facet parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.Facet parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.Facet parseFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.Facet parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.Facet parseDelimitedFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.Facet parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.Facet parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public SearchResponse.Facet.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchResponse.Facet.Builder newBuilder()

newBuilder

public static SearchResponse.Facet.Builder newBuilder(SearchResponse.Facet prototype)

toBuilder

public SearchResponse.Facet.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchResponse.Facet.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchResponse.Facet getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchResponse.Facet> parser()

getParserForType

public com.google.protobuf.Parser<SearchResponse.Facet> 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.GeneratedMessageV3

getDefaultInstanceForType

public SearchResponse.Facet getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder