Package com.google.dataflow.v1beta3

Interface FlexTemplateRuntimeEnvironmentOrBuilder

    • Method Detail

      • getNumWorkers

        int getNumWorkers()
         The initial number of Google Compute Engine instances for the job.
        int32 num_workers = 1;
        Returns:
        The numWorkers.

      • getMaxWorkers

        int getMaxWorkers()
         The maximum number of Google Compute Engine instances to be made
 available to your pipeline during execution, from 1 to 1000.
        int32 max_workers = 2;
        Returns:
        The maxWorkers.

      • getZone

        String getZone()
         The Compute Engine [availability
 zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
 for launching worker instances to run your pipeline.
 In the future, worker_zone will take precedence.
        string zone = 3;
        Returns:
        The zone.

      • getZoneBytes

        com.google.protobuf.ByteString getZoneBytes()
         The Compute Engine [availability
 zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)
 for launching worker instances to run your pipeline.
 In the future, worker_zone will take precedence.
        string zone = 3;
        Returns:
        The bytes for zone.

      • getServiceAccountEmail

        String getServiceAccountEmail()
         The email address of the service account to run the job as.
        string service_account_email = 4;
        Returns:
        The serviceAccountEmail.

      • getServiceAccountEmailBytes

        com.google.protobuf.ByteString getServiceAccountEmailBytes()
         The email address of the service account to run the job as.
        string service_account_email = 4;
        Returns:
        The bytes for serviceAccountEmail.

      • getTempLocation

        String getTempLocation()
         The Cloud Storage path to use for temporary files.
 Must be a valid Cloud Storage URL, beginning with `gs://`.
        string temp_location = 5;
        Returns:
        The tempLocation.

      • getTempLocationBytes

        com.google.protobuf.ByteString getTempLocationBytes()
         The Cloud Storage path to use for temporary files.
 Must be a valid Cloud Storage URL, beginning with `gs://`.
        string temp_location = 5;
        Returns:
        The bytes for tempLocation.

      • getMachineType

        String getMachineType()
         The machine type to use for the job. Defaults to the value from the
 template if not specified.
        string machine_type = 6;
        Returns:
        The machineType.

      • getMachineTypeBytes

        com.google.protobuf.ByteString getMachineTypeBytes()
         The machine type to use for the job. Defaults to the value from the
 template if not specified.
        string machine_type = 6;
        Returns:
        The bytes for machineType.

      • getAdditionalExperimentsList

        List<String> getAdditionalExperimentsList()
         Additional experiment flags for the job.
        repeated string additional_experiments = 7;
        Returns:
        A list containing the additionalExperiments.

      • getAdditionalExperimentsCount

        int getAdditionalExperimentsCount()
         Additional experiment flags for the job.
        repeated string additional_experiments = 7;
        Returns:
        The count of additionalExperiments.

      • getAdditionalExperiments

        String getAdditionalExperiments​(int index)
         Additional experiment flags for the job.
        repeated string additional_experiments = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The additionalExperiments at the given index.

      • getAdditionalExperimentsBytes

        com.google.protobuf.ByteString getAdditionalExperimentsBytes​(int index)
         Additional experiment flags for the job.
        repeated string additional_experiments = 7;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the additionalExperiments at the given index.

      • getNetwork

        String getNetwork()
         Network to which VMs will be assigned.  If empty or unspecified,
 the service will use the network "default".
        string network = 8;
        Returns:
        The network.

      • getNetworkBytes

        com.google.protobuf.ByteString getNetworkBytes()
         Network to which VMs will be assigned.  If empty or unspecified,
 the service will use the network "default".
        string network = 8;
        Returns:
        The bytes for network.

      • getSubnetwork

        String getSubnetwork()
         Subnetwork to which VMs will be assigned, if desired. You can specify a
 subnetwork using either a complete URL or an abbreviated path. Expected to
 be of the form
 "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK"
 or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in
 a Shared VPC network, you must use the complete URL.
        string subnetwork = 9;
        Returns:
        The subnetwork.

      • getSubnetworkBytes

        com.google.protobuf.ByteString getSubnetworkBytes()
         Subnetwork to which VMs will be assigned, if desired. You can specify a
 subnetwork using either a complete URL or an abbreviated path. Expected to
 be of the form
 "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK"
 or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in
 a Shared VPC network, you must use the complete URL.
        string subnetwork = 9;
        Returns:
        The bytes for subnetwork.

      • getAdditionalUserLabelsCount

        int getAdditionalUserLabelsCount()
         Additional user labels to be specified for the job.
 Keys and values must follow the restrictions specified in the [labeling
 restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
 page.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
        map<string, string> additional_user_labels = 10;

      • containsAdditionalUserLabels

        boolean containsAdditionalUserLabels​(String key)
         Additional user labels to be specified for the job.
 Keys and values must follow the restrictions specified in the [labeling
 restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
 page.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
        map<string, string> additional_user_labels = 10;

      • getAdditionalUserLabelsMap

        Map<String,​String> getAdditionalUserLabelsMap()
         Additional user labels to be specified for the job.
 Keys and values must follow the restrictions specified in the [labeling
 restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
 page.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
        map<string, string> additional_user_labels = 10;

      • getAdditionalUserLabelsOrDefault

        String getAdditionalUserLabelsOrDefault​(String key,
                                        String defaultValue)
         Additional user labels to be specified for the job.
 Keys and values must follow the restrictions specified in the [labeling
 restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
 page.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
        map<string, string> additional_user_labels = 10;

      • getAdditionalUserLabelsOrThrow

        String getAdditionalUserLabelsOrThrow​(String key)
         Additional user labels to be specified for the job.
 Keys and values must follow the restrictions specified in the [labeling
 restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)
 page.
 An object containing a list of "key": value pairs.
 Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
        map<string, string> additional_user_labels = 10;

      • getKmsKeyName

        String getKmsKeyName()
         Name for the Cloud KMS key for the job.
 Key format is:
 projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>
        string kms_key_name = 11;
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

        com.google.protobuf.ByteString getKmsKeyNameBytes()
         Name for the Cloud KMS key for the job.
 Key format is:
 projects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>
        string kms_key_name = 11;
        Returns:
        The bytes for kmsKeyName.

      • getIpConfigurationValue

        int getIpConfigurationValue()
         Configuration for VM IPs.
        .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;
        Returns:
        The enum numeric value on the wire for ipConfiguration.

      • getIpConfiguration

        WorkerIPAddressConfiguration getIpConfiguration()
         Configuration for VM IPs.
        .google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 12;
        Returns:
        The ipConfiguration.

      • 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.
 If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
        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.
 If both `worker_zone` and `zone` are set, `worker_zone` takes precedence.
        string worker_zone = 14;
        Returns:
        The bytes for workerZone.

      • getEnableStreamingEngine

        boolean getEnableStreamingEngine()
         Whether to enable Streaming Engine for the job.
        bool enable_streaming_engine = 15;
        Returns:
        The enableStreamingEngine.

      • getFlexrsGoalValue

        int getFlexrsGoalValue()
         Set FlexRS goal for the job.
 https://cloud.google.com/dataflow/docs/guides/flexrs
        .google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;
        Returns:
        The enum numeric value on the wire for flexrsGoal.

      • getFlexrsGoal

        FlexResourceSchedulingGoal getFlexrsGoal()
         Set FlexRS goal for the job.
 https://cloud.google.com/dataflow/docs/guides/flexrs
        .google.dataflow.v1beta3.FlexResourceSchedulingGoal flexrs_goal = 16;
        Returns:
        The flexrsGoal.

      • getStagingLocation

        String getStagingLocation()
         The Cloud Storage path for staging local files.
 Must be a valid Cloud Storage URL, beginning with `gs://`.
        string staging_location = 17;
        Returns:
        The stagingLocation.

      • getStagingLocationBytes

        com.google.protobuf.ByteString getStagingLocationBytes()
         The Cloud Storage path for staging local files.
 Must be a valid Cloud Storage URL, beginning with `gs://`.
        string staging_location = 17;
        Returns:
        The bytes for stagingLocation.

      • getSdkContainerImage

        String getSdkContainerImage()
         Docker registry location of container image to use for the 'worker harness.
 Default is the container for the version of the SDK. Note this field is
 only valid for portable pipelines.
        string sdk_container_image = 18;
        Returns:
        The sdkContainerImage.

      • getSdkContainerImageBytes

        com.google.protobuf.ByteString getSdkContainerImageBytes()
         Docker registry location of container image to use for the 'worker harness.
 Default is the container for the version of the SDK. Note this field is
 only valid for portable pipelines.
        string sdk_container_image = 18;
        Returns:
        The bytes for sdkContainerImage.

      • getDiskSizeGb

        int getDiskSizeGb()
         Worker disk size, in gigabytes.
        int32 disk_size_gb = 20;
        Returns:
        The diskSizeGb.

      • getAutoscalingAlgorithmValue

        int getAutoscalingAlgorithmValue()
         The algorithm to use for autoscaling
        .google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;
        Returns:
        The enum numeric value on the wire for autoscalingAlgorithm.

      • getAutoscalingAlgorithm

        AutoscalingAlgorithm getAutoscalingAlgorithm()
         The algorithm to use for autoscaling
        .google.dataflow.v1beta3.AutoscalingAlgorithm autoscaling_algorithm = 21;
        Returns:
        The autoscalingAlgorithm.

      • getDumpHeapOnOom

        boolean getDumpHeapOnOom()
         If true, save a heap dump before killing a thread or process which is GC
 thrashing or out of memory. The location of the heap file will either be
 echoed back to the user, or the user will be given the opportunity to
 download the heap file.
        bool dump_heap_on_oom = 22;
        Returns:
        The dumpHeapOnOom.

      • getSaveHeapDumpsToGcsPath

        String getSaveHeapDumpsToGcsPath()
         Cloud Storage bucket (directory) to upload heap dumps to the given
 location. Enabling this implies that heap dumps should be generated on OOM
 (dump_heap_on_oom is set to true).
        string save_heap_dumps_to_gcs_path = 23;
        Returns:
        The saveHeapDumpsToGcsPath.

      • getSaveHeapDumpsToGcsPathBytes

        com.google.protobuf.ByteString getSaveHeapDumpsToGcsPathBytes()
         Cloud Storage bucket (directory) to upload heap dumps to the given
 location. Enabling this implies that heap dumps should be generated on OOM
 (dump_heap_on_oom is set to true).
        string save_heap_dumps_to_gcs_path = 23;
        Returns:
        The bytes for saveHeapDumpsToGcsPath.

      • getLauncherMachineType

        String getLauncherMachineType()
         The machine type to use for launching the job. The default is
 n1-standard-1.
        string launcher_machine_type = 24;
        Returns:
        The launcherMachineType.

      • getLauncherMachineTypeBytes

        com.google.protobuf.ByteString getLauncherMachineTypeBytes()
         The machine type to use for launching the job. The default is
 n1-standard-1.
        string launcher_machine_type = 24;
        Returns:
        The bytes for launcherMachineType.