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

Class DataplexTaskTriggerSpec.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • type

        @Stability(Stable)
public DataplexTaskTriggerSpec.Builder type​(String type)
        Sets the value of DataplexTaskTriggerSpec.getType()
        Parameters:
        type - Trigger type of the user-specified Task Possible values: ["ON_DEMAND", "RECURRING"]. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#type DataplexTask#type}
        Returns:
        this

      • disabled

        @Stability(Stable)
public DataplexTaskTriggerSpec.Builder disabled​(Boolean disabled)
        Sets the value of DataplexTaskTriggerSpec.getDisabled()
        Parameters:
        disabled - 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}
        Returns:
        this

      • disabled

        @Stability(Stable)
public DataplexTaskTriggerSpec.Builder disabled​(com.hashicorp.cdktf.IResolvable disabled)
        Sets the value of DataplexTaskTriggerSpec.getDisabled()
        Parameters:
        disabled - 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}
        Returns:
        this

      • maxRetries

        @Stability(Stable)
public DataplexTaskTriggerSpec.Builder maxRetries​(Number maxRetries)
        Sets the value of DataplexTaskTriggerSpec.getMaxRetries()
        Parameters:
        maxRetries - 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}
        Returns:
        this

      • schedule

        @Stability(Stable)
public DataplexTaskTriggerSpec.Builder schedule​(String schedule)
        Sets the value of DataplexTaskTriggerSpec.getSchedule()
        Parameters:
        schedule - 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}
        Returns:
        this

      • startTime

        @Stability(Stable)
public DataplexTaskTriggerSpec.Builder startTime​(String startTime)
        Sets the value of DataplexTaskTriggerSpec.getStartTime()
        Parameters:
        startTime - 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}
        Returns:
        this