add desc to schema for google_dataflow_job (#3644) (#6655)

Co-authored-by: Edward Sun <[email protected]>
Signed-off-by: Modular Magician <[email protected]>

Co-authored-by: Edward Sun <[email protected]>

Author: modular-magician

.changelog/3644.txt

@@ -0,0 +1,3 @@
+```release-note:none
+
+```

google/resource_dataflow_job.go

@@ -58,113 +58,132 @@ func resourceDataflowJob() *schema.Resource {
 				Type:     schema.TypeString,
 				Required: true,
 				// ForceNew applies to both stream and batch jobs
-				ForceNew: true,
+				ForceNew:    true,
+				Description: `A unique name for the resource, required by Dataflow.`,
 			},
 
 			"template_gcs_path": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: `The GCS path to the Dataflow job template.`,
 			},
 
 			"temp_gcs_location": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: `A writeable location on GCS for the Dataflow job to dump its temporary data.`,
 			},
 
 			"zone": {
 				Type:     schema.TypeString,
 				Optional: true,
 				// ForceNew applies to both stream and batch jobs
-				ForceNew: true,
+				ForceNew:    true,
+				Description: `The zone in which the created job should run. If it is not provided, the provider zone is used.`,
 			},
 
 			"region": {
 				Type:     schema.TypeString,
 				Optional: true,
 				// ForceNew applies to both stream and batch jobs
-				ForceNew: true,
+				ForceNew:    true,
+				Description: `The region in which the created job should run.`,
 			},
 
 			"max_workers": {
 				Type:     schema.TypeInt,
 				Optional: true,
 				// ForceNew applies to both stream and batch jobs
-				ForceNew: true,
+				ForceNew:    true,
+				Description: `The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.`,
 			},
 
 			"parameters": {
-				Type:     schema.TypeMap,
-				Optional: true,
+				Type:        schema.TypeMap,
+				Optional:    true,
+				Description: `Key/Value pairs to be passed to the Dataflow job (as used in the template).`,
 			},
 
 			"labels": {
 				Type:             schema.TypeMap,
 				Optional:         true,
 				DiffSuppressFunc: resourceDataflowJobLabelDiffSuppress,
+				Description:      `User labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. NOTE: Google-provided Dataflow templates often provide default labels that begin with goog-dataflow-provided. Unless explicitly set in config, these labels will be ignored to prevent diffs on re-apply.`,
 			},
 
 			"on_delete": {
 				Type:         schema.TypeString,
 				ValidateFunc: validation.StringInSlice([]string{"cancel", "drain"}, false),
 				Optional:     true,
 				Default:      "drain",
+				Description:  `One of "drain" or "cancel". Specifies behavior of deletion during terraform destroy.`,
 			},
 
 			"project": {
 				Type:     schema.TypeString,
 				Optional: true,
 				Computed: true,
 				// ForceNew applies to both stream and batch jobs
-				ForceNew: true,
+				ForceNew:    true,
+				Description: `The project in which the resource belongs.`,
 			},
 
 			"state": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: `The current state of the resource, selected from the JobState enum.`,
 			},
 			"type": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: `The type of this job, selected from the JobType enum.`,
 			},
 			"service_account_email": {
-				Type:     schema.TypeString,
-				Optional: true,
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: `The Service Account email used to create the job.`,
 			},
 
 			"network": {
 				Type:             schema.TypeString,
 				Optional:         true,
 				DiffSuppressFunc: compareSelfLinkOrResourceName,
+				Description:      `The network to which VMs will be assigned. If it is not provided, "default" will be used.`,
 			},
 
 			"subnetwork": {
 				Type:             schema.TypeString,
 				Optional:         true,
 				DiffSuppressFunc: compareSelfLinkOrResourceName,
+				Description:      `The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK".`,
 			},
 
 			"machine_type": {
-				Type:     schema.TypeString,
-				Optional: true,
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: `The machine type to use for the job.`,
 			},
 
 			"ip_configuration": {
 				Type:         schema.TypeString,
 				Optional:     true,
+				Description:  `The configuration for VM IPs. Options are "WORKER_IP_PUBLIC" or "WORKER_IP_PRIVATE".`,
 				ValidateFunc: validation.StringInSlice([]string{"WORKER_IP_PUBLIC", "WORKER_IP_PRIVATE", ""}, false),
 			},
 
 			"additional_experiments": {
-				Type:     schema.TypeSet,
-				Optional: true,
+				Type:        schema.TypeSet,
+				Optional:    true,
+				Description: `List of experiments that should be used by the job. An example value is ["enable_stackdriver_agent_metrics"].`,
 				Elem: &schema.Schema{
 					Type: schema.TypeString,
 				},
 			},
 
 			"job_id": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: `The unique ID of this job.`,
 			},
 		},
 	}