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

Interface CloudSchedulerJobConfig

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

    • Method Detail

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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}

      • getAppEngineHttpTarget

        @Stability(Stable)
@Nullable
default CloudSchedulerJobAppEngineHttpTarget getAppEngineHttpTarget()
        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}

      • getAttemptDeadline

        @Stability(Stable)
@Nullable
default String getAttemptDeadline()
        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}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        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}

      • getHttpTarget

        @Stability(Stable)
@Nullable
default CloudSchedulerJobHttpTarget getHttpTarget()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getPaused

        @Stability(Stable)
@Nullable
default Object getPaused()
        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}

      • getProject

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

      • getPubsubTarget

        @Stability(Stable)
@Nullable
default CloudSchedulerJobPubsubTarget getPubsubTarget()
        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}

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        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}

      • getRetryConfig

        @Stability(Stable)
@Nullable
default CloudSchedulerJobRetryConfig getRetryConfig()
        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}

      • getSchedule

        @Stability(Stable)
@Nullable
default String getSchedule()
        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}

      • getTimeouts

        @Stability(Stable)
@Nullable
default CloudSchedulerJobTimeouts getTimeouts()
        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}

      • getTimeZone

        @Stability(Stable)
@Nullable
default String getTimeZone()
        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}