Package com.google.dataflow.v1beta3

Interface EnvironmentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Environment, Environment.Builder
    public interface EnvironmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getTempStoragePrefix

        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:
        The tempStoragePrefix.

      • getTempStoragePrefixBytes

        com.google.protobuf.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:
        The bytes for tempStoragePrefix.

      • getClusterManagerApiService

        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:
        The clusterManagerApiService.

      • getClusterManagerApiServiceBytes

        com.google.protobuf.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:
        The bytes for clusterManagerApiService.

      • getExperimentsList

        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:
        A list containing the experiments.

      • getExperimentsCount

        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:
        The count of experiments.

      • getExperiments

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The experiments at the given index.

      • getExperimentsBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experiments at the given index.

      • getServiceOptionsList

        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:
        A list containing the serviceOptions.

      • getServiceOptionsCount

        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:
        The count of serviceOptions.

      • getServiceOptions

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The serviceOptions at the given index.

      • getServiceOptionsBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the serviceOptions at the given index.

      • getServiceKmsKeyName

        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:
        The serviceKmsKeyName.

      • getServiceKmsKeyNameBytes

        com.google.protobuf.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:
        The bytes for serviceKmsKeyName.

      • getWorkerPoolsList

        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;

      • getWorkerPools

        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;

      • getWorkerPoolsCount

        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;

      • getWorkerPoolsOrBuilderList

        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;

      • getWorkerPoolsOrBuilder

        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;

      • hasUserAgent

        boolean hasUserAgent()
         A description of the process that generated the request.
        .google.protobuf.Struct user_agent = 5;
        Returns:
        Whether the userAgent field is set.

      • getUserAgent

        com.google.protobuf.Struct getUserAgent()
         A description of the process that generated the request.
        .google.protobuf.Struct user_agent = 5;
        Returns:
        The userAgent.

      • getUserAgentOrBuilder

        com.google.protobuf.StructOrBuilder getUserAgentOrBuilder()
         A description of the process that generated the request.
        .google.protobuf.Struct user_agent = 5;

      • hasVersion

        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:
        Whether the version field is set.

      • getVersion

        com.google.protobuf.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:
        The version.

      • getVersionOrBuilder

        com.google.protobuf.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;

      • getDataset

        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:
        The dataset.

      • getDatasetBytes

        com.google.protobuf.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:
        The bytes for dataset.

      • hasSdkPipelineOptions

        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:
        Whether the sdkPipelineOptions field is set.

      • getSdkPipelineOptions

        com.google.protobuf.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:
        The sdkPipelineOptions.

      • getSdkPipelineOptionsOrBuilder

        com.google.protobuf.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;

      • hasInternalExperiments

        boolean hasInternalExperiments()
         Experimental settings.
        .google.protobuf.Any internal_experiments = 9;
        Returns:
        Whether the internalExperiments field is set.

      • getInternalExperiments

        com.google.protobuf.Any getInternalExperiments()
         Experimental settings.
        .google.protobuf.Any internal_experiments = 9;
        Returns:
        The internalExperiments.

      • getInternalExperimentsOrBuilder

        com.google.protobuf.AnyOrBuilder getInternalExperimentsOrBuilder()
         Experimental settings.
        .google.protobuf.Any internal_experiments = 9;

      • getServiceAccountEmail

        String getServiceAccountEmail()
         Identity to run virtual machines as. Defaults to the default account.
        string service_account_email = 10;
        Returns:
        The serviceAccountEmail.

      • getServiceAccountEmailBytes

        com.google.protobuf.ByteString getServiceAccountEmailBytes()
         Identity to run virtual machines as. Defaults to the default account.
        string service_account_email = 10;
        Returns:
        The bytes for serviceAccountEmail.

      • getFlexResourceSchedulingGoalValue

        int getFlexResourceSchedulingGoalValue()
         Which Flexible Resource Scheduling mode to run in.
        .google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;
        Returns:
        The enum numeric value on the wire for flexResourceSchedulingGoal.

      • getFlexResourceSchedulingGoal

        FlexResourceSchedulingGoal getFlexResourceSchedulingGoal()
         Which Flexible Resource Scheduling mode to run in.
        .google.dataflow.v1beta3.FlexResourceSchedulingGoal flex_resource_scheduling_goal = 11;
        Returns:
        The flexResourceSchedulingGoal.

      • getWorkerRegion

        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:
        The workerRegion.

      • getWorkerRegionBytes

        com.google.protobuf.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:
        The bytes for workerRegion.

      • getWorkerZone

        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:
        The workerZone.

      • getWorkerZoneBytes

        com.google.protobuf.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:
        The bytes for workerZone.

      • getShuffleModeValue

        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:
        The enum numeric value on the wire for shuffleMode.

      • getShuffleMode

        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:
        The shuffleMode.

      • hasDebugOptions

        boolean hasDebugOptions()
         Any debugging options to be supplied to the job.
        .google.dataflow.v1beta3.DebugOptions debug_options = 17;
        Returns:
        Whether the debugOptions field is set.

      • getDebugOptions

        DebugOptions getDebugOptions()
         Any debugging options to be supplied to the job.
        .google.dataflow.v1beta3.DebugOptions debug_options = 17;
        Returns:
        The debugOptions.

      • getDebugOptionsOrBuilder

        DebugOptionsOrBuilder getDebugOptionsOrBuilder()
         Any debugging options to be supplied to the job.
        .google.dataflow.v1beta3.DebugOptions debug_options = 17;