Represents an AnalysisEvent.
Package
@google-cloud/geminidataanalyticsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.geminidataanalytics.v1alpha.IAnalysisEvent);Constructs a new AnalysisEvent.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAnalysisEvent
Properties to set |
Properties
code
public code?: (string|null);AnalysisEvent code.
coderInstruction
public coderInstruction?: (string|null);AnalysisEvent coderInstruction.
error
public error?: (string|null);AnalysisEvent error.
executionError
public executionError?: (string|null);AnalysisEvent executionError.
executionOutput
public executionOutput?: (string|null);AnalysisEvent executionOutput.
kind
public kind?: ("plannerReasoning"|"coderInstruction"|"code"|"executionOutput"|"executionError"|"resultVegaChartJson"|"resultNaturalLanguage"|"resultCsvData"|"resultReferenceData"|"error");AnalysisEvent kind.
plannerReasoning
public plannerReasoning?: (string|null);AnalysisEvent plannerReasoning.
resultCsvData
public resultCsvData?: (string|null);AnalysisEvent resultCsvData.
resultNaturalLanguage
public resultNaturalLanguage?: (string|null);AnalysisEvent resultNaturalLanguage.
resultReferenceData
public resultReferenceData?: (string|null);AnalysisEvent resultReferenceData.
resultVegaChartJson
public resultVegaChartJson?: (string|null);AnalysisEvent resultVegaChartJson.
Methods
create(properties)
public static create(properties?: google.cloud.geminidataanalytics.v1alpha.IAnalysisEvent): google.cloud.geminidataanalytics.v1alpha.AnalysisEvent;Creates a new AnalysisEvent instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAnalysisEvent
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AnalysisEvent |
AnalysisEvent instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.geminidataanalytics.v1alpha.AnalysisEvent;Decodes an AnalysisEvent message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
AnalysisEvent |
AnalysisEvent |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.geminidataanalytics.v1alpha.AnalysisEvent;Decodes an AnalysisEvent message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AnalysisEvent |
AnalysisEvent |
encode(message, writer)
public static encode(message: google.cloud.geminidataanalytics.v1alpha.IAnalysisEvent, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AnalysisEvent message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAnalysisEvent
AnalysisEvent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.geminidataanalytics.v1alpha.IAnalysisEvent, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AnalysisEvent message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAnalysisEvent
AnalysisEvent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.geminidataanalytics.v1alpha.AnalysisEvent;Creates an AnalysisEvent message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
AnalysisEvent |
AnalysisEvent |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AnalysisEvent
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this AnalysisEvent to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.geminidataanalytics.v1alpha.AnalysisEvent, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AnalysisEvent message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AnalysisEvent
AnalysisEvent |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an AnalysisEvent message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|