public static final class SearchResponse.Facet extends GeneratedMessageV3 implements SearchResponse.FacetOrBuilder
A facet result.
Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Facet
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchResponse.FacetImplements
SearchResponse.FacetOrBuilderStatic Fields
DYNAMIC_FACET_FIELD_NUMBER
public static final int DYNAMIC_FACET_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
KEY_FIELD_NUMBER
public static final int KEY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
VALUES_FIELD_NUMBER
public static final int VALUES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static SearchResponse.Facet getDefaultInstance()
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static SearchResponse.Facet.Builder newBuilder()
Returns | |
---|---|
Type | Description |
SearchResponse.Facet.Builder |
newBuilder(SearchResponse.Facet prototype)
public static SearchResponse.Facet.Builder newBuilder(SearchResponse.Facet prototype)
Parameter | |
---|---|
Name | Description |
prototype |
SearchResponse.Facet |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet.Builder |
parseDelimitedFrom(InputStream input)
public static SearchResponse.Facet parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Facet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static SearchResponse.Facet parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Facet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static SearchResponse.Facet parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Facet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static SearchResponse.Facet parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Facet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static SearchResponse.Facet parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Facet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static SearchResponse.Facet parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.Facet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<SearchResponse.Facet> parser()
Returns | |
---|---|
Type | Description |
Parser<Facet> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public SearchResponse.Facet getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SearchResponse.Facet |
getDynamicFacet()
public boolean getDynamicFacet()
Whether the facet is dynamically generated.
bool dynamic_facet = 3;
Returns | |
---|---|
Type | Description |
boolean |
The dynamicFacet. |
getKey()
public String getKey()
The key for this facet. For example, "colors"
or "price"
. It matches
SearchRequest.FacetSpec.FacetKey.key.
string key = 1;
Returns | |
---|---|
Type | Description |
String |
The key. |
getKeyBytes()
public ByteString getKeyBytes()
The key for this facet. For example, "colors"
or "price"
. It matches
SearchRequest.FacetSpec.FacetKey.key.
string key = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for key. |
getParserForType()
public Parser<SearchResponse.Facet> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Facet> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getValues(int index)
public SearchResponse.Facet.FacetValue getValues(int index)
The facet values for this field.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet.FacetValue |
getValuesCount()
public int getValuesCount()
The facet values for this field.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;
Returns | |
---|---|
Type | Description |
int |
getValuesList()
public List<SearchResponse.Facet.FacetValue> getValuesList()
The facet values for this field.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;
Returns | |
---|---|
Type | Description |
List<FacetValue> |
getValuesOrBuilder(int index)
public SearchResponse.Facet.FacetValueOrBuilder getValuesOrBuilder(int index)
The facet values for this field.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet.FacetValueOrBuilder |
getValuesOrBuilderList()
public List<? extends SearchResponse.Facet.FacetValueOrBuilder> getValuesOrBuilderList()
The facet values for this field.
repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValueOrBuilder> |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public SearchResponse.Facet.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
SearchResponse.Facet.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchResponse.Facet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
SearchResponse.Facet.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public SearchResponse.Facet.Builder toBuilder()
Returns | |
---|---|
Type | Description |
SearchResponse.Facet.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |