Class CompleteQueryResponse.CompletionResult.Builder (2.26.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.v2beta.CompleteQueryResponse.CompletionResult

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.CompletionResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides

build()

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

buildPartial()

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

clear()

public CompleteQueryResponse.CompletionResult.Builder clear()
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides

clearAttributes()

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

clearField(Descriptors.FieldDescriptor field)

public CompleteQueryResponse.CompletionResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.CompletionResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides

clearSuggestion()

public CompleteQueryResponse.CompletionResult.Builder clearSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder

This builder for chaining.

clone()

public CompleteQueryResponse.CompletionResult.Builder clone()
Returns
TypeDescription
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.v2beta.CustomAttribute> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

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

Parameter
NameDescription
keyString
Returns
TypeDescription
CustomAttribute

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMutableAttributes()

public Map<String,CustomAttribute> getMutableAttributes()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,CustomAttribute>

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CompleteQueryResponse.CompletionResult other)

public CompleteQueryResponse.CompletionResult.Builder mergeFrom(CompleteQueryResponse.CompletionResult other)
Parameter
NameDescription
otherCompleteQueryResponse.CompletionResult
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CompleteQueryResponse.CompletionResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CompleteQueryResponse.CompletionResult.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.CompletionResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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.v2beta.CustomAttribute> attributes = 2;

Parameter
NameDescription
valuesMap<String,CustomAttribute>
Returns
TypeDescription
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.v2beta.CustomAttribute> attributes = 2;

Parameters
NameDescription
keyString
valueCustomAttribute
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.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.v2beta.CustomAttribute> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CompleteQueryResponse.CompletionResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides

setSuggestion(String value)

public CompleteQueryResponse.CompletionResult.Builder setSuggestion(String value)

The suggestion for the query.

string suggestion = 1;

Parameter
NameDescription
valueString

The suggestion to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for suggestion to set.

Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.CompletionResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CompleteQueryResponse.CompletionResult.Builder
Overrides