Class AdvancedCompleteQueryResponse (0.72.0) 

public final class AdvancedCompleteQueryResponse extends GeneratedMessageV3 implements AdvancedCompleteQueryResponseOrBuilder

Response message for CompletionService.AdvancedCompleteQuery method.

Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AdvancedCompleteQueryResponse

Static Fields

CONTENT_SUGGESTIONS_FIELD_NUMBER

public static final int CONTENT_SUGGESTIONS_FIELD_NUMBER
Field Value
Type Description
int

PEOPLE_SUGGESTIONS_FIELD_NUMBER

public static final int PEOPLE_SUGGESTIONS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_SUGGESTIONS_FIELD_NUMBER

public static final int QUERY_SUGGESTIONS_FIELD_NUMBER
Field Value
Type Description
int

RECENT_SEARCH_SUGGESTIONS_FIELD_NUMBER

public static final int RECENT_SEARCH_SUGGESTIONS_FIELD_NUMBER
Field Value
Type Description
int

TAIL_MATCH_TRIGGERED_FIELD_NUMBER

public static final int TAIL_MATCH_TRIGGERED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AdvancedCompleteQueryResponse getDefaultInstance()
Returns
Type Description
AdvancedCompleteQueryResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AdvancedCompleteQueryResponse.Builder newBuilder()
Returns
Type Description
AdvancedCompleteQueryResponse.Builder

newBuilder(AdvancedCompleteQueryResponse prototype)

public static AdvancedCompleteQueryResponse.Builder newBuilder(AdvancedCompleteQueryResponse prototype)
Parameter
Name Description
prototype AdvancedCompleteQueryResponse
Returns
Type Description
AdvancedCompleteQueryResponse.Builder

parseDelimitedFrom(InputStream input)

public static AdvancedCompleteQueryResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AdvancedCompleteQueryResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AdvancedCompleteQueryResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AdvancedCompleteQueryResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AdvancedCompleteQueryResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AdvancedCompleteQueryResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AdvancedCompleteQueryResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AdvancedCompleteQueryResponse> parser()
Returns
Type Description
Parser<AdvancedCompleteQueryResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContentSuggestions(int index)

public AdvancedCompleteQueryResponse.ContentSuggestion getContentSuggestions(int index)

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.ContentSuggestion content_suggestions = 4;

Parameter
Name Description
index int
Returns
Type Description
AdvancedCompleteQueryResponse.ContentSuggestion

getContentSuggestionsCount()

public int getContentSuggestionsCount()

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.ContentSuggestion content_suggestions = 4;

Returns
Type Description
int

getContentSuggestionsList()

public List<AdvancedCompleteQueryResponse.ContentSuggestion> getContentSuggestionsList()

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.ContentSuggestion content_suggestions = 4;

Returns
Type Description
List<ContentSuggestion>

getContentSuggestionsOrBuilder(int index)

public AdvancedCompleteQueryResponse.ContentSuggestionOrBuilder getContentSuggestionsOrBuilder(int index)

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.ContentSuggestion content_suggestions = 4;

Parameter
Name Description
index int
Returns
Type Description
AdvancedCompleteQueryResponse.ContentSuggestionOrBuilder

getContentSuggestionsOrBuilderList()

public List<? extends AdvancedCompleteQueryResponse.ContentSuggestionOrBuilder> getContentSuggestionsOrBuilderList()

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.ContentSuggestion content_suggestions = 4;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.ContentSuggestionOrBuilder>

getDefaultInstanceForType()

public AdvancedCompleteQueryResponse getDefaultInstanceForType()
Returns
Type Description
AdvancedCompleteQueryResponse

getParserForType()

public Parser<AdvancedCompleteQueryResponse> getParserForType()
Returns
Type Description
Parser<AdvancedCompleteQueryResponse>
Overrides

getPeopleSuggestions(int index)

public AdvancedCompleteQueryResponse.PersonSuggestion getPeopleSuggestions(int index)

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.PersonSuggestion people_suggestions = 3;

Parameter
Name Description
index int
Returns
Type Description
AdvancedCompleteQueryResponse.PersonSuggestion

getPeopleSuggestionsCount()

public int getPeopleSuggestionsCount()

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.PersonSuggestion people_suggestions = 3;

Returns
Type Description
int

getPeopleSuggestionsList()

public List<AdvancedCompleteQueryResponse.PersonSuggestion> getPeopleSuggestionsList()

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.PersonSuggestion people_suggestions = 3;

Returns
Type Description
List<PersonSuggestion>

getPeopleSuggestionsOrBuilder(int index)

public AdvancedCompleteQueryResponse.PersonSuggestionOrBuilder getPeopleSuggestionsOrBuilder(int index)

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.PersonSuggestion people_suggestions = 3;

Parameter
Name Description
index int
Returns
Type Description
AdvancedCompleteQueryResponse.PersonSuggestionOrBuilder

getPeopleSuggestionsOrBuilderList()

public List<? extends AdvancedCompleteQueryResponse.PersonSuggestionOrBuilder> getPeopleSuggestionsOrBuilderList()

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

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.PersonSuggestion people_suggestions = 3;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.PersonSuggestionOrBuilder>

getQuerySuggestions(int index)

public AdvancedCompleteQueryResponse.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.v1beta.AdvancedCompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name Description
index int
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestion

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.v1beta.AdvancedCompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type Description
int

getQuerySuggestionsList()

public List<AdvancedCompleteQueryResponse.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.v1beta.AdvancedCompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type Description
List<QuerySuggestion>

getQuerySuggestionsOrBuilder(int index)

public AdvancedCompleteQueryResponse.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.v1beta.AdvancedCompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Parameter
Name Description
index int
Returns
Type Description
AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder

getQuerySuggestionsOrBuilderList()

public List<? extends AdvancedCompleteQueryResponse.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.v1beta.AdvancedCompleteQueryResponse.QuerySuggestion query_suggestions = 1;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.QuerySuggestionOrBuilder>

getRecentSearchSuggestions(int index)

public AdvancedCompleteQueryResponse.RecentSearchSuggestion getRecentSearchSuggestions(int index)

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.RecentSearchSuggestion recent_search_suggestions = 5;

Parameter
Name Description
index int
Returns
Type Description
AdvancedCompleteQueryResponse.RecentSearchSuggestion

getRecentSearchSuggestionsCount()

public int getRecentSearchSuggestionsCount()

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.RecentSearchSuggestion recent_search_suggestions = 5;

Returns
Type Description
int

getRecentSearchSuggestionsList()

public List<AdvancedCompleteQueryResponse.RecentSearchSuggestion> getRecentSearchSuggestionsList()

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.RecentSearchSuggestion recent_search_suggestions = 5;

Returns
Type Description
List<RecentSearchSuggestion>

getRecentSearchSuggestionsOrBuilder(int index)

public AdvancedCompleteQueryResponse.RecentSearchSuggestionOrBuilder getRecentSearchSuggestionsOrBuilder(int index)

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.RecentSearchSuggestion recent_search_suggestions = 5;

Parameter
Name Description
index int
Returns
Type Description
AdvancedCompleteQueryResponse.RecentSearchSuggestionOrBuilder

getRecentSearchSuggestionsOrBuilderList()

public List<? extends AdvancedCompleteQueryResponse.RecentSearchSuggestionOrBuilder> getRecentSearchSuggestionsOrBuilderList()

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.RecentSearchSuggestion recent_search_suggestions = 5;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryResponse.RecentSearchSuggestionOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AdvancedCompleteQueryResponse.Builder newBuilderForType()
Returns
Type Description
AdvancedCompleteQueryResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AdvancedCompleteQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AdvancedCompleteQueryResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AdvancedCompleteQueryResponse.Builder toBuilder()
Returns
Type Description
AdvancedCompleteQueryResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException