Class CompleteQueryResponse.CompletionResult (2.26.0)

public static final class CompleteQueryResponse.CompletionResult extends GeneratedMessageV3 implements CompleteQueryResponse.CompletionResultOrBuilder

Resource that represents completion results.

Protobuf type google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CompleteQueryResponse.CompletionResult

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

FACETS_FIELD_NUMBER

public static final int FACETS_FIELD_NUMBER
Field Value
TypeDescription
int

SUGGESTION_FIELD_NUMBER

public static final int SUGGESTION_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_PRODUCT_COUNT_FIELD_NUMBER

public static final int TOTAL_PRODUCT_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CompleteQueryResponse.CompletionResult getDefaultInstance()
Returns
TypeDescription
CompleteQueryResponse.CompletionResult

getDescriptor()

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

newBuilder()

public static CompleteQueryResponse.CompletionResult.Builder newBuilder()
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder

newBuilder(CompleteQueryResponse.CompletionResult prototype)

public static CompleteQueryResponse.CompletionResult.Builder newBuilder(CompleteQueryResponse.CompletionResult prototype)
Parameter
NameDescription
prototypeCompleteQueryResponse.CompletionResult
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder

parseDelimitedFrom(InputStream input)

public static CompleteQueryResponse.CompletionResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompleteQueryResponse.CompletionResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static CompleteQueryResponse.CompletionResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CompleteQueryResponse.CompletionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static CompleteQueryResponse.CompletionResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CompleteQueryResponse.CompletionResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static CompleteQueryResponse.CompletionResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompleteQueryResponse.CompletionResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static CompleteQueryResponse.CompletionResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CompleteQueryResponse.CompletionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CompleteQueryResponse.CompletionResult> parser()
Returns
TypeDescription
Parser<CompletionResult>

Methods

containsAttributes(String key)

public boolean containsAttributes(String key)

Custom attributes for the suggestion term.

  • For "user-data", the attributes are additional custom attributes ingested through BigQuery.

  • For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getAttributes()

public Map<String,CustomAttribute> getAttributes()

Use #getAttributesMap() instead.

Returns
TypeDescription
Map<String,CustomAttribute>

getAttributesCount()

public int getAttributesCount()

Custom attributes for the suggestion term.

  • For "user-data", the attributes are additional custom attributes ingested through BigQuery.

  • For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Returns
TypeDescription
int

getAttributesMap()

public Map<String,CustomAttribute> getAttributesMap()

Custom attributes for the suggestion term.

  • For "user-data", the attributes are additional custom attributes ingested through BigQuery.

  • For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Returns
TypeDescription
Map<String,CustomAttribute>

getAttributesOrDefault(String key, CustomAttribute defaultValue)

public CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)

Custom attributes for the suggestion term.

  • For "user-data", the attributes are additional custom attributes ingested through BigQuery.

  • For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Parameters
NameDescription
keyString
defaultValueCustomAttribute
Returns
TypeDescription
CustomAttribute

getAttributesOrThrow(String key)

public CustomAttribute getAttributesOrThrow(String key)

Custom attributes for the suggestion term.

  • For "user-data", the attributes are additional custom attributes ingested through BigQuery.

  • For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
CustomAttribute

getDefaultInstanceForType()

public CompleteQueryResponse.CompletionResult getDefaultInstanceForType()
Returns
TypeDescription
CompleteQueryResponse.CompletionResult

getFacets(int index)

public SearchResponse.Facet getFacets(int index)

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. Please reach out to the support team if you would like to receive this information.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Facet

getFacetsCount()

public int getFacetsCount()

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. Please reach out to the support team if you would like to receive this information.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Returns
TypeDescription
int

getFacetsList()

public List<SearchResponse.Facet> getFacetsList()

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. Please reach out to the support team if you would like to receive this information.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Returns
TypeDescription
List<Facet>

getFacetsOrBuilder(int index)

public SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. Please reach out to the support team if you would like to receive this information.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.FacetOrBuilder

getFacetsOrBuilderList()

public List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. Please reach out to the support team if you would like to receive this information.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Returns
TypeDescription
List<? extends com.google.cloud.retail.v2alpha.SearchResponse.FacetOrBuilder>

getParserForType()

public Parser<CompleteQueryResponse.CompletionResult> getParserForType()
Returns
TypeDescription
Parser<CompletionResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSuggestion()

public String getSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
String

The suggestion.

getSuggestionBytes()

public ByteString getSuggestionBytes()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
ByteString

The bytes for suggestion.

getTotalProductCount()

public int getTotalProductCount()

Total number of products associated with a search with this suggestion.

This is an experimental feature for limited customers. Please reach out to the support team if you would like to receive this information.

int32 total_product_count = 4;

Returns
TypeDescription
int

The totalProductCount.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CompleteQueryResponse.CompletionResult.Builder newBuilderForType()
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompleteQueryResponse.CompletionResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public CompleteQueryResponse.CompletionResult.Builder toBuilder()
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder

writeTo(CodedOutputStream output)

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