com.google.cloud.retail.v2

Class CompleteQueryResponse.CompletionResult.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

com.google.cloud.retail.v2.CompleteQueryResponse.CompletionResult.Builder

All Implemented Interfaces:

CompleteQueryResponse.CompletionResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

CompleteQueryResponse.CompletionResult

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

 Resource that represents completion results.
 

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

Method Summary

Modifier and Type	Method and Description
CompleteQueryResponse.CompletionResult.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
CompleteQueryResponse.CompletionResult	build()
CompleteQueryResponse.CompletionResult	buildPartial()
CompleteQueryResponse.CompletionResult.Builder	clear()
CompleteQueryResponse.CompletionResult.Builder	clearAttributes()
CompleteQueryResponse.CompletionResult.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
CompleteQueryResponse.CompletionResult.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
CompleteQueryResponse.CompletionResult.Builder	clearSuggestion() The suggestion for the query.
CompleteQueryResponse.CompletionResult.Builder	clone()
boolean	containsAttributes(String key) Custom attributes for the suggestion term.
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.
CompleteQueryResponse.CompletionResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Map<String,CustomAttribute>	getMutableAttributes() Deprecated.
String	getSuggestion() The suggestion for the query.
com.google.protobuf.ByteString	getSuggestionBytes() The suggestion for the query.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
CompleteQueryResponse.CompletionResult.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
CompleteQueryResponse.CompletionResult.Builder	mergeFrom(CompleteQueryResponse.CompletionResult other)
CompleteQueryResponse.CompletionResult.Builder	mergeFrom(com.google.protobuf.Message other)
CompleteQueryResponse.CompletionResult.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
CompleteQueryResponse.CompletionResult.Builder	putAllAttributes(Map<String,CustomAttribute> values) Custom attributes for the suggestion term.
CompleteQueryResponse.CompletionResult.Builder	putAttributes(String key, CustomAttribute value) Custom attributes for the suggestion term.
CompleteQueryResponse.CompletionResult.Builder	removeAttributes(String key) Custom attributes for the suggestion term.
CompleteQueryResponse.CompletionResult.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
CompleteQueryResponse.CompletionResult.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
CompleteQueryResponse.CompletionResult.Builder	setSuggestion(String value) The suggestion for the query.
CompleteQueryResponse.CompletionResult.Builder	setSuggestionBytes(com.google.protobuf.ByteString value) The suggestion for the query.
CompleteQueryResponse.CompletionResult.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapFieldReflection, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<CompleteQueryResponse.CompletionResult.Builder>

internalGetMutableMapField

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

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

clear

public CompleteQueryResponse.CompletionResult.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

getDefaultInstanceForType

public CompleteQueryResponse.CompletionResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public CompleteQueryResponse.CompletionResult build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public CompleteQueryResponse.CompletionResult buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public CompleteQueryResponse.CompletionResult.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

clearField

public CompleteQueryResponse.CompletionResult.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

clearOneof

public CompleteQueryResponse.CompletionResult.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

mergeFrom

public CompleteQueryResponse.CompletionResult.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CompleteQueryResponse.CompletionResult.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CompleteQueryResponse.CompletionResult.Builder>

Throws:

IOException

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.

setSuggestion

public CompleteQueryResponse.CompletionResult.Builder setSuggestion(String value)

 The suggestion for the query.
 

string suggestion = 1;

Parameters:

value - The suggestion to set.

Returns:

This builder for chaining.

clearSuggestion

public CompleteQueryResponse.CompletionResult.Builder clearSuggestion()

 The suggestion for the query.
 

string suggestion = 1;

Returns:

This builder for chaining.

setSuggestionBytes

public CompleteQueryResponse.CompletionResult.Builder setSuggestionBytes(com.google.protobuf.ByteString value)

 The suggestion for the query.
 

string suggestion = 1;

Parameters:

value - The bytes for suggestion to set.

Returns:

This builder for chaining.

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.v2.UserEvent.product_details]
 is imported properly.
 

map<string, .google.cloud.retail.v2.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.v2.UserEvent.product_details]
 is imported properly.
 

map<string, .google.cloud.retail.v2.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.v2.UserEvent.product_details]
 is imported properly.
 

map<string, .google.cloud.retail.v2.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.v2.UserEvent.product_details]
 is imported properly.
 

map<string, .google.cloud.retail.v2.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.v2.UserEvent.product_details]
 is imported properly.
 

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

Specified by:

getAttributesOrThrow in interface CompleteQueryResponse.CompletionResultOrBuilder

clearAttributes

public CompleteQueryResponse.CompletionResult.Builder clearAttributes()

removeAttributes

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

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

getMutableAttributes

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

Deprecated.

Use alternate mutation accessors instead.

putAttributes

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

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

putAllAttributes

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

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

setUnknownFields

public final CompleteQueryResponse.CompletionResult.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>

mergeUnknownFields

public final CompleteQueryResponse.CompletionResult.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryResponse.CompletionResult.Builder>