Class GenerationOptions (0.9.0)

public final class GenerationOptions extends GeneratedMessageV3 implements GenerationOptionsOrBuilder

Options to control query generation, execution, and response format.

Protobuf type google.cloud.geminidataanalytics.v1beta.GenerationOptions

Static Fields

GENERATE_DISAMBIGUATION_QUESTION_FIELD_NUMBER

public static final int GENERATE_DISAMBIGUATION_QUESTION_FIELD_NUMBER
Field Value
Type Description
int

GENERATE_EXPLANATION_FIELD_NUMBER

public static final int GENERATE_EXPLANATION_FIELD_NUMBER
Field Value
Type Description
int

GENERATE_NATURAL_LANGUAGE_ANSWER_FIELD_NUMBER

public static final int GENERATE_NATURAL_LANGUAGE_ANSWER_FIELD_NUMBER
Field Value
Type Description
int

GENERATE_QUERY_RESULT_FIELD_NUMBER

public static final int GENERATE_QUERY_RESULT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerationOptions getDefaultInstance()
Returns
Type Description
GenerationOptions

getDescriptor()

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

newBuilder()

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

newBuilder(GenerationOptions prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GenerationOptions getDefaultInstanceForType()
Returns
Type Description
GenerationOptions

getGenerateDisambiguationQuestion()

public boolean getGenerateDisambiguationQuestion()

Optional. If true (default to false), the service may return a clarifying_question if the input query is ambiguous.

bool generate_disambiguation_question = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The generateDisambiguationQuestion.

getGenerateExplanation()

public boolean getGenerateExplanation()

Optional. If true, an explanation of the generated query will be returned in the response.

bool generate_explanation = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The generateExplanation.

getGenerateNaturalLanguageAnswer()

public boolean getGenerateNaturalLanguageAnswer()

Optional. If true, a natural language answer based on the query execution result will be generated and returned in the response.

bool generate_natural_language_answer = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The generateNaturalLanguageAnswer.

getGenerateQueryResult()

public boolean getGenerateQueryResult()

Optional. If true, the generated query will be executed, and the result data will be returned in the response.

bool generate_query_result = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The generateQueryResult.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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