class Google::Apis::DataflowV1b3::Environment

Describes the environment in which a Dataflow Job runs.

Attributes

cluster_manager_api_service[RW]

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”. Corresponds to the JSON property `clusterManagerApiService` @return [String]

dataset[RW]

The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis. com/`dataset` Corresponds to the JSON property `dataset` @return [String]

debug_options[RW]

Describes any options that have an effect on the debugging of pipelines. Corresponds to the JSON property `debugOptions` @return [Google::Apis::DataflowV1b3::DebugOptions]

experiments[RW]

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. Corresponds to the JSON property `experiments` @return [Array<String>]

flex_resource_scheduling_goal[RW]

Which Flexible Resource Scheduling mode to run in. Corresponds to the JSON property `flexResourceSchedulingGoal` @return [String]

internal_experiments[RW]

Experimental settings. Corresponds to the JSON property `internalExperiments` @return [Hash<String,Object>]

sdk_pipeline_options[RW]

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. Corresponds to the JSON property `sdkPipelineOptions` @return [Hash<String,Object>]

service_account_email[RW]

Identity to run virtual machines as. Defaults to the default account. Corresponds to the JSON property `serviceAccountEmail` @return [String]

service_kms_key_name[RW]

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 Corresponds to the JSON property `serviceKmsKeyName` @return [String]

service_options[RW]

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). Corresponds to the JSON property `serviceOptions` @return [Array<String>]

shuffle_mode[RW]

Output only. The shuffle mode used for the job. Corresponds to the JSON property `shuffleMode` @return [String]

temp_storage_prefix[RW]

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` Corresponds to the JSON property `tempStoragePrefix` @return [String]

user_agent[RW]

A description of the process that generated the request. Corresponds to the JSON property `userAgent` @return [Hash<String,Object>]

version[RW]

A structure describing which components and their versions of the service are required in order to run the job. Corresponds to the JSON property `version` @return [Hash<String,Object>]

worker_pools[RW]

The worker pools. At least one “harness” worker pool must be specified in order for the job to have workers. Corresponds to the JSON property `workerPools` @return [Array<Google::Apis::DataflowV1b3::WorkerPool>]

worker_region[RW]

The Compute Engine region (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. Corresponds to the JSON property `workerRegion` @return [String]

worker_zone[RW]

The Compute Engine zone (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. Corresponds to the JSON property `workerZone` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dataflow_v1b3/classes.rb, line 1268
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dataflow_v1b3/classes.rb, line 1273
def update!(**args)
  @cluster_manager_api_service = args[:cluster_manager_api_service] if args.key?(:cluster_manager_api_service)
  @dataset = args[:dataset] if args.key?(:dataset)
  @debug_options = args[:debug_options] if args.key?(:debug_options)
  @experiments = args[:experiments] if args.key?(:experiments)
  @flex_resource_scheduling_goal = args[:flex_resource_scheduling_goal] if args.key?(:flex_resource_scheduling_goal)
  @internal_experiments = args[:internal_experiments] if args.key?(:internal_experiments)
  @sdk_pipeline_options = args[:sdk_pipeline_options] if args.key?(:sdk_pipeline_options)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @service_kms_key_name = args[:service_kms_key_name] if args.key?(:service_kms_key_name)
  @service_options = args[:service_options] if args.key?(:service_options)
  @shuffle_mode = args[:shuffle_mode] if args.key?(:shuffle_mode)
  @temp_storage_prefix = args[:temp_storage_prefix] if args.key?(:temp_storage_prefix)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
  @version = args[:version] if args.key?(:version)
  @worker_pools = args[:worker_pools] if args.key?(:worker_pools)
  @worker_region = args[:worker_region] if args.key?(:worker_region)
  @worker_zone = args[:worker_zone] if args.key?(:worker_zone)
end