EnvironmentResponse class

Describes the environment in which a Dataflow Job runs.

Constructors

EnvironmentResponse({required Input<String> clusterManagerApiService, required Input<String> dataset, required Input<DebugOptionsResponse> debugOptions, required Input<List<String>> experiments, required Input<String> flexResourceSchedulingGoal, required Input<Map<String, String>> internalExperiments, required Input<Map<String, String>> sdkPipelineOptions, required Input<String> serviceAccountEmail, required Input<String> serviceKmsKeyName, required Input<List<String>> serviceOptions, required Input<String> shuffleMode, required Input<String> tempStoragePrefix, required Input<bool> useStreamingEngineResourceBasedBilling, required Input<Map<String, String>> userAgent, required Input<Map<String, String>> version, required Input<List<WorkerPoolResponse>> workerPools, required Input<String> workerRegion, required Input<String> workerZone})
Creates a new EnvironmentResponse. clusterManagerApiService 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". dataset The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset} debugOptions Any debugging options to be supplied to the job. experiments 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. flexResourceSchedulingGoal Which Flexible Resource Scheduling mode to run in. internalExperiments Experimental settings. sdkPipelineOptions 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. serviceAccountEmail Identity to run virtual machines as. Defaults to the default account. serviceKmsKeyName If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY serviceOptions 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). shuffleMode The shuffle mode used for the job. tempStoragePrefix 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: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} useStreamingEngineResourceBasedBilling Whether the job uses the new streaming engine billing model based on resource usage. userAgent A description of the process that generated the request. version A structure describing which components and their versions of the service are required in order to run the job. workerPools The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. workerRegion 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. workerZone 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.
const
EnvironmentResponse.fromMap(Map<String, dynamic> map)
factory

Properties

clusterManagerApiService → Input<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".
final
dataset → Input<String>
The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
final
debugOptions → Input<DebugOptionsResponse>
Any debugging options to be supplied to the job.
final
experiments → Input<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.
final
flexResourceSchedulingGoal → Input<String>
Which Flexible Resource Scheduling mode to run in.
final
hashCode → int
The hash code for this object.
no setterinherited
internalExperiments → Input<Map<String, String>>
Experimental settings.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdkPipelineOptions → Input<Map<String, String>>
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.
final
serviceAccountEmail → Input<String>
Identity to run virtual machines as. Defaults to the default account.
final
serviceKmsKeyName → Input<String>
If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY
final
serviceOptions → Input<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).
final
shuffleMode → Input<String>
The shuffle mode used for the job.
final
tempStoragePrefix → Input<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: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
final
userAgent → Input<Map<String, String>>
A description of the process that generated the request.
final
useStreamingEngineResourceBasedBilling → Input<bool>
Whether the job uses the new streaming engine billing model based on resource usage.
final
version → Input<Map<String, String>>
A structure describing which components and their versions of the service are required in order to run the job.
final
workerPools → Input<List<WorkerPoolResponse>>
The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
final
workerRegion → Input<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.
final
workerZone → Input<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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited