Class Environment (0.50.0)

public final class Environment extends GeneratedMessageV3 implements EnvironmentOrBuilder

Describes the environment in which a Dataflow Job runs.

Protobuf type google.dataflow.v1beta3.Environment

Static Fields

CLUSTER_MANAGER_API_SERVICE_FIELD_NUMBER

public static final int CLUSTER_MANAGER_API_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER
Field Value
Type Description
int

DEBUG_OPTIONS_FIELD_NUMBER

public static final int DEBUG_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

EXPERIMENTS_FIELD_NUMBER

public static final int EXPERIMENTS_FIELD_NUMBER
Field Value
Type Description
int

FLEX_RESOURCE_SCHEDULING_GOAL_FIELD_NUMBER

public static final int FLEX_RESOURCE_SCHEDULING_GOAL_FIELD_NUMBER
Field Value
Type Description
int

INTERNAL_EXPERIMENTS_FIELD_NUMBER

public static final int INTERNAL_EXPERIMENTS_FIELD_NUMBER
Field Value
Type Description
int

SDK_PIPELINE_OPTIONS_FIELD_NUMBER

public static final int SDK_PIPELINE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_KMS_KEY_NAME_FIELD_NUMBER

public static final int SERVICE_KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_OPTIONS_FIELD_NUMBER

public static final int SERVICE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

SHUFFLE_MODE_FIELD_NUMBER

public static final int SHUFFLE_MODE_FIELD_NUMBER
Field Value
Type Description
int

TEMP_STORAGE_PREFIX_FIELD_NUMBER

public static final int TEMP_STORAGE_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

USER_AGENT_FIELD_NUMBER

public static final int USER_AGENT_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

WORKER_POOLS_FIELD_NUMBER

public static final int WORKER_POOLS_FIELD_NUMBER
Field Value
Type Description
int

WORKER_REGION_FIELD_NUMBER

public static final int WORKER_REGION_FIELD_NUMBER
Field Value
Type Description
int

WORKER_ZONE_FIELD_NUMBER

public static final int WORKER_ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Environment getDefaultInstance()
Returns
Type Description
Environment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Environment.Builder newBuilder()
Returns
Type Description
Environment.Builder

newBuilder(Environment prototype)

public static Environment.Builder newBuilder(Environment prototype)
Parameter
Name Description
prototype Environment
Returns
Type Description
Environment.Builder

parseDelimitedFrom(InputStream input)

public static Environment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Environment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Environment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Environment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Environment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Environment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Environment> parser()
Returns
Type Description
Parser<Environment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClusterManagerApiService()

public 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 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 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 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 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 DebugOptionsOrBuilder getDebugOptionsOrBuilder()

Any debugging options to be supplied to the job.

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

Returns
Type Description
DebugOptionsOrBuilder

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()
Returns
Type Description
Environment

getExperiments(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the experiments.

getFlexResourceSchedulingGoal()

public 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 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 Any getInternalExperiments()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type Description
Any

The internalExperiments.

getInternalExperimentsOrBuilder()

public AnyOrBuilder getInternalExperimentsOrBuilder()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type Description
AnyOrBuilder

getParserForType()

public Parser<Environment> getParserForType()
Returns
Type Description
Parser<Environment>
Overrides

getSdkPipelineOptions()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccountEmail()

public 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the serviceOptions.

getShuffleMode()

public 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 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 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 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 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 StructOrBuilder getUserAgentOrBuilder()

A description of the process that generated the request.

.google.protobuf.Struct user_agent = 5;

Returns
Type Description
StructOrBuilder

getVersion()

public 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 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 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 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 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 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 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 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 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 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 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 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 boolean hasInternalExperiments()

Experimental settings.

.google.protobuf.Any internal_experiments = 9;

Returns
Type Description
boolean

Whether the internalExperiments field is set.

hasSdkPipelineOptions()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Environment.Builder newBuilderForType()
Returns
Type Description
Environment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Environment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Environment.Builder toBuilder()
Returns
Type Description
Environment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException