Class CompleteQueryResponse.CompletionResult.Builder (2.47.0)

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

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

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.CompletionResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CompleteQueryResponse.CompletionResult.Builder
Overrides

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

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

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

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

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
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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.CompletionResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CompleteQueryResponse.CompletionResult.Builder
Overrides

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

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

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