Class AnalysisEvent (0.1.0)

public final class AnalysisEvent extends GeneratedMessageV3 implements AnalysisEventOrBuilder

An event indicating the progress of an analysis.

Protobuf type google.cloud.geminidataanalytics.v1beta.AnalysisEvent

Static Fields

CODER_INSTRUCTION_FIELD_NUMBER

public static final int CODER_INSTRUCTION_FIELD_NUMBER
Field Value
Type Description
int

CODE_FIELD_NUMBER

public static final int CODE_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_ERROR_FIELD_NUMBER

public static final int EXECUTION_ERROR_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_OUTPUT_FIELD_NUMBER

public static final int EXECUTION_OUTPUT_FIELD_NUMBER
Field Value
Type Description
int

PLANNER_REASONING_FIELD_NUMBER

public static final int PLANNER_REASONING_FIELD_NUMBER
Field Value
Type Description
int

RESULT_CSV_DATA_FIELD_NUMBER

public static final int RESULT_CSV_DATA_FIELD_NUMBER
Field Value
Type Description
int

RESULT_NATURAL_LANGUAGE_FIELD_NUMBER

public static final int RESULT_NATURAL_LANGUAGE_FIELD_NUMBER
Field Value
Type Description
int

RESULT_REFERENCE_DATA_FIELD_NUMBER

public static final int RESULT_REFERENCE_DATA_FIELD_NUMBER
Field Value
Type Description
int

RESULT_VEGA_CHART_JSON_FIELD_NUMBER

public static final int RESULT_VEGA_CHART_JSON_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnalysisEvent getDefaultInstance()
Returns
Type Description
AnalysisEvent

getDescriptor()

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

newBuilder()

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

newBuilder(AnalysisEvent prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCode()

public String getCode()

Generated code.

string code = 4;

Returns
Type Description
String

The code.

getCodeBytes()

public ByteString getCodeBytes()

Generated code.

string code = 4;

Returns
Type Description
ByteString

The bytes for code.

getCoderInstruction()

public String getCoderInstruction()

Instructions issued for code generation.

string coder_instruction = 3;

Returns
Type Description
String

The coderInstruction.

getCoderInstructionBytes()

public ByteString getCoderInstructionBytes()

Instructions issued for code generation.

string coder_instruction = 3;

Returns
Type Description
ByteString

The bytes for coderInstruction.

getDefaultInstanceForType()

public AnalysisEvent getDefaultInstanceForType()
Returns
Type Description
AnalysisEvent

getError()

public String getError()

A generic error message.

string error = 11;

Returns
Type Description
String

The error.

getErrorBytes()

public ByteString getErrorBytes()

A generic error message.

string error = 11;

Returns
Type Description
ByteString

The bytes for error.

getExecutionError()

public String getExecutionError()

An error from code execution.

string execution_error = 6;

Returns
Type Description
String

The executionError.

getExecutionErrorBytes()

public ByteString getExecutionErrorBytes()

An error from code execution.

string execution_error = 6;

Returns
Type Description
ByteString

The bytes for executionError.

getExecutionOutput()

public String getExecutionOutput()

Output from code execution.

string execution_output = 5;

Returns
Type Description
String

The executionOutput.

getExecutionOutputBytes()

public ByteString getExecutionOutputBytes()

Output from code execution.

string execution_output = 5;

Returns
Type Description
ByteString

The bytes for executionOutput.

getKindCase()

public AnalysisEvent.KindCase getKindCase()
Returns
Type Description
AnalysisEvent.KindCase

getParserForType()

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

getPlannerReasoning()

public String getPlannerReasoning()

Python codegen planner's reasoning.

string planner_reasoning = 2;

Returns
Type Description
String

The plannerReasoning.

getPlannerReasoningBytes()

public ByteString getPlannerReasoningBytes()

Python codegen planner's reasoning.

string planner_reasoning = 2;

Returns
Type Description
ByteString

The bytes for plannerReasoning.

getResultCsvData()

public String getResultCsvData()

Result as CSV string.

string result_csv_data = 9;

Returns
Type Description
String

The resultCsvData.

getResultCsvDataBytes()

public ByteString getResultCsvDataBytes()

Result as CSV string.

string result_csv_data = 9;

Returns
Type Description
ByteString

The bytes for resultCsvData.

getResultNaturalLanguage()

public String getResultNaturalLanguage()

Result as NL string.

string result_natural_language = 8;

Returns
Type Description
String

The resultNaturalLanguage.

getResultNaturalLanguageBytes()

public ByteString getResultNaturalLanguageBytes()

Result as NL string.

string result_natural_language = 8;

Returns
Type Description
ByteString

The bytes for resultNaturalLanguage.

getResultReferenceData()

public String getResultReferenceData()

Result as a reference to a data source.

string result_reference_data = 10;

Returns
Type Description
String

The resultReferenceData.

getResultReferenceDataBytes()

public ByteString getResultReferenceDataBytes()

Result as a reference to a data source.

string result_reference_data = 10;

Returns
Type Description
ByteString

The bytes for resultReferenceData.

getResultVegaChartJson()

public String getResultVegaChartJson()

Result as Vega chart JSON string.

string result_vega_chart_json = 7;

Returns
Type Description
String

The resultVegaChartJson.

getResultVegaChartJsonBytes()

public ByteString getResultVegaChartJsonBytes()

Result as Vega chart JSON string.

string result_vega_chart_json = 7;

Returns
Type Description
ByteString

The bytes for resultVegaChartJson.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCode()

public boolean hasCode()

Generated code.

string code = 4;

Returns
Type Description
boolean

Whether the code field is set.

hasCoderInstruction()

public boolean hasCoderInstruction()

Instructions issued for code generation.

string coder_instruction = 3;

Returns
Type Description
boolean

Whether the coderInstruction field is set.

hasError()

public boolean hasError()

A generic error message.

string error = 11;

Returns
Type Description
boolean

Whether the error field is set.

hasExecutionError()

public boolean hasExecutionError()

An error from code execution.

string execution_error = 6;

Returns
Type Description
boolean

Whether the executionError field is set.

hasExecutionOutput()

public boolean hasExecutionOutput()

Output from code execution.

string execution_output = 5;

Returns
Type Description
boolean

Whether the executionOutput field is set.

hasPlannerReasoning()

public boolean hasPlannerReasoning()

Python codegen planner's reasoning.

string planner_reasoning = 2;

Returns
Type Description
boolean

Whether the plannerReasoning field is set.

hasResultCsvData()

public boolean hasResultCsvData()

Result as CSV string.

string result_csv_data = 9;

Returns
Type Description
boolean

Whether the resultCsvData field is set.

hasResultNaturalLanguage()

public boolean hasResultNaturalLanguage()

Result as NL string.

string result_natural_language = 8;

Returns
Type Description
boolean

Whether the resultNaturalLanguage field is set.

hasResultReferenceData()

public boolean hasResultReferenceData()

Result as a reference to a data source.

string result_reference_data = 10;

Returns
Type Description
boolean

Whether the resultReferenceData field is set.

hasResultVegaChartJson()

public boolean hasResultVegaChartJson()

Result as Vega chart JSON string.

string result_vega_chart_json = 7;

Returns
Type Description
boolean

Whether the resultVegaChartJson 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 AnalysisEvent.Builder newBuilderForType()
Returns
Type Description
AnalysisEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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