Package com.hashicorp.cdktf.providers.google.dataplex_task

Interface DataplexTaskTriggerSpec

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    DataplexTaskTriggerSpec.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:20.658Z")
@Stability(Stable)
public interface DataplexTaskTriggerSpec
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getType

        @Stability(Stable)
@NotNull
String getType()
        Trigger type of the user-specified Task Possible values: ["ON_DEMAND", "RECURRING"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#type DataplexTask#type}

      • getDisabled

        @Stability(Stable)
@Nullable
default Object getDisabled()
        Prevent the task from executing.

        This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#disabled DataplexTask#disabled}

      • getMaxRetries

        @Stability(Stable)
@Nullable
default Number getMaxRetries()
        Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#max_retries DataplexTask#max_retries}

      • getSchedule

        @Stability(Stable)
@Nullable
default String getSchedule()
        Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: 'CRON_TZ=${IANA_TIME_ZONE}' or 'TZ=${IANA_TIME_ZONE}'. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#schedule DataplexTask#schedule}

      • getStartTime

        @Stability(Stable)
@Nullable
default String getStartTime()
        The first run of the task will be after this time.

        If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#start_time DataplexTask#start_time}