com.google.api.services.dataflow.model

Class Environment

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dataflow.model.Environment

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Environment
extends com.google.api.client.json.GenericJson

Describes the environment in which a Dataflow Job runs.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Dataflow API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Environment()

Method Summary

Modifier and Type	Method and Description
Environment	clone()
java.lang.String	getClusterManagerApiService() The type of cluster manager API to use.
java.lang.String	getDataset() The dataset for the current project where various workflow related tables are stored.
java.util.List<java.lang.String>	getExperiments() The list of experiments to enable.
java.lang.String	getFlexResourceSchedulingGoal() Which Flexible Resource Scheduling mode to run in.
java.util.Map<java.lang.String,java.lang.Object>	getInternalExperiments() Experimental settings.
java.util.Map<java.lang.String,java.lang.Object>	getSdkPipelineOptions() The Cloud Dataflow SDK pipeline options specified by the user.
java.lang.String	getServiceAccountEmail() Identity to run virtual machines as.
java.lang.String	getTempStoragePrefix() The prefix of the resources the system should use for temporary storage.
java.util.Map<java.lang.String,java.lang.Object>	getUserAgent() A description of the process that generated the request.
java.util.Map<java.lang.String,java.lang.Object>	getVersion() A structure describing which components and their versions of the service are required in order to run the job.
java.util.List<WorkerPool>	getWorkerPools() The worker pools.
Environment	set(java.lang.String fieldName, java.lang.Object value)
Environment	setClusterManagerApiService(java.lang.String clusterManagerApiService) The type of cluster manager API to use.
Environment	setDataset(java.lang.String dataset) The dataset for the current project where various workflow related tables are stored.
Environment	setExperiments(java.util.List<java.lang.String> experiments) The list of experiments to enable.
Environment	setFlexResourceSchedulingGoal(java.lang.String flexResourceSchedulingGoal) Which Flexible Resource Scheduling mode to run in.
Environment	setInternalExperiments(java.util.Map<java.lang.String,java.lang.Object> internalExperiments) Experimental settings.
Environment	setSdkPipelineOptions(java.util.Map<java.lang.String,java.lang.Object> sdkPipelineOptions) The Cloud Dataflow SDK pipeline options specified by the user.
Environment	setServiceAccountEmail(java.lang.String serviceAccountEmail) Identity to run virtual machines as.
Environment	setTempStoragePrefix(java.lang.String tempStoragePrefix) The prefix of the resources the system should use for temporary storage.
Environment	setUserAgent(java.util.Map<java.lang.String,java.lang.Object> userAgent) A description of the process that generated the request.
Environment	setVersion(java.util.Map<java.lang.String,java.lang.Object> version) A structure describing which components and their versions of the service are required in order to run the job.
Environment	setWorkerPools(java.util.List<WorkerPool> workerPools) The worker pools.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Environment

public Environment()

Method Detail

getClusterManagerApiService

public java.lang.String getClusterManagerApiService()

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".

Returns:

value or null for none

setClusterManagerApiService

public Environment setClusterManagerApiService(java.lang.String 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".

Parameters:

clusterManagerApiService - clusterManagerApiService or null for none

getDataset

public java.lang.String getDataset()

The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}

Returns:

value or null for none

setDataset

public Environment setDataset(java.lang.String 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}

Parameters:

dataset - dataset or null for none

getExperiments

public java.util.List<java.lang.String> getExperiments()

The list of experiments to enable.

Returns:

value or null for none

setExperiments

public Environment setExperiments(java.util.List<java.lang.String> experiments)

The list of experiments to enable.

Parameters:

experiments - experiments or null for none

getFlexResourceSchedulingGoal

public java.lang.String getFlexResourceSchedulingGoal()

Which Flexible Resource Scheduling mode to run in.

Returns:

value or null for none

setFlexResourceSchedulingGoal

public Environment setFlexResourceSchedulingGoal(java.lang.String flexResourceSchedulingGoal)

Which Flexible Resource Scheduling mode to run in.

Parameters:

flexResourceSchedulingGoal - flexResourceSchedulingGoal or null for none

getInternalExperiments

public java.util.Map<java.lang.String,java.lang.Object> getInternalExperiments()

Experimental settings.

Returns:

value or null for none

setInternalExperiments

public Environment setInternalExperiments(java.util.Map<java.lang.String,java.lang.Object> internalExperiments)

Experimental settings.

Parameters:

internalExperiments - internalExperiments or null for none

getSdkPipelineOptions

public java.util.Map<java.lang.String,java.lang.Object> getSdkPipelineOptions()

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.

Returns:

value or null for none

setSdkPipelineOptions

public Environment setSdkPipelineOptions(java.util.Map<java.lang.String,java.lang.Object> 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.

Parameters:

sdkPipelineOptions - sdkPipelineOptions or null for none

getServiceAccountEmail

public java.lang.String getServiceAccountEmail()

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

Returns:

value or null for none

setServiceAccountEmail

public Environment setServiceAccountEmail(java.lang.String serviceAccountEmail)

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

Parameters:

serviceAccountEmail - serviceAccountEmail or null for none

getTempStoragePrefix

public java.lang.String getTempStoragePrefix()

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}

Returns:

value or null for none

setTempStoragePrefix

public Environment setTempStoragePrefix(java.lang.String 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}

Parameters:

tempStoragePrefix - tempStoragePrefix or null for none

getUserAgent

public java.util.Map<java.lang.String,java.lang.Object> getUserAgent()

A description of the process that generated the request.

Returns:

value or null for none

setUserAgent

public Environment setUserAgent(java.util.Map<java.lang.String,java.lang.Object> userAgent)

A description of the process that generated the request.

Parameters:

userAgent - userAgent or null for none

getVersion

public java.util.Map<java.lang.String,java.lang.Object> getVersion()

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

Returns:

value or null for none

setVersion

public Environment setVersion(java.util.Map<java.lang.String,java.lang.Object> version)

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

Parameters:

version - version or null for none

getWorkerPools

public java.util.List<WorkerPool> getWorkerPools()

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

Returns:

value or null for none

setWorkerPools

public Environment setWorkerPools(java.util.List<WorkerPool> workerPools)

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

Parameters:

workerPools - workerPools or null for none

set

public Environment set(java.lang.String fieldName,
                       java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Environment clone()

Overrides:

clone in class com.google.api.client.json.GenericJson