Package com.pulumi.gcp.dataplex

Class Task

  • public class Task
extends com.pulumi.resources.CustomResource
    A Dataplex task represents the work that you want Dataplex to do on a schedule. It encapsulates code, parameters, and the schedule. To get more information about Task, see: * [API documentation](https://cloud.google.com/dataplex/docs/reference/rest/v1/projects.locations.lakes.tasks) * How-to Guides * [Official Documentation](https://cloud.google.com/dataplex/docs) ## Example Usage ## Import Task can be imported using any of these accepted formats ```sh $ pulumi import gcp:dataplex/task:Task default projects/{{project}}/locations/{{location}}/lakes/{{lake}}/tasks/{{task_id}} ``` ```sh $ pulumi import gcp:dataplex/task:Task default {{project}}/{{location}}/{{lake}}/{{task_id}} ``` ```sh $ pulumi import gcp:dataplex/task:Task default {{location}}/{{lake}}/{{task_id}} ```

    • Nested Class Summary

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

        com.pulumi.resources.CustomResource.CustomResourceInternal

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

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Task​(java.lang.String name)  
      Task​(java.lang.String name, TaskArgs args)  
      Task​(java.lang.String name, TaskArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> createTime()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> displayName()  
      com.pulumi.core.Output<TaskExecutionSpec> executionSpec()  
      com.pulumi.core.Output<java.util.List<TaskExecutionStatus>> executionStatuses()  
      static Task get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TaskState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> labels()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> lake()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> location()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<TaskNotebook>> notebook()  
      com.pulumi.core.Output<java.lang.String> project()  
      com.pulumi.core.Output<java.util.Optional<TaskSpark>> spark()  
      com.pulumi.core.Output<java.lang.String> state()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> taskId()  
      com.pulumi.core.Output<TaskTriggerSpec> triggerSpec()  
      com.pulumi.core.Output<java.lang.String> uid()  
      com.pulumi.core.Output<java.lang.String> updateTime()  

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

        getId, idFuture

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

        getChildResources, getResourceName, getResourceType, getUrn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Task

        public Task​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Task

        public Task​(java.lang.String name,
            TaskArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Task

        public Task​(java.lang.String name,
            TaskArgs args,
            @Nullable
            com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • createTime

        public com.pulumi.core.Output<java.lang.String> createTime()
        Returns:
        The time when the task was created.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        User-provided description of the task.

      • displayName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> displayName()
        Returns:
        User friendly display name.

      • executionSpec

        public com.pulumi.core.Output<TaskExecutionSpec> executionSpec()
        Returns:
        Configuration for the cluster Structure is documented below.

      • executionStatuses

        public com.pulumi.core.Output<java.util.List<TaskExecutionStatus>> executionStatuses()
        Returns:
        Configuration for the cluster Structure is documented below.

      • labels

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> labels()
        Returns:
        User-defined labels for the task.

      • lake

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> lake()
        Returns:
        The lake in which the task will be created in.

      • location

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> location()
        Returns:
        The location in which the task will be created in.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        (Output) The relative resource name of the job, of the form: projects/{project_number}/locations/{locationId}/lakes/{lakeId}/tasks/{taskId}/jobs/{jobId}.

      • notebook

        public com.pulumi.core.Output<java.util.Optional<TaskNotebook>> notebook()
        Returns:
        A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below. (Required) Path to input notebook. This can be the Cloud Storage URI of the notebook file or the path to a Notebook Content. The execution args are accessible as environment variables (TASK_key=value).

      • project

        public com.pulumi.core.Output<java.lang.String> project()
        Returns:
        The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project. If it is not provided, the provider project is used.

      • spark

        public com.pulumi.core.Output<java.util.Optional<TaskSpark>> spark()
        Returns:
        A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        (Output) Execution state for the job.

      • taskId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> taskId()
        Returns:
        The task Id of the task.

      • triggerSpec

        public com.pulumi.core.Output<TaskTriggerSpec> triggerSpec()
        Returns:
        Configuration for the cluster Structure is documented below.

      • uid

        public com.pulumi.core.Output<java.lang.String> uid()
        Returns:
        (Output) System generated globally unique ID for the job.

      • updateTime

        public com.pulumi.core.Output<java.lang.String> updateTime()
        Returns:
        (Output) Last update time of the status.

      • get

        public static Task get​(java.lang.String name,
                       com.pulumi.core.Output<java.lang.String> id,
                       @Nullable
                       TaskState state,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.