Class protos.google.dataflow.v1beta3.RuntimeEnvironment

Represents a RuntimeEnvironment.

Package

@google-cloud/dataflow!

Constructors

(constructor)(properties)

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

Constructs a new RuntimeEnvironment.

Parameter
Type Name Description
IRuntimeEnvironment properties

Properties to set

Properties

additionalExperiments

public additionalExperiments: string[];

RuntimeEnvironment additionalExperiments.

Property Value
Type Description
string[]

additionalUserLabels

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

RuntimeEnvironment additionalUserLabels.

Property Value
Type Description
{ [k: string]: string }

bypassTempDirValidation

public bypassTempDirValidation: boolean;

RuntimeEnvironment bypassTempDirValidation.

Property Value
Type Description
boolean

enableStreamingEngine

public enableStreamingEngine: boolean;

RuntimeEnvironment enableStreamingEngine.

Property Value
Type Description
boolean

ipConfiguration

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

RuntimeEnvironment ipConfiguration.

Property Value
Type Description
(google.dataflow.v1beta3.WorkerIPAddressConfiguration|keyof typeof google.dataflow.v1beta3.WorkerIPAddressConfiguration)

kmsKeyName

public kmsKeyName: string;

RuntimeEnvironment kmsKeyName.

Property Value
Type Description
string

machineType

public machineType: string;

RuntimeEnvironment machineType.

Property Value
Type Description
string

maxWorkers

public maxWorkers: number;

RuntimeEnvironment maxWorkers.

Property Value
Type Description
number

network

public network: string;

RuntimeEnvironment network.

Property Value
Type Description
string

numWorkers

public numWorkers: number;

RuntimeEnvironment numWorkers.

Property Value
Type Description
number

serviceAccountEmail

public serviceAccountEmail: string;

RuntimeEnvironment serviceAccountEmail.

Property Value
Type Description
string

subnetwork

public subnetwork: string;

RuntimeEnvironment subnetwork.

Property Value
Type Description
string

tempLocation

public tempLocation: string;

RuntimeEnvironment tempLocation.

Property Value
Type Description
string

workerRegion

public workerRegion: string;

RuntimeEnvironment workerRegion.

Property Value
Type Description
string

workerZone

public workerZone: string;

RuntimeEnvironment workerZone.

Property Value
Type Description
string

zone

public zone: string;

RuntimeEnvironment zone.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IRuntimeEnvironment): google.dataflow.v1beta3.RuntimeEnvironment;

Creates a new RuntimeEnvironment instance using the specified properties.

Parameter
Type Name Description
IRuntimeEnvironment properties

Properties to set
Returns
Type Description
google.dataflow.v1beta3.RuntimeEnvironment

RuntimeEnvironment instance

decode(reader, length)

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

Decodes a RuntimeEnvironment message from the specified reader or buffer.

Parameters
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
number length

Message length if known beforehand
Returns
Type Description
google.dataflow.v1beta3.RuntimeEnvironment

RuntimeEnvironment

decodeDelimited(reader)

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

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

Parameter
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
Returns
Type Description
google.dataflow.v1beta3.RuntimeEnvironment

RuntimeEnvironment

encode(message, writer)

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

Encodes the specified RuntimeEnvironment message. Does not implicitly messages.

Parameters
Type Name Description
IRuntimeEnvironment message

RuntimeEnvironment message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Type Name Description
IRuntimeEnvironment message

RuntimeEnvironment message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
Type Name Description
{ [k: string]: any } object

Plain object
Returns
Type Description
google.dataflow.v1beta3.RuntimeEnvironment

RuntimeEnvironment

toJSON()

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

Converts this RuntimeEnvironment to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.dataflow.v1beta3.RuntimeEnvironment message

RuntimeEnvironment
$protobuf.IConversionOptions options

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a RuntimeEnvironment message.

Parameter
Type Name Description
{ [k: string]: any } message

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not