Represents a SystemMessage.
Package
@google-cloud/geminidataanalyticsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.geminidataanalytics.v1beta.ISystemMessage);Constructs a new SystemMessage.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISystemMessage
Properties to set |
Properties
analysis
public analysis?: (google.cloud.geminidataanalytics.v1beta.IAnalysisMessage|null);SystemMessage analysis.
chart
public chart?: (google.cloud.geminidataanalytics.v1beta.IChartMessage|null);SystemMessage chart.
data
public data?: (google.cloud.geminidataanalytics.v1beta.IDataMessage|null);SystemMessage data.
error
public error?: (google.cloud.geminidataanalytics.v1beta.IErrorMessage|null);SystemMessage error.
exampleQueries
public exampleQueries?: (google.cloud.geminidataanalytics.v1beta.IExampleQueries|null);SystemMessage exampleQueries.
groupId
public groupId?: (number|null);SystemMessage groupId.
kind
public kind?: ("text"|"schema"|"data"|"analysis"|"chart"|"error"|"exampleQueries");SystemMessage kind.
schema
public schema?: (google.cloud.geminidataanalytics.v1beta.ISchemaMessage|null);SystemMessage schema.
text
public text?: (google.cloud.geminidataanalytics.v1beta.ITextMessage|null);SystemMessage text.
Methods
create(properties)
public static create(properties?: google.cloud.geminidataanalytics.v1beta.ISystemMessage): google.cloud.geminidataanalytics.v1beta.SystemMessage;Creates a new SystemMessage instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISystemMessage
Properties to set |
| Returns | |
|---|---|
| Type | Description |
SystemMessage |
SystemMessage instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.geminidataanalytics.v1beta.SystemMessage;Decodes a SystemMessage 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 |
SystemMessage |
SystemMessage |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.geminidataanalytics.v1beta.SystemMessage;Decodes a SystemMessage message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
SystemMessage |
SystemMessage |
encode(message, writer)
public static encode(message: google.cloud.geminidataanalytics.v1beta.ISystemMessage, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SystemMessage message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISystemMessage
SystemMessage 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.v1beta.ISystemMessage, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SystemMessage message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISystemMessage
SystemMessage 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.v1beta.SystemMessage;Creates a SystemMessage 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 |
SystemMessage |
SystemMessage |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for SystemMessage
| 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 SystemMessage to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.geminidataanalytics.v1beta.SystemMessage, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a SystemMessage message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
SystemMessage
SystemMessage |
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 a SystemMessage message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|