Package com.pulumi.gcp.dataflow

Class JobArgs

  • public final class JobArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  JobArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static JobArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> additionalExperiments()  
      static JobArgs.Builder builder()  
      static JobArgs.Builder builder​(JobArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableStreamingEngine()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipConfiguration()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyName()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>>> labels()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> machineType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxWorkers()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> network()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> onDelete()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>>> parameters()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> project()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> serviceAccountEmail()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipWaitOnJobTermination()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> subnetwork()  
      com.pulumi.core.Output<java.lang.String> tempGcsLocation()  
      com.pulumi.core.Output<java.lang.String> templateGcsPath()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>>> transformNameMapping()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> zone()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • Empty

        public static final JobArgs Empty

    • Method Detail

      • additionalExperiments

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> additionalExperiments()
        Returns:
        List of experiments that should be used by the job. An example value is `["enable_stackdriver_agent_metrics"]`.

      • enableStreamingEngine

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableStreamingEngine()
        Returns:
        Enable/disable the use of [Streaming Engine](https://cloud.google.com/dataflow/docs/guides/deploying-a-pipeline#streaming-engine) for the job. Note that Streaming Engine is enabled by default for pipelines developed against the Beam SDK for Python v2.21.0 or later when using Python 3.

      • ipConfiguration

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipConfiguration()
        Returns:
        The configuration for VM IPs. Options are `"WORKER_IP_PUBLIC"` or `"WORKER_IP_PRIVATE"`.

      • kmsKeyName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyName()
        Returns:
        The name for the Cloud KMS key for the job. Key format is: `projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY`

      • labels

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>>> labels()
        Returns:
        User labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effective_labels` for all of the labels present on the resource.

      • machineType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> machineType()
        Returns:
        The machine type to use for the job.

      • maxWorkers

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxWorkers()
        Returns:
        The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        A unique name for the resource, required by Dataflow.

      • network

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> network()
        Returns:
        The network to which VMs will be assigned. If it is not provided, "default" will be used.

      • onDelete

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> onDelete()
        Returns:
        One of "drain" or "cancel". Specifies behavior of deletion during `pulumi destroy`. See above note.

      • parameters

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>>> parameters()
        Returns:
        Key/Value pairs to be passed to the Dataflow job (as used in the template).

      • project

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> project()
        Returns:
        The project in which the resource belongs. If it is not provided, the provider project is used.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        The region in which the created job should run.

      • serviceAccountEmail

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> serviceAccountEmail()
        Returns:
        The Service Account email used to create the job.

      • skipWaitOnJobTermination

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipWaitOnJobTermination()
        Returns:
        If set to `true`, Pulumi will treat `DRAINING` and `CANCELLING` as terminal states when deleting the resource, and will remove the resource from Pulumi state and move on. See above note.

      • subnetwork

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> subnetwork()
        Returns:
        The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK". If the [subnetwork is located in a Shared VPC network](https://cloud.google.com/dataflow/docs/guides/specifying-networks#shared), you must use the complete URL. For example `"googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME"`

      • tempGcsLocation

        public com.pulumi.core.Output<java.lang.String> tempGcsLocation()
        Returns:
        A writeable location on GCS for the Dataflow job to dump its temporary data. ***

      • templateGcsPath

        public com.pulumi.core.Output<java.lang.String> templateGcsPath()
        Returns:
        The GCS path to the Dataflow job template.

      • transformNameMapping

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.Object>>> transformNameMapping()
        Returns:
        Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job. This field is not used outside of update.

      • zone

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> zone()
        Returns:
        The zone in which the created job should run. If it is not provided, the provider zone is used.