pulumi-gcp-kotlin/com.pulumi.gcp.cloudscheduler.kotlin/Job

Job

class Job : KotlinCustomResource

/* /* /* A scheduled job that can publish a PubSub message or an HTTP request every X interval of time, using a crontab format string. To get more information about Job, see:

Example Usage

Scheduler Job App Engine

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudscheduler.Job;
import com.pulumi.gcp.cloudscheduler.JobArgs;
import com.pulumi.gcp.cloudscheduler.inputs.JobAppEngineHttpTargetArgs;
import com.pulumi.gcp.cloudscheduler.inputs.JobAppEngineHttpTargetAppEngineRoutingArgs;
import com.pulumi.gcp.cloudscheduler.inputs.JobRetryConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var job = new Job("job", JobArgs.builder()
            .appEngineHttpTarget(JobAppEngineHttpTargetArgs.builder()
                .appEngineRouting(JobAppEngineHttpTargetAppEngineRoutingArgs.builder()
                    .instance("my-instance-001")
                    .service("web")
                    .version("prod")
                    .build())
                .httpMethod("POST")
                .relativeUri("/ping")
                .build())
            .attemptDeadline("320s")
            .description("test app engine job")
            .retryConfig(JobRetryConfigArgs.builder()
                .maxDoublings(2)
                .maxRetryDuration("10s")
                .minBackoffDuration("1s")
                .retryCount(3)
                .build())
            .schedule("*/4 * * * *")
             .timeZone("Europe/London")
             .build());
     }
 }
Content copied to clipboard

Scheduler Job Oauth

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetDefaultServiceAccountArgs;
import com.pulumi.gcp.cloudscheduler.Job;
import com.pulumi.gcp.cloudscheduler.JobArgs;
import com.pulumi.gcp.cloudscheduler.inputs.JobHttpTargetArgs;
import com.pulumi.gcp.cloudscheduler.inputs.JobHttpTargetOauthTokenArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var default = ComputeFunctions.getDefaultServiceAccount();
        var job = new Job("job", JobArgs.builder()
            .description("test http job")
            .schedule("*/8 * * * *")
             .timeZone("America/New_York")
             .attemptDeadline("320s")
             .httpTarget(JobHttpTargetArgs.builder()
                 .httpMethod("GET")
                 .uri("https://cloudscheduler.googleapis.com/v1/projects/my-project-name/locations/us-west1/jobs")
                 .oauthToken(JobHttpTargetOauthTokenArgs.builder()
                     .serviceAccountEmail(default_.email())
                     .build())
                 .build())
             .build());
     }
 }
Content copied to clipboard

Scheduler Job Oidc

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetDefaultServiceAccountArgs;
import com.pulumi.gcp.cloudscheduler.Job;
import com.pulumi.gcp.cloudscheduler.JobArgs;
import com.pulumi.gcp.cloudscheduler.inputs.JobHttpTargetArgs;
import com.pulumi.gcp.cloudscheduler.inputs.JobHttpTargetOidcTokenArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var default = ComputeFunctions.getDefaultServiceAccount();
        var job = new Job("job", JobArgs.builder()
            .description("test http job")
            .schedule("*/8 * * * *")
             .timeZone("America/New_York")
             .attemptDeadline("320s")
             .httpTarget(JobHttpTargetArgs.builder()
                 .httpMethod("GET")
                 .uri("https://example.com/ping")
                 .oidcToken(JobHttpTargetOidcTokenArgs.builder()
                     .serviceAccountEmail(default_.email())
                     .build())
                 .build())
             .build());
     }
 }
Content copied to clipboard

Import

Job can be imported using any of these accepted formats

$ pulumi import gcp:cloudscheduler/job:Job default projects/{{project}}/locations/{{region}}/jobs/{{name}}
Content copied to clipboard
$ pulumi import gcp:cloudscheduler/job:Job default {{project}}/{{region}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:cloudscheduler/job:Job default {{region}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:cloudscheduler/job:Job default {{name}}
Content copied to clipboard

Properties

Link copied to clipboard
val appEngineHttpTarget: Output<JobAppEngineHttpTarget>?

App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.

Link copied to clipboard
val attemptDeadline: Output<String>?

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:

Link copied to clipboard
val description: Output<String>?

A human-readable description for the job. This string must not contain more than 500 characters.

Link copied to clipboard
val httpTarget: Output<JobHttpTarget>?

HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name of the job.

Link copied to clipboard
val paused: Output<Boolean>

Sets the job to a paused state. Jobs default to being enabled when this property is not set.

Link copied to clipboard
val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val pubsubTarget: Output<JobPubsubTarget>?

Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val region: Output<String>

Region where the scheduler job resides. If it is not provided, this provider will use the provider default.

Link copied to clipboard
val retryConfig: Output<JobRetryConfig>?

By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.

Link copied to clipboard
val schedule: Output<String>?

Describes the schedule on which the job will be executed.

Link copied to clipboard
val state: Output<String>

State of the job.

Link copied to clipboard
val timeZone: Output<String>?

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.

Link copied to clipboard
val urn: Output<String>