Environment

google.dataflow.v1beta3. Environment

Represents an Environment.

Constructor

new Environment(propertiesopt)

Constructs a new Environment.

Parameters:
Name Type Attributes Description
properties google.dataflow.v1beta3.IEnvironment <optional>

Properties to set

Implements:
  • IEnvironment

Members

clusterManagerApiService

Environment clusterManagerApiService.

dataset

Environment dataset.

debugOptions

Environment debugOptions.

experiments

Environment experiments.

flexResourceSchedulingGoal

Environment flexResourceSchedulingGoal.

internalExperiments

Environment internalExperiments.

sdkPipelineOptions

Environment sdkPipelineOptions.

serviceAccountEmail

Environment serviceAccountEmail.

serviceKmsKeyName

Environment serviceKmsKeyName.

serviceOptions

Environment serviceOptions.

shuffleMode

Environment shuffleMode.

tempStoragePrefix

Environment tempStoragePrefix.

userAgent

Environment userAgent.

version

Environment version.

workerPools

Environment workerPools.

workerRegion

Environment workerRegion.

workerZone

Environment workerZone.

Methods

toJSON() → {Object.<string, *>}

Converts this Environment to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.dataflow.v1beta3.Environment}

Creates a new Environment instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.dataflow.v1beta3.IEnvironment <optional>

Properties to set

Returns:
Type Description
google.dataflow.v1beta3.Environment

Environment instance

(static) decode(reader, lengthopt) → {google.dataflow.v1beta3.Environment}

Decodes an Environment message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.dataflow.v1beta3.Environment

Environment

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.dataflow.v1beta3.Environment}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.dataflow.v1beta3.Environment

Environment

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Environment message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.IEnvironment

Environment message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.IEnvironment

Environment message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.dataflow.v1beta3.Environment}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.dataflow.v1beta3.Environment

Environment

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Environment

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.Environment

Environment

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an Environment message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not