Class CompleteQueryResponse.Builder (0.30.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.discoveryengine.v1.CompleteQueryResponse.QuerySuggestion>
Returns
TypeDescription
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
NameDescription
valueCompleteQueryResponse.QuerySuggestion
Returns
TypeDescription
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
NameDescription
builderForValueCompleteQueryResponse.QuerySuggestion.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueCompleteQueryResponse.QuerySuggestion
Returns
TypeDescription
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
NameDescription
indexint
builderForValueCompleteQueryResponse.QuerySuggestion.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
CompleteQueryResponse.QuerySuggestion.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CompleteQueryResponse build()
Returns
TypeDescription
CompleteQueryResponse

buildPartial()

public CompleteQueryResponse buildPartial()
Returns
TypeDescription
CompleteQueryResponse

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

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

This builder for chaining.

clone()

public CompleteQueryResponse.Builder clone()
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

getDefaultInstanceForType()

public CompleteQueryResponse getDefaultInstanceForType()
Returns
TypeDescription
CompleteQueryResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The tailMatchTriggered.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CompleteQueryResponse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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
NameDescription
indexint
Returns
TypeDescription
CompleteQueryResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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
NameDescription
indexint
valueCompleteQueryResponse.QuerySuggestion
Returns
TypeDescription
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
NameDescription
indexint
builderForValueCompleteQueryResponse.QuerySuggestion.Builder
Returns
TypeDescription
CompleteQueryResponse.Builder

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

public CompleteQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CompleteQueryResponse.Builder
Overrides

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

The tailMatchTriggered to set.

Returns
TypeDescription
CompleteQueryResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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