Interface EnvironmentOrBuilder (0.24.0)

Version 0.24.0

• 0.59.0 (latest)
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

public interface EnvironmentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getClusterManagerApiService()

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

string cluster_manager_api_service = 2;

Returns
Type	Description
String	The clusterManagerApiService.

getClusterManagerApiServiceBytes()

public abstract ByteString getClusterManagerApiServiceBytes()

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

string cluster_manager_api_service = 2;

Returns
Type	Description
ByteString	The bytes for clusterManagerApiService.

getDataset()

public abstract 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}

string dataset = 7;

Returns
Type	Description
String	The dataset.

getDatasetBytes()

public abstract ByteString getDatasetBytes()

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

The supported resource type is:

Google BigQuery: bigquery.googleapis.com/{dataset}

string dataset = 7;

Returns
Type	Description
ByteString	The bytes for dataset.

getDebugOptions()

public abstract DebugOptions getDebugOptions()

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Returns
Type	Description
DebugOptions	The debugOptions.

getDebugOptionsOrBuilder()

public abstract DebugOptionsOrBuilder getDebugOptionsOrBuilder()

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Returns
Type	Description
DebugOptionsOrBuilder

getExperiments(int index)

public abstract String getExperiments(int index)

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.

repeated string experiments = 3;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The experiments at the given index.

getExperimentsBytes(int index)

public abstract ByteString getExperimentsBytes(int index)

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.

repeated string experiments = 3;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the experiments at the given index.

getExperimentsCount()

public abstract int getExperimentsCount()

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.

repeated string experiments = 3;

Returns
Type	Description
int	The count of experiments.

getExperimentsList()

public abstract List<String> getExperimentsList()

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.

repeated string experiments = 3;

Returns
Type	Description
List<String>	A list containing the experiments.

getFlexResourceSchedulingGoal()

public abstract FlexResourceSchedulingGoal getFlexResourceSchedulingGoal()

Which Flexible Resource Scheduling mode to run in.

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;

Returns
Type	Description
FlexResourceSchedulingGoal	The flexResourceSchedulingGoal.

getFlexResourceSchedulingGoalValue()

public abstract int getFlexResourceSchedulingGoalValue()

Which Flexible Resource Scheduling mode to run in.

.google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;

Returns
Type	Description
int	The enum numeric value on the wire for flexResourceSchedulingGoal.

getInternalExperiments()

public abstract Any getInternalExperiments()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type	Description
Any	The internalExperiments.

getInternalExperimentsOrBuilder()

public abstract AnyOrBuilder getInternalExperimentsOrBuilder()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type	Description
AnyOrBuilder

getSdkPipelineOptions()

public abstract Struct 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.

.google.protobuf.Struct sdk_pipeline_options = 8;

Returns
Type	Description
Struct	The sdkPipelineOptions.

getSdkPipelineOptionsOrBuilder()

public abstract StructOrBuilder getSdkPipelineOptionsOrBuilder()

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.

.google.protobuf.Struct sdk_pipeline_options = 8;

Returns
Type	Description
StructOrBuilder

getServiceAccountEmail()

public abstract String getServiceAccountEmail()

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

string service_account_email = 10;

Returns
Type	Description
String	The serviceAccountEmail.

getServiceAccountEmailBytes()

public abstract ByteString getServiceAccountEmailBytes()

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

string service_account_email = 10;

Returns
Type	Description
ByteString	The bytes for serviceAccountEmail.

getServiceKmsKeyName()

public abstract String getServiceKmsKeyName()

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

string service_kms_key_name = 12;

Returns
Type	Description
String	The serviceKmsKeyName.

getServiceKmsKeyNameBytes()

public abstract ByteString getServiceKmsKeyNameBytes()

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

string service_kms_key_name = 12;

Returns
Type	Description
ByteString	The bytes for serviceKmsKeyName.

getServiceOptions(int index)

public abstract String getServiceOptions(int index)

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

repeated string service_options = 16;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The serviceOptions at the given index.

getServiceOptionsBytes(int index)

public abstract ByteString getServiceOptionsBytes(int index)

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

repeated string service_options = 16;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the serviceOptions at the given index.

getServiceOptionsCount()

public abstract int getServiceOptionsCount()

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

repeated string service_options = 16;

Returns
Type	Description
int	The count of serviceOptions.

getServiceOptionsList()

public abstract List<String> getServiceOptionsList()

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

repeated string service_options = 16;

Returns
Type	Description
List<String>	A list containing the serviceOptions.

getShuffleMode()

public abstract ShuffleMode getShuffleMode()

Output only. The shuffle mode used for the job.

.google.dataflow.v1beta3.ShuffleMode shuffle_mode = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ShuffleMode	The shuffleMode.

getShuffleModeValue()

public abstract int getShuffleModeValue()

Output only. The shuffle mode used for the job.

.google.dataflow.v1beta3.ShuffleMode shuffle_mode = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for shuffleMode.

getTempStoragePrefix()

public abstract 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}

string temp_storage_prefix = 1;

Returns
Type	Description
String	The tempStoragePrefix.

getTempStoragePrefixBytes()

public abstract ByteString getTempStoragePrefixBytes()

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}

string temp_storage_prefix = 1;

Returns
Type	Description
ByteString	The bytes for tempStoragePrefix.

getUserAgent()

public abstract Struct getUserAgent()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type	Description
Struct	The userAgent.

getUserAgentOrBuilder()

public abstract StructOrBuilder getUserAgentOrBuilder()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type	Description
StructOrBuilder

getVersion()

public abstract Struct getVersion()

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

.google.protobuf.Struct version = 6;

Returns
Type	Description
Struct	The version.

getVersionOrBuilder()

public abstract StructOrBuilder getVersionOrBuilder()

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

.google.protobuf.Struct version = 6;

Returns
Type	Description
StructOrBuilder

getWorkerPools(int index)

public abstract WorkerPool getWorkerPools(int index)

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

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
WorkerPool

getWorkerPoolsCount()

public abstract int getWorkerPoolsCount()

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

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
int

getWorkerPoolsList()

public abstract List<WorkerPool> getWorkerPoolsList()

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

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
List<WorkerPool>

getWorkerPoolsOrBuilder(int index)

public abstract WorkerPoolOrBuilder getWorkerPoolsOrBuilder(int index)

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

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
WorkerPoolOrBuilder

getWorkerPoolsOrBuilderList()

public abstract List<? extends WorkerPoolOrBuilder> getWorkerPoolsOrBuilderList()

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

repeated .google.dataflow.v1beta3.WorkerPool worker_pools = 4;

Returns
Type	Description
List<? extends com.google.dataflow.v1beta3.WorkerPoolOrBuilder>

getWorkerRegion()

public abstract String getWorkerRegion()

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.

string worker_region = 13;

Returns
Type	Description
String	The workerRegion.

getWorkerRegionBytes()

public abstract ByteString getWorkerRegionBytes()

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.

string worker_region = 13;

Returns
Type	Description
ByteString	The bytes for workerRegion.

getWorkerZone()

public abstract String getWorkerZone()

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.

string worker_zone = 14;

Returns
Type	Description
String	The workerZone.

getWorkerZoneBytes()

public abstract ByteString getWorkerZoneBytes()

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.

string worker_zone = 14;

Returns
Type	Description
ByteString	The bytes for workerZone.

hasDebugOptions()

public abstract boolean hasDebugOptions()

Any debugging options to be supplied to the job.

.google.dataflow.v1beta3.DebugOptions debug_options = 17;

Returns
Type	Description
boolean	Whether the debugOptions field is set.

hasInternalExperiments()

public abstract boolean hasInternalExperiments()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type	Description
boolean	Whether the internalExperiments field is set.

hasSdkPipelineOptions()

public abstract boolean hasSdkPipelineOptions()

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.

.google.protobuf.Struct sdk_pipeline_options = 8;

Returns
Type	Description
boolean	Whether the sdkPipelineOptions field is set.

hasUserAgent()

public abstract boolean hasUserAgent()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type	Description
boolean	Whether the userAgent field is set.

hasVersion()

public abstract boolean hasVersion()

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

.google.protobuf.Struct version = 6;

Returns
Type	Description
boolean	Whether the version field is set.