Class QueryDataResponse (0.9.0)

public final class QueryDataResponse extends GeneratedMessageV3 implements QueryDataResponseOrBuilder

Response containing the generated query and related information.

Protobuf type google.cloud.geminidataanalytics.v1beta.QueryDataResponse

Static Fields

DISAMBIGUATION_QUESTION_FIELD_NUMBER

public static final int DISAMBIGUATION_QUESTION_FIELD_NUMBER
Field Value
Type Description
int

GENERATED_QUERY_FIELD_NUMBER

public static final int GENERATED_QUERY_FIELD_NUMBER
Field Value
Type Description
int

INTENT_EXPLANATION_FIELD_NUMBER

public static final int INTENT_EXPLANATION_FIELD_NUMBER
Field Value
Type Description
int

NATURAL_LANGUAGE_ANSWER_FIELD_NUMBER

public static final int NATURAL_LANGUAGE_ANSWER_FIELD_NUMBER
Field Value
Type Description
int

QUERY_RESULT_FIELD_NUMBER

public static final int QUERY_RESULT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryDataResponse getDefaultInstance()
Returns
Type Description
QueryDataResponse

getDescriptor()

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

newBuilder()

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

newBuilder(QueryDataResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public QueryDataResponse getDefaultInstanceForType()
Returns
Type Description
QueryDataResponse

getDisambiguationQuestion(int index)

public String getDisambiguationQuestion(int index)

If ambiguity was detected in the natural language query and options.generate_disambiguation_question was true, this field contains a question to the user for clarification. The returned represents the service's best effort based on the ambiguous input.

repeated string disambiguation_question = 5;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The disambiguationQuestion at the given index.

getDisambiguationQuestionBytes(int index)

public ByteString getDisambiguationQuestionBytes(int index)

If ambiguity was detected in the natural language query and options.generate_disambiguation_question was true, this field contains a question to the user for clarification. The returned represents the service's best effort based on the ambiguous input.

repeated string disambiguation_question = 5;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the disambiguationQuestion at the given index.

getDisambiguationQuestionCount()

public int getDisambiguationQuestionCount()

If ambiguity was detected in the natural language query and options.generate_disambiguation_question was true, this field contains a question to the user for clarification. The returned represents the service's best effort based on the ambiguous input.

repeated string disambiguation_question = 5;

Returns
Type Description
int

The count of disambiguationQuestion.

getDisambiguationQuestionList()

public ProtocolStringList getDisambiguationQuestionList()

If ambiguity was detected in the natural language query and options.generate_disambiguation_question was true, this field contains a question to the user for clarification. The returned represents the service's best effort based on the ambiguous input.

repeated string disambiguation_question = 5;

Returns
Type Description
ProtocolStringList

A list containing the disambiguationQuestion.

getGeneratedQuery()

public String getGeneratedQuery()

Generated query for the given user prompt.

string generated_query = 1;

Returns
Type Description
String

The generatedQuery.

getGeneratedQueryBytes()

public ByteString getGeneratedQueryBytes()

Generated query for the given user prompt.

string generated_query = 1;

Returns
Type Description
ByteString

The bytes for generatedQuery.

getIntentExplanation()

public String getIntentExplanation()

A natural language explanation of the generated query. Populated if options.generate_explanation was true in the request.

string intent_explanation = 2;

Returns
Type Description
String

The intentExplanation.

getIntentExplanationBytes()

public ByteString getIntentExplanationBytes()

A natural language explanation of the generated query. Populated if options.generate_explanation was true in the request.

string intent_explanation = 2;

Returns
Type Description
ByteString

The bytes for intentExplanation.

getNaturalLanguageAnswer()

public String getNaturalLanguageAnswer()

A natural language answer to the query, based on the query_result. Populated if options.generate_natural_language_answer was true in the request and query execution was successful based in the response from executeSql API.

string natural_language_answer = 4;

Returns
Type Description
String

The naturalLanguageAnswer.

getNaturalLanguageAnswerBytes()

public ByteString getNaturalLanguageAnswerBytes()

A natural language answer to the query, based on the query_result. Populated if options.generate_natural_language_answer was true in the request and query execution was successful based in the response from executeSql API.

string natural_language_answer = 4;

Returns
Type Description
ByteString

The bytes for naturalLanguageAnswer.

getParserForType()

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

getQueryResult()

public ExecutedQueryResult getQueryResult()

The result of executing the query. Populated if options.generate_query_result or options.generate_natural_language_answer was true in the request, and execution was successful or attempted.

.google.cloud.geminidataanalytics.v1beta.ExecutedQueryResult query_result = 3;

Returns
Type Description
ExecutedQueryResult

The queryResult.

getQueryResultOrBuilder()

public ExecutedQueryResultOrBuilder getQueryResultOrBuilder()

The result of executing the query. Populated if options.generate_query_result or options.generate_natural_language_answer was true in the request, and execution was successful or attempted.

.google.cloud.geminidataanalytics.v1beta.ExecutedQueryResult query_result = 3;

Returns
Type Description
ExecutedQueryResultOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasQueryResult()

public boolean hasQueryResult()

The result of executing the query. Populated if options.generate_query_result or options.generate_natural_language_answer was true in the request, and execution was successful or attempted.

.google.cloud.geminidataanalytics.v1beta.ExecutedQueryResult query_result = 3;

Returns
Type Description
boolean

Whether the queryResult field is set.

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 QueryDataResponse.Builder newBuilderForType()
Returns
Type Description
QueryDataResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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