Class protos.google.dataflow.v1beta3.ProgressTimeseries (3.0.2)

Represents a ProgressTimeseries.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

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

Constructs a new ProgressTimeseries.

Parameter
NameDescription
properties IProgressTimeseries

Properties to set

Properties

currentProgress

public currentProgress: number;

ProgressTimeseries currentProgress.

dataPoints

public dataPoints: google.dataflow.v1beta3.ProgressTimeseries.IPoint[];

ProgressTimeseries dataPoints.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IProgressTimeseries): google.dataflow.v1beta3.ProgressTimeseries;

Creates a new ProgressTimeseries instance using the specified properties.

Parameter
NameDescription
properties IProgressTimeseries

Properties to set

Returns
TypeDescription
ProgressTimeseries

ProgressTimeseries instance

decode(reader, length)

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

Decodes a ProgressTimeseries message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
ProgressTimeseries

ProgressTimeseries

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ProgressTimeseries

ProgressTimeseries

encode(message, writer)

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

Encodes the specified ProgressTimeseries message. Does not implicitly messages.

Parameters
NameDescription
message IProgressTimeseries

ProgressTimeseries message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IProgressTimeseries

ProgressTimeseries message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

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

Plain object

Returns
TypeDescription
ProgressTimeseries

ProgressTimeseries

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ProgressTimeseries

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this ProgressTimeseries to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message ProgressTimeseries

ProgressTimeseries

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a ProgressTimeseries message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not