Package com.hashicorp.cdktf.providers.google.cloud_scheduler_job

Class CloudSchedulerJob.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static CloudSchedulerJob.Builder create​(software.constructs.Construct scope,
                                               String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of CloudSchedulerJob.Builder.

      • connection

        @Stability(Experimental)
public CloudSchedulerJob.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public CloudSchedulerJob.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public CloudSchedulerJob.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public CloudSchedulerJob.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public CloudSchedulerJob.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public CloudSchedulerJob.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public CloudSchedulerJob.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public CloudSchedulerJob.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public CloudSchedulerJob.Builder name​(String name)
        The name of the job.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#name CloudSchedulerJob#name}

        Parameters:
        name - The name of the job. This parameter is required.
        Returns:
        this

      • appEngineHttpTarget

        @Stability(Stable)
public CloudSchedulerJob.Builder appEngineHttpTarget​(CloudSchedulerJobAppEngineHttpTarget appEngineHttpTarget)
        app_engine_http_target block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#app_engine_http_target CloudSchedulerJob#app_engine_http_target}

        Parameters:
        appEngineHttpTarget - app_engine_http_target block. This parameter is required.
        Returns:
        this

      • attemptDeadline

        @Stability(Stable)
public CloudSchedulerJob.Builder attemptDeadline​(String attemptDeadline)
        The deadline for job attempts.

        If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * **Note**: For PubSub targets, this field is ignored - setting it will introduce an unresolvable diff. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s" Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#attempt_deadline CloudSchedulerJob#attempt_deadline}

        Parameters:
        attemptDeadline - The deadline for job attempts. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public CloudSchedulerJob.Builder description​(String description)
        A human-readable description for the job. This string must not contain more than 500 characters.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#description CloudSchedulerJob#description}

        Parameters:
        description - A human-readable description for the job. This string must not contain more than 500 characters. This parameter is required.
        Returns:
        this

      • httpTarget

        @Stability(Stable)
public CloudSchedulerJob.Builder httpTarget​(CloudSchedulerJobHttpTarget httpTarget)
        http_target block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#http_target CloudSchedulerJob#http_target}

        Parameters:
        httpTarget - http_target block. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public CloudSchedulerJob.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#id CloudSchedulerJob#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#id CloudSchedulerJob#id}. This parameter is required.
        Returns:
        this

      • paused

        @Stability(Stable)
public CloudSchedulerJob.Builder paused​(Boolean paused)
        Sets the job to a paused state. Jobs default to being enabled when this property is not set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#paused CloudSchedulerJob#paused}

        Parameters:
        paused - Sets the job to a paused state. Jobs default to being enabled when this property is not set. This parameter is required.
        Returns:
        this

      • paused

        @Stability(Stable)
public CloudSchedulerJob.Builder paused​(com.hashicorp.cdktf.IResolvable paused)
        Sets the job to a paused state. Jobs default to being enabled when this property is not set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#paused CloudSchedulerJob#paused}

        Parameters:
        paused - Sets the job to a paused state. Jobs default to being enabled when this property is not set. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public CloudSchedulerJob.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#project CloudSchedulerJob#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#project CloudSchedulerJob#project}. This parameter is required.
        Returns:
        this

      • pubsubTarget

        @Stability(Stable)
public CloudSchedulerJob.Builder pubsubTarget​(CloudSchedulerJobPubsubTarget pubsubTarget)
        pubsub_target block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#pubsub_target CloudSchedulerJob#pubsub_target}

        Parameters:
        pubsubTarget - pubsub_target block. This parameter is required.
        Returns:
        this

      • region

        @Stability(Stable)
public CloudSchedulerJob.Builder region​(String region)
        Region where the scheduler job resides. If it is not provided, Terraform will use the provider default.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#region CloudSchedulerJob#region}

        Parameters:
        region - Region where the scheduler job resides. If it is not provided, Terraform will use the provider default. This parameter is required.
        Returns:
        this

      • retryConfig

        @Stability(Stable)
public CloudSchedulerJob.Builder retryConfig​(CloudSchedulerJobRetryConfig retryConfig)
        retry_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#retry_config CloudSchedulerJob#retry_config}

        Parameters:
        retryConfig - retry_config block. This parameter is required.
        Returns:
        this

      • schedule

        @Stability(Stable)
public CloudSchedulerJob.Builder schedule​(String schedule)
        Describes the schedule on which the job will be executed.

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

        Parameters:
        schedule - Describes the schedule on which the job will be executed. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public CloudSchedulerJob.Builder timeouts​(CloudSchedulerJobTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#timeouts CloudSchedulerJob#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • timeZone

        @Stability(Stable)
public CloudSchedulerJob.Builder timeZone​(String timeZone)
        Specifies the time zone to be used in interpreting schedule.

        The value of this field must be a time zone name from the tz database. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/cloud_scheduler_job#time_zone CloudSchedulerJob#time_zone}

        Parameters:
        timeZone - Specifies the time zone to be used in interpreting schedule. This parameter is required.
        Returns:
        this