Job
data class JobArgs(val appEngineHttpTarget: Output<JobAppEngineHttpTargetArgs>? = null, val attemptDeadline: Output<String>? = null, val description: Output<String>? = null, val httpTarget: Output<JobHttpTargetArgs>? = null, val name: Output<String>? = null, val paused: Output<Boolean>? = null, val project: Output<String>? = null, val pubsubTarget: Output<JobPubsubTargetArgs>? = null, val region: Output<String>? = null, val retryConfig: Output<JobRetryConfigArgs>? = null, val schedule: Output<String>? = null, val timeZone: Output<String>? = null) : ConvertibleToJava<JobArgs>
/* /* /* 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:
How-to Guides
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
Constructors
Link copied to clipboard
constructor(appEngineHttpTarget: Output<JobAppEngineHttpTargetArgs>? = null, attemptDeadline: Output<String>? = null, description: Output<String>? = null, httpTarget: Output<JobHttpTargetArgs>? = null, name: Output<String>? = null, paused: Output<Boolean>? = null, project: Output<String>? = null, pubsubTarget: Output<JobPubsubTargetArgs>? = null, region: Output<String>? = null, retryConfig: Output<JobRetryConfigArgs>? = null, schedule: Output<String>? = null, timeZone: Output<String>? = null)
Properties
Link copied to clipboard
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
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
A human-readable description for the job. This string must not contain more than 500 characters.
Link copied to clipboard
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
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
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.