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

Represents a FlexTemplateRuntimeEnvironment.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

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

Constructs a new FlexTemplateRuntimeEnvironment.

Parameter
NameDescription
properties IFlexTemplateRuntimeEnvironment

Properties to set

Properties

additionalExperiments

public additionalExperiments: string[];

FlexTemplateRuntimeEnvironment additionalExperiments.

additionalUserLabels

public additionalUserLabels: { [k: string]: string };

FlexTemplateRuntimeEnvironment additionalUserLabels.

autoscalingAlgorithm

public autoscalingAlgorithm: (google.dataflow.v1beta3.AutoscalingAlgorithm|keyof typeof google.dataflow.v1beta3.AutoscalingAlgorithm);

FlexTemplateRuntimeEnvironment autoscalingAlgorithm.

diskSizeGb

public diskSizeGb: number;

FlexTemplateRuntimeEnvironment diskSizeGb.

dumpHeapOnOom

public dumpHeapOnOom: boolean;

FlexTemplateRuntimeEnvironment dumpHeapOnOom.

enableStreamingEngine

public enableStreamingEngine: boolean;

FlexTemplateRuntimeEnvironment enableStreamingEngine.

flexrsGoal

public flexrsGoal: (google.dataflow.v1beta3.FlexResourceSchedulingGoal|keyof typeof google.dataflow.v1beta3.FlexResourceSchedulingGoal);

FlexTemplateRuntimeEnvironment flexrsGoal.

ipConfiguration

public ipConfiguration: (google.dataflow.v1beta3.WorkerIPAddressConfiguration|keyof typeof google.dataflow.v1beta3.WorkerIPAddressConfiguration);

FlexTemplateRuntimeEnvironment ipConfiguration.

kmsKeyName

public kmsKeyName: string;

FlexTemplateRuntimeEnvironment kmsKeyName.

launcherMachineType

public launcherMachineType: string;

FlexTemplateRuntimeEnvironment launcherMachineType.

machineType

public machineType: string;

FlexTemplateRuntimeEnvironment machineType.

maxWorkers

public maxWorkers: number;

FlexTemplateRuntimeEnvironment maxWorkers.

network

public network: string;

FlexTemplateRuntimeEnvironment network.

numWorkers

public numWorkers: number;

FlexTemplateRuntimeEnvironment numWorkers.

saveHeapDumpsToGcsPath

public saveHeapDumpsToGcsPath: string;

FlexTemplateRuntimeEnvironment saveHeapDumpsToGcsPath.

sdkContainerImage

public sdkContainerImage: string;

FlexTemplateRuntimeEnvironment sdkContainerImage.

serviceAccountEmail

public serviceAccountEmail: string;

FlexTemplateRuntimeEnvironment serviceAccountEmail.

stagingLocation

public stagingLocation: string;

FlexTemplateRuntimeEnvironment stagingLocation.

subnetwork

public subnetwork: string;

FlexTemplateRuntimeEnvironment subnetwork.

tempLocation

public tempLocation: string;

FlexTemplateRuntimeEnvironment tempLocation.

workerRegion

public workerRegion: string;

FlexTemplateRuntimeEnvironment workerRegion.

workerZone

public workerZone: string;

FlexTemplateRuntimeEnvironment workerZone.

zone

public zone: string;

FlexTemplateRuntimeEnvironment zone.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IFlexTemplateRuntimeEnvironment): google.dataflow.v1beta3.FlexTemplateRuntimeEnvironment;

Creates a new FlexTemplateRuntimeEnvironment instance using the specified properties.

Parameter
NameDescription
properties IFlexTemplateRuntimeEnvironment

Properties to set

Returns
TypeDescription
FlexTemplateRuntimeEnvironment

FlexTemplateRuntimeEnvironment instance

decode(reader, length)

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

Decodes a FlexTemplateRuntimeEnvironment 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
FlexTemplateRuntimeEnvironment

FlexTemplateRuntimeEnvironment

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
FlexTemplateRuntimeEnvironment

FlexTemplateRuntimeEnvironment

encode(message, writer)

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

Encodes the specified FlexTemplateRuntimeEnvironment message. Does not implicitly messages.

Parameters
NameDescription
message IFlexTemplateRuntimeEnvironment

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

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

Parameters
NameDescription
message IFlexTemplateRuntimeEnvironment

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

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

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

Plain object

Returns
TypeDescription
FlexTemplateRuntimeEnvironment

FlexTemplateRuntimeEnvironment

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FlexTemplateRuntimeEnvironment

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message FlexTemplateRuntimeEnvironment

FlexTemplateRuntimeEnvironment

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 FlexTemplateRuntimeEnvironment 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