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

Represents an AutoscalingEvent.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

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

Constructs a new AutoscalingEvent.

Parameter
NameDescription
properties IAutoscalingEvent

Properties to set

Properties

currentNumWorkers

public currentNumWorkers: (number|Long|string);

AutoscalingEvent currentNumWorkers.

description

public description?: (google.dataflow.v1beta3.IStructuredMessage|null);

AutoscalingEvent description.

eventType

public eventType: (google.dataflow.v1beta3.AutoscalingEvent.AutoscalingEventType|keyof typeof google.dataflow.v1beta3.AutoscalingEvent.AutoscalingEventType);

AutoscalingEvent eventType.

targetNumWorkers

public targetNumWorkers: (number|Long|string);

AutoscalingEvent targetNumWorkers.

time

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

AutoscalingEvent time.

workerPool

public workerPool: string;

AutoscalingEvent workerPool.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IAutoscalingEvent): google.dataflow.v1beta3.AutoscalingEvent;

Creates a new AutoscalingEvent instance using the specified properties.

Parameter
NameDescription
properties IAutoscalingEvent

Properties to set

Returns
TypeDescription
AutoscalingEvent

AutoscalingEvent instance

decode(reader, length)

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

Decodes an AutoscalingEvent 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
AutoscalingEvent

AutoscalingEvent

decodeDelimited(reader)

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

Decodes an AutoscalingEvent message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
AutoscalingEvent

AutoscalingEvent

encode(message, writer)

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

Encodes the specified AutoscalingEvent message. Does not implicitly messages.

Parameters
NameDescription
message IAutoscalingEvent

AutoscalingEvent 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.IAutoscalingEvent, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAutoscalingEvent

AutoscalingEvent 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.AutoscalingEvent;

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

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

Plain object

Returns
TypeDescription
AutoscalingEvent

AutoscalingEvent

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AutoscalingEvent

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 AutoscalingEvent to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message AutoscalingEvent

AutoscalingEvent

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AutoscalingEvent 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