Class CompleteQueryResponse.Builder (0.49.0)

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

Response message for CompletionService.CompleteQuery method.

Protobuf type google.cloud.discoveryengine.v1.CompleteQueryResponse

Inheritance

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

Implements

CompleteQueryResponseOrBuilder

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

addAllQuerySuggestions(Iterable<? extends CompleteQueryResponse.QuerySuggestion> values)

public CompleteQueryResponse.Builder addAllQuerySuggestions(Iterable<? extends CompleteQueryResponse.QuerySuggestion> values)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion>`

Returns
Type	Description
`CompleteQueryResponse.Builder`

addQuerySuggestions(CompleteQueryResponse.QuerySuggestion value)

public CompleteQueryResponse.Builder addQuerySuggestions(CompleteQueryResponse.QuerySuggestion value)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name	Description
`value`	`CompleteQueryResponse.QuerySuggestion`

Returns
Type	Description
`CompleteQueryResponse.Builder`

addQuerySuggestions(CompleteQueryResponse.QuerySuggestion.Builder builderForValue)

public CompleteQueryResponse.Builder addQuerySuggestions(CompleteQueryResponse.QuerySuggestion.Builder builderForValue)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name	Description
`builderForValue`	`CompleteQueryResponse.QuerySuggestion.Builder`

Returns
Type	Description
`CompleteQueryResponse.Builder`

addQuerySuggestions(int index, CompleteQueryResponse.QuerySuggestion value)

public CompleteQueryResponse.Builder addQuerySuggestions(int index, CompleteQueryResponse.QuerySuggestion value)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameters
Name	Description
`index`	`int`
`value`	`CompleteQueryResponse.QuerySuggestion`

Returns
Type	Description
`CompleteQueryResponse.Builder`

addQuerySuggestions(int index, CompleteQueryResponse.QuerySuggestion.Builder builderForValue)

public CompleteQueryResponse.Builder addQuerySuggestions(int index, CompleteQueryResponse.QuerySuggestion.Builder builderForValue)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`CompleteQueryResponse.QuerySuggestion.Builder`

Returns
Type	Description
`CompleteQueryResponse.Builder`

addQuerySuggestionsBuilder()

public CompleteQueryResponse.QuerySuggestion.Builder addQuerySuggestionsBuilder()

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type	Description
`CompleteQueryResponse.QuerySuggestion.Builder`

addQuerySuggestionsBuilder(int index)

public CompleteQueryResponse.QuerySuggestion.Builder addQuerySuggestionsBuilder(int index)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.QuerySuggestion.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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

build()

public CompleteQueryResponse build()

Returns
Type	Description
`CompleteQueryResponse`

buildPartial()

public CompleteQueryResponse buildPartial()

Returns
Type	Description
`CompleteQueryResponse`

clear()

public CompleteQueryResponse.Builder clear()

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public CompleteQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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

clearQuerySuggestions()

public CompleteQueryResponse.Builder clearQuerySuggestions()

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type	Description
`CompleteQueryResponse.Builder`

clearTailMatchTriggered()

public CompleteQueryResponse.Builder clearTailMatchTriggered()

True if the returned suggestions are all tail suggestions.

For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.

bool tail_match_triggered = 2;

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

clone()

public CompleteQueryResponse.Builder clone()

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public CompleteQueryResponse getDefaultInstanceForType()

Returns
Type	Description
`CompleteQueryResponse`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getQuerySuggestions(int index)

public CompleteQueryResponse.QuerySuggestion getQuerySuggestions(int index)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.QuerySuggestion`

getQuerySuggestionsBuilder(int index)

public CompleteQueryResponse.QuerySuggestion.Builder getQuerySuggestionsBuilder(int index)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.QuerySuggestion.Builder`

getQuerySuggestionsBuilderList()

public List<CompleteQueryResponse.QuerySuggestion.Builder> getQuerySuggestionsBuilderList()

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type	Description
`List<Builder>`

getQuerySuggestionsCount()

public int getQuerySuggestionsCount()

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type	Description
`int`

getQuerySuggestionsList()

public List<CompleteQueryResponse.QuerySuggestion> getQuerySuggestionsList()

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type	Description
`List<QuerySuggestion>`

getQuerySuggestionsOrBuilder(int index)

public CompleteQueryResponse.QuerySuggestionOrBuilder getQuerySuggestionsOrBuilder(int index)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.QuerySuggestionOrBuilder`

getQuerySuggestionsOrBuilderList()

public List<? extends CompleteQueryResponse.QuerySuggestionOrBuilder> getQuerySuggestionsOrBuilderList()

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type	Description
`List<? extends com.google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestionOrBuilder>`

getTailMatchTriggered()

public boolean getTailMatchTriggered()

True if the returned suggestions are all tail suggestions.

For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.

bool tail_match_triggered = 2;

Returns
Type	Description
`boolean`	The tailMatchTriggered.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CompleteQueryResponse other)

public CompleteQueryResponse.Builder mergeFrom(CompleteQueryResponse other)

Parameter
Name	Description
`other`	`CompleteQueryResponse`

Returns
Type	Description
`CompleteQueryResponse.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public CompleteQueryResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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

removeQuerySuggestions(int index)

public CompleteQueryResponse.Builder removeQuerySuggestions(int index)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CompleteQueryResponse.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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

setQuerySuggestions(int index, CompleteQueryResponse.QuerySuggestion value)

public CompleteQueryResponse.Builder setQuerySuggestions(int index, CompleteQueryResponse.QuerySuggestion value)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameters
Name	Description
`index`	`int`
`value`	`CompleteQueryResponse.QuerySuggestion`

Returns
Type	Description
`CompleteQueryResponse.Builder`

setQuerySuggestions(int index, CompleteQueryResponse.QuerySuggestion.Builder builderForValue)

public CompleteQueryResponse.Builder setQuerySuggestions(int index, CompleteQueryResponse.QuerySuggestion.Builder builderForValue)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

repeated .google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`CompleteQueryResponse.QuerySuggestion.Builder`

Returns
Type	Description
`CompleteQueryResponse.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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

setTailMatchTriggered(boolean value)

public CompleteQueryResponse.Builder setTailMatchTriggered(boolean value)

True if the returned suggestions are all tail suggestions.

For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.

bool tail_match_triggered = 2;

Parameter
Name	Description
`value`	`boolean` The tailMatchTriggered to set.

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

setUnknownFields(UnknownFieldSet unknownFields)

public final CompleteQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`CompleteQueryResponse.Builder`

Overrides

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