com.google.cloud.retail.v2alpha

Class CompleteQueryResponse.CompletionResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2alpha.CompleteQueryResponse.CompletionResult

All Implemented Interfaces:

CompleteQueryResponse.CompletionResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

CompleteQueryResponse

public static final class CompleteQueryResponse.CompletionResult
extends com.google.protobuf.GeneratedMessageV3
implements CompleteQueryResponse.CompletionResultOrBuilder

 Resource that represents completion results.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompleteQueryResponse.CompletionResult.Builder Resource that represents completion results.

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 and Description
static int	ATTRIBUTES_FIELD_NUMBER
static int	FACETS_FIELD_NUMBER
static int	SUGGESTION_FIELD_NUMBER
static int	TOTAL_PRODUCT_COUNT_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 and Description
boolean	containsAttributes(String key) Custom attributes for the suggestion term.
boolean	equals(Object obj)
Map<String,CustomAttribute>	getAttributes() Deprecated.
int	getAttributesCount() Custom attributes for the suggestion term.
Map<String,CustomAttribute>	getAttributesMap() Custom attributes for the suggestion term.
CustomAttribute	getAttributesOrDefault(String key, CustomAttribute defaultValue) Custom attributes for the suggestion term.
CustomAttribute	getAttributesOrThrow(String key) Custom attributes for the suggestion term.
static CompleteQueryResponse.CompletionResult	getDefaultInstance()
CompleteQueryResponse.CompletionResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
SearchResponse.Facet	getFacets(int index) Facet information for the suggestion term.
int	getFacetsCount() Facet information for the suggestion term.
List<SearchResponse.Facet>	getFacetsList() Facet information for the suggestion term.
SearchResponse.FacetOrBuilder	getFacetsOrBuilder(int index) Facet information for the suggestion term.
List<? extends SearchResponse.FacetOrBuilder>	getFacetsOrBuilderList() Facet information for the suggestion term.
com.google.protobuf.Parser<CompleteQueryResponse.CompletionResult>	getParserForType()
int	getSerializedSize()
String	getSuggestion() The suggestion for the query.
com.google.protobuf.ByteString	getSuggestionBytes() The suggestion for the query.
int	getTotalProductCount() Total number of products associated with a search with this suggestion.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static CompleteQueryResponse.CompletionResult.Builder	newBuilder()
static CompleteQueryResponse.CompletionResult.Builder	newBuilder(CompleteQueryResponse.CompletionResult prototype)
CompleteQueryResponse.CompletionResult.Builder	newBuilderForType()
protected CompleteQueryResponse.CompletionResult.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CompleteQueryResponse.CompletionResult	parseDelimitedFrom(InputStream input)
static CompleteQueryResponse.CompletionResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompleteQueryResponse.CompletionResult	parseFrom(byte[] data)
static CompleteQueryResponse.CompletionResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompleteQueryResponse.CompletionResult	parseFrom(ByteBuffer data)
static CompleteQueryResponse.CompletionResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompleteQueryResponse.CompletionResult	parseFrom(com.google.protobuf.ByteString data)
static CompleteQueryResponse.CompletionResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompleteQueryResponse.CompletionResult	parseFrom(com.google.protobuf.CodedInputStream input)
static CompleteQueryResponse.CompletionResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CompleteQueryResponse.CompletionResult	parseFrom(InputStream input)
static CompleteQueryResponse.CompletionResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CompleteQueryResponse.CompletionResult>	parser()
CompleteQueryResponse.CompletionResult.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SUGGESTION_FIELD_NUMBER

public static final int SUGGESTION_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER

See Also:

Constant Field Values

FACETS_FIELD_NUMBER

public static final int FACETS_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_PRODUCT_COUNT_FIELD_NUMBER

public static final int TOTAL_PRODUCT_COUNT_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()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSuggestion

public String getSuggestion()

 The suggestion for the query.
 

string suggestion = 1;

Specified by:

getSuggestion in interface CompleteQueryResponse.CompletionResultOrBuilder

Returns:

The suggestion.

getSuggestionBytes

public com.google.protobuf.ByteString getSuggestionBytes()

 The suggestion for the query.
 

string suggestion = 1;

Specified by:

getSuggestionBytes in interface CompleteQueryResponse.CompletionResultOrBuilder

Returns:

The bytes for suggestion.

getAttributesCount

public int getAttributesCount()

Description copied from interface: CompleteQueryResponse.CompletionResultOrBuilder

 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][google.cloud.retail.v2alpha.UserEvent.product_details]
 is imported properly.
 

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

Specified by:

getAttributesCount in interface CompleteQueryResponse.CompletionResultOrBuilder

containsAttributes

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][google.cloud.retail.v2alpha.UserEvent.product_details]
 is imported properly.
 

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

Specified by:

containsAttributes in interface CompleteQueryResponse.CompletionResultOrBuilder

getAttributes

@Deprecated
public Map<String,CustomAttribute> getAttributes()

Deprecated.

Use getAttributesMap() instead.

Specified by:

getAttributes in interface CompleteQueryResponse.CompletionResultOrBuilder

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][google.cloud.retail.v2alpha.UserEvent.product_details]
 is imported properly.
 

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

Specified by:

getAttributesMap in interface CompleteQueryResponse.CompletionResultOrBuilder

getAttributesOrDefault

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][google.cloud.retail.v2alpha.UserEvent.product_details]
 is imported properly.
 

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

Specified by:

getAttributesOrDefault in interface CompleteQueryResponse.CompletionResultOrBuilder

getAttributesOrThrow

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][google.cloud.retail.v2alpha.UserEvent.product_details]
 is imported properly.
 

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

Specified by:

getAttributesOrThrow in interface CompleteQueryResponse.CompletionResultOrBuilder

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;

Specified by:

getFacetsList in interface CompleteQueryResponse.CompletionResultOrBuilder

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;

Specified by:

getFacetsOrBuilderList in interface CompleteQueryResponse.CompletionResultOrBuilder

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;

Specified by:

getFacetsCount in interface CompleteQueryResponse.CompletionResultOrBuilder

getFacets

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;

Specified by:

getFacets in interface CompleteQueryResponse.CompletionResultOrBuilder

getFacetsOrBuilder

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;

Specified by:

getFacetsOrBuilder in interface CompleteQueryResponse.CompletionResultOrBuilder

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;

Specified by:

getTotalProductCount in interface CompleteQueryResponse.CompletionResultOrBuilder

Returns:

The totalProductCount.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompleteQueryResponse.CompletionResult parseFrom(com.google.protobuf.ByteString data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompleteQueryResponse.CompletionResult parseFrom(byte[] data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CompleteQueryResponse.CompletionResult parseFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static CompleteQueryResponse.CompletionResult parseDelimitedFrom(InputStream input)
                                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static CompleteQueryResponse.CompletionResult parseFrom(com.google.protobuf.CodedInputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public CompleteQueryResponse.CompletionResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CompleteQueryResponse.CompletionResult.Builder newBuilder()

newBuilder

public static CompleteQueryResponse.CompletionResult.Builder newBuilder(CompleteQueryResponse.CompletionResult prototype)

toBuilder

public CompleteQueryResponse.CompletionResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CompleteQueryResponse.CompletionResult.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CompleteQueryResponse.CompletionResult getDefaultInstance()

parser

public static com.google.protobuf.Parser<CompleteQueryResponse.CompletionResult> parser()

getParserForType

public com.google.protobuf.Parser<CompleteQueryResponse.CompletionResult> 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 CompleteQueryResponse.CompletionResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder