Environment class

Describes the environment in which a Dataflow Job runs.

Inheritance

• Object
• GeneratedMessage
• Environment

Constructors

Environment({String? tempStoragePrefix, String? clusterManagerApiService, Iterable<String>? experiments, Iterable<WorkerPool>? workerPools, Struct? userAgent, Struct? version, String? dataset, Struct? sdkPipelineOptions, String? serviceAccountEmail, FlexResourceSchedulingGoal? flexResourceSchedulingGoal, String? serviceKmsKeyName, String? workerRegion, String? workerZone, ShuffleMode? shuffleMode, Iterable<String>? serviceOptions, DebugOptions? debugOptions})

factory

Environment.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Environment.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

clusterManagerApiService ↔ String

The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".

getter/setter pair

dataset ↔ String

The dataset for the current project where various workflow related tables are stored.

getter/setter pair

debugOptions ↔ DebugOptions

Any debugging options to be supplied to the job.

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

experiments → List<String>

The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options.

no setter

flexResourceSchedulingGoal ↔ FlexResourceSchedulingGoal

Which Flexible Resource Scheduling mode to run in.

getter/setter pair

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sdkPipelineOptions ↔ Struct

The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.

getter/setter pair

serviceAccountEmail ↔ String

Identity to run virtual machines as. Defaults to the default account.

getter/setter pair

serviceKmsKeyName ↔ String

If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK).

getter/setter pair

serviceOptions → List<String>

The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on).

no setter

shuffleMode ↔ ShuffleMode

Output only. The shuffle mode used for the job.

getter/setter pair

tempStoragePrefix ↔ String

The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is:

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

userAgent ↔ Struct

A description of the process that generated the request.

getter/setter pair

version ↔ Struct

A structure describing which components and their versions of the service are required in order to run the job.

getter/setter pair

workerPools → List<WorkerPool>

The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

no setter

workerRegion ↔ String

The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

getter/setter pair

workerZone ↔ String

The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.

getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

inherited

check() → void

inherited

clear() → void

Clears all data that was set in this message.

inherited

clearClusterManagerApiService() → void

clearDataset() → void

clearDebugOptions() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearFlexResourceSchedulingGoal() → void

clearSdkPipelineOptions() → void

clearServiceAccountEmail() → void

clearServiceKmsKeyName() → void

clearShuffleMode() → void

clearTempStoragePrefix() → void

clearUserAgent() → void

clearVersion() → void

clearWorkerRegion() → void

clearWorkerZone() → void

clone() → Environment

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(Environment)) → Environment

Apply updates to a copy of this message.

override

createEmptyInstance() → Environment

Creates an empty instance of the same message type as this.

override

createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>

Creates a Map representing a map field.

inherited

createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>

Creates List implementing a mutable repeated field.

inherited

ensureDebugOptions() → DebugOptions

ensureSdkPipelineOptions() → Struct

ensureUserAgent() → Struct

ensureVersion() → Struct

extensionsAreInitialized() → bool

inherited

freeze() → GeneratedMessage

Make this message read-only.

inherited

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

inherited

getExtension(Extension extension) → dynamic

Returns the value of extension.

inherited

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

inherited

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

inherited

getTagNumber(String fieldName) → int?

inherited

hasClusterManagerApiService() → bool

hasDataset() → bool

hasDebugOptions() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasFlexResourceSchedulingGoal() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasSdkPipelineOptions() → bool

hasServiceAccountEmail() → bool

hasServiceKmsKeyName() → bool

hasShuffleMode() → bool

hasTempStoragePrefix() → bool

hasUserAgent() → bool

hasVersion() → bool

hasWorkerRegion() → bool

hasWorkerZone() → bool

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

inherited

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

inherited

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

inherited

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

inherited

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

inherited

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

inherited

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

inherited

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

inherited

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

inherited

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

inherited

toDebugString() → String

Returns a String representation of this message.

inherited

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

inherited

toString() → String

Returns a String representation of this message.

inherited

writeToBuffer() → Uint8List

inherited

writeToCodedBufferWriter(CodedBufferWriter output) → void

inherited

writeToJson() → String

Returns a JSON string that encodes this message.

inherited

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create() → Environment

createRepeated() → PbList<Environment>

getDefault() → Environment