Class CompleteQueryResponse.CompletionResult.Builder (2.47.0)

Version 2.47.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static final class CompleteQueryResponse.CompletionResult.Builder extends GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder> implements CompleteQueryResponse.CompletionResultOrBuilder

Resource that represents completion results.

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

Inheritance

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

Implements

CompleteQueryResponse.CompletionResultOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.CompletionResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CompleteQueryResponse.CompletionResult build()

Returns
Type	Description
CompleteQueryResponse.CompletionResult

buildPartial()

public CompleteQueryResponse.CompletionResult buildPartial()

Returns
Type	Description
CompleteQueryResponse.CompletionResult

clear()

public CompleteQueryResponse.CompletionResult.Builder clear()

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAttributes()

public CompleteQueryResponse.CompletionResult.Builder clearAttributes()

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

clearField(Descriptors.FieldDescriptor field)

public CompleteQueryResponse.CompletionResult.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.CompletionResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSuggestion()

public CompleteQueryResponse.CompletionResult.Builder clearSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder	This builder for chaining.

clone()

public CompleteQueryResponse.CompletionResult.Builder clone()

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.v2.CustomAttribute> attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAttributes() (deprecated)

public Map<String,CustomAttribute> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
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.v2.CustomAttribute> attributes = 2;

Returns
Type	Description
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.v2.CustomAttribute> attributes = 2;

Returns
Type	Description
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.v2.CustomAttribute> attributes = 2;

Parameters
Name	Description
key	String
defaultValue	CustomAttribute

Returns
Type	Description
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.v2.CustomAttribute> attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
CustomAttribute

getDefaultInstanceForType()

public CompleteQueryResponse.CompletionResult getDefaultInstanceForType()

Returns
Type	Description
CompleteQueryResponse.CompletionResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMutableAttributes() (deprecated)

public Map<String,CustomAttribute> getMutableAttributes()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,CustomAttribute>

getSuggestion()

public String getSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
Type	Description
String	The suggestion.

getSuggestionBytes()

public ByteString getSuggestionBytes()

The suggestion for the query.

string suggestion = 1;

Returns
Type	Description
ByteString	The bytes for suggestion.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CompleteQueryResponse.CompletionResult other)

public CompleteQueryResponse.CompletionResult.Builder mergeFrom(CompleteQueryResponse.CompletionResult other)

Parameter
Name	Description
other	CompleteQueryResponse.CompletionResult

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompleteQueryResponse.CompletionResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CompleteQueryResponse.CompletionResult.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.CompletionResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllAttributes(Map<String,CustomAttribute> values)

public CompleteQueryResponse.CompletionResult.Builder putAllAttributes(Map<String,CustomAttribute> values)

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.v2.CustomAttribute> attributes = 2;

Parameter
Name	Description
values	Map<String,CustomAttribute>

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

putAttributes(String key, CustomAttribute value)

public CompleteQueryResponse.CompletionResult.Builder putAttributes(String key, CustomAttribute value)

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.v2.CustomAttribute> attributes = 2;

Parameters
Name	Description
key	String
value	CustomAttribute

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

putAttributesBuilderIfAbsent(String key)

public CustomAttribute.Builder putAttributesBuilderIfAbsent(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.v2.CustomAttribute> attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
CustomAttribute.Builder

removeAttributes(String key)

public CompleteQueryResponse.CompletionResult.Builder removeAttributes(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.v2.CustomAttribute> attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.CompletionResult.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CompleteQueryResponse.CompletionResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSuggestion(String value)

public CompleteQueryResponse.CompletionResult.Builder setSuggestion(String value)

The suggestion for the query.

string suggestion = 1;

Parameter
Name	Description
value	String The suggestion to set.

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder	This builder for chaining.

setSuggestionBytes(ByteString value)

public CompleteQueryResponse.CompletionResult.Builder setSuggestionBytes(ByteString value)

The suggestion for the query.

string suggestion = 1;

Parameter
Name	Description
value	ByteString The bytes for suggestion to set.

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.CompletionResult.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CompleteQueryResponse.CompletionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)