Class protos.google.dataflow.v1beta3.JobMessage

Represents a JobMessage.

Package

@google-cloud/dataflow!

Constructors

(constructor)(properties)

constructor(properties?: google.dataflow.v1beta3.IJobMessage);

Constructs a new JobMessage.

Parameter
TypeNameDescription
IJobMessageproperties

Properties to set

Properties

id

public id: string;

JobMessage id.

Property Value
TypeDescription
string

messageImportance

public messageImportance: (google.dataflow.v1beta3.JobMessageImportance|keyof typeof google.dataflow.v1beta3.JobMessageImportance);

JobMessage messageImportance.

Property Value
TypeDescription
(google.dataflow.v1beta3.JobMessageImportance|keyof typeof google.dataflow.v1beta3.JobMessageImportance)

messageText

public messageText: string;

JobMessage messageText.

Property Value
TypeDescription
string

time

public time?: (google.protobuf.ITimestamp|null);

JobMessage time.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IJobMessage): google.dataflow.v1beta3.JobMessage;

Creates a new JobMessage instance using the specified properties.

Parameter
TypeNameDescription
IJobMessageproperties

Properties to set

Returns
TypeDescription
google.dataflow.v1beta3.JobMessage

JobMessage instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.JobMessage;

Decodes a JobMessage message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.dataflow.v1beta3.JobMessage

JobMessage

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.JobMessage;

Decodes a JobMessage message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.dataflow.v1beta3.JobMessage

JobMessage

encode(message, writer)

public static encode(message: google.dataflow.v1beta3.IJobMessage, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified JobMessage message. Does not implicitly messages.

Parameters
TypeNameDescription
IJobMessagemessage

JobMessage message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.dataflow.v1beta3.IJobMessage, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified JobMessage message, length delimited. Does not implicitly messages.

Parameters
TypeNameDescription
IJobMessagemessage

JobMessage message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.dataflow.v1beta3.JobMessage;

Creates a JobMessage message from a plain object. Also converts values to their respective internal types.

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.dataflow.v1beta3.JobMessage

JobMessage

toJSON()

public toJSON(): { [k: string]: any };

Converts this JobMessage to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.dataflow.v1beta3.JobMessage, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a JobMessage message. Also converts values to other types if specified.

Parameters
TypeNameDescription
google.dataflow.v1beta3.JobMessagemessage

JobMessage

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a JobMessage message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not