Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.cloudscheduler/v1.Job
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a job.
Create Job Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Job(name: string, args?: JobArgs, opts?: CustomResourceOptions);
@overload
def Job(resource_name: str,
args: Optional[JobArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Job(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_engine_http_target: Optional[AppEngineHttpTargetArgs] = None,
attempt_deadline: Optional[str] = None,
description: Optional[str] = None,
http_target: Optional[HttpTargetArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
pubsub_target: Optional[PubsubTargetArgs] = None,
retry_config: Optional[RetryConfigArgs] = None,
schedule: Optional[str] = None,
time_zone: Optional[str] = None)
func NewJob(ctx *Context, name string, args *JobArgs, opts ...ResourceOption) (*Job, error)
public Job(string name, JobArgs? args = null, CustomResourceOptions? opts = null)
type: google-native:cloudscheduler/v1:Job
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var examplejobResourceResourceFromCloudschedulerv1 = new GoogleNative.CloudScheduler.V1.Job("examplejobResourceResourceFromCloudschedulerv1", new()
{
AppEngineHttpTarget = new GoogleNative.CloudScheduler.V1.Inputs.AppEngineHttpTargetArgs
{
AppEngineRouting = new GoogleNative.CloudScheduler.V1.Inputs.AppEngineRoutingArgs
{
Instance = "string",
Service = "string",
Version = "string",
},
Body = "string",
Headers =
{
{ "string", "string" },
},
HttpMethod = GoogleNative.CloudScheduler.V1.AppEngineHttpTargetHttpMethod.HttpMethodUnspecified,
RelativeUri = "string",
},
AttemptDeadline = "string",
Description = "string",
HttpTarget = new GoogleNative.CloudScheduler.V1.Inputs.HttpTargetArgs
{
Uri = "string",
Body = "string",
Headers =
{
{ "string", "string" },
},
HttpMethod = GoogleNative.CloudScheduler.V1.HttpTargetHttpMethod.HttpMethodUnspecified,
OauthToken = new GoogleNative.CloudScheduler.V1.Inputs.OAuthTokenArgs
{
Scope = "string",
ServiceAccountEmail = "string",
},
OidcToken = new GoogleNative.CloudScheduler.V1.Inputs.OidcTokenArgs
{
Audience = "string",
ServiceAccountEmail = "string",
},
},
Location = "string",
Name = "string",
Project = "string",
PubsubTarget = new GoogleNative.CloudScheduler.V1.Inputs.PubsubTargetArgs
{
TopicName = "string",
Attributes =
{
{ "string", "string" },
},
Data = "string",
},
RetryConfig = new GoogleNative.CloudScheduler.V1.Inputs.RetryConfigArgs
{
MaxBackoffDuration = "string",
MaxDoublings = 0,
MaxRetryDuration = "string",
MinBackoffDuration = "string",
RetryCount = 0,
},
Schedule = "string",
TimeZone = "string",
});
example, err := cloudscheduler.NewJob(ctx, "examplejobResourceResourceFromCloudschedulerv1", &cloudscheduler.JobArgs{
AppEngineHttpTarget: &cloudscheduler.AppEngineHttpTargetArgs{
AppEngineRouting: &cloudscheduler.AppEngineRoutingArgs{
Instance: pulumi.String("string"),
Service: pulumi.String("string"),
Version: pulumi.String("string"),
},
Body: pulumi.String("string"),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
HttpMethod: cloudscheduler.AppEngineHttpTargetHttpMethodHttpMethodUnspecified,
RelativeUri: pulumi.String("string"),
},
AttemptDeadline: pulumi.String("string"),
Description: pulumi.String("string"),
HttpTarget: &cloudscheduler.HttpTargetArgs{
Uri: pulumi.String("string"),
Body: pulumi.String("string"),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
HttpMethod: cloudscheduler.HttpTargetHttpMethodHttpMethodUnspecified,
OauthToken: &cloudscheduler.OAuthTokenArgs{
Scope: pulumi.String("string"),
ServiceAccountEmail: pulumi.String("string"),
},
OidcToken: &cloudscheduler.OidcTokenArgs{
Audience: pulumi.String("string"),
ServiceAccountEmail: pulumi.String("string"),
},
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
PubsubTarget: &cloudscheduler.PubsubTargetArgs{
TopicName: pulumi.String("string"),
Attributes: pulumi.StringMap{
"string": pulumi.String("string"),
},
Data: pulumi.String("string"),
},
RetryConfig: &cloudscheduler.RetryConfigArgs{
MaxBackoffDuration: pulumi.String("string"),
MaxDoublings: pulumi.Int(0),
MaxRetryDuration: pulumi.String("string"),
MinBackoffDuration: pulumi.String("string"),
RetryCount: pulumi.Int(0),
},
Schedule: pulumi.String("string"),
TimeZone: pulumi.String("string"),
})
var examplejobResourceResourceFromCloudschedulerv1 = new Job("examplejobResourceResourceFromCloudschedulerv1", JobArgs.builder()
.appEngineHttpTarget(AppEngineHttpTargetArgs.builder()
.appEngineRouting(AppEngineRoutingArgs.builder()
.instance("string")
.service("string")
.version("string")
.build())
.body("string")
.headers(Map.of("string", "string"))
.httpMethod("HTTP_METHOD_UNSPECIFIED")
.relativeUri("string")
.build())
.attemptDeadline("string")
.description("string")
.httpTarget(HttpTargetArgs.builder()
.uri("string")
.body("string")
.headers(Map.of("string", "string"))
.httpMethod("HTTP_METHOD_UNSPECIFIED")
.oauthToken(OAuthTokenArgs.builder()
.scope("string")
.serviceAccountEmail("string")
.build())
.oidcToken(OidcTokenArgs.builder()
.audience("string")
.serviceAccountEmail("string")
.build())
.build())
.location("string")
.name("string")
.project("string")
.pubsubTarget(PubsubTargetArgs.builder()
.topicName("string")
.attributes(Map.of("string", "string"))
.data("string")
.build())
.retryConfig(RetryConfigArgs.builder()
.maxBackoffDuration("string")
.maxDoublings(0)
.maxRetryDuration("string")
.minBackoffDuration("string")
.retryCount(0)
.build())
.schedule("string")
.timeZone("string")
.build());
examplejob_resource_resource_from_cloudschedulerv1 = google_native.cloudscheduler.v1.Job("examplejobResourceResourceFromCloudschedulerv1",
app_engine_http_target=google_native.cloudscheduler.v1.AppEngineHttpTargetArgs(
app_engine_routing=google_native.cloudscheduler.v1.AppEngineRoutingArgs(
instance="string",
service="string",
version="string",
),
body="string",
headers={
"string": "string",
},
http_method=google_native.cloudscheduler.v1.AppEngineHttpTargetHttpMethod.HTTP_METHOD_UNSPECIFIED,
relative_uri="string",
),
attempt_deadline="string",
description="string",
http_target=google_native.cloudscheduler.v1.HttpTargetArgs(
uri="string",
body="string",
headers={
"string": "string",
},
http_method=google_native.cloudscheduler.v1.HttpTargetHttpMethod.HTTP_METHOD_UNSPECIFIED,
oauth_token=google_native.cloudscheduler.v1.OAuthTokenArgs(
scope="string",
service_account_email="string",
),
oidc_token=google_native.cloudscheduler.v1.OidcTokenArgs(
audience="string",
service_account_email="string",
),
),
location="string",
name="string",
project="string",
pubsub_target=google_native.cloudscheduler.v1.PubsubTargetArgs(
topic_name="string",
attributes={
"string": "string",
},
data="string",
),
retry_config=google_native.cloudscheduler.v1.RetryConfigArgs(
max_backoff_duration="string",
max_doublings=0,
max_retry_duration="string",
min_backoff_duration="string",
retry_count=0,
),
schedule="string",
time_zone="string")
const examplejobResourceResourceFromCloudschedulerv1 = new google_native.cloudscheduler.v1.Job("examplejobResourceResourceFromCloudschedulerv1", {
appEngineHttpTarget: {
appEngineRouting: {
instance: "string",
service: "string",
version: "string",
},
body: "string",
headers: {
string: "string",
},
httpMethod: google_native.cloudscheduler.v1.AppEngineHttpTargetHttpMethod.HttpMethodUnspecified,
relativeUri: "string",
},
attemptDeadline: "string",
description: "string",
httpTarget: {
uri: "string",
body: "string",
headers: {
string: "string",
},
httpMethod: google_native.cloudscheduler.v1.HttpTargetHttpMethod.HttpMethodUnspecified,
oauthToken: {
scope: "string",
serviceAccountEmail: "string",
},
oidcToken: {
audience: "string",
serviceAccountEmail: "string",
},
},
location: "string",
name: "string",
project: "string",
pubsubTarget: {
topicName: "string",
attributes: {
string: "string",
},
data: "string",
},
retryConfig: {
maxBackoffDuration: "string",
maxDoublings: 0,
maxRetryDuration: "string",
minBackoffDuration: "string",
retryCount: 0,
},
schedule: "string",
timeZone: "string",
});
type: google-native:cloudscheduler/v1:Job
properties:
appEngineHttpTarget:
appEngineRouting:
instance: string
service: string
version: string
body: string
headers:
string: string
httpMethod: HTTP_METHOD_UNSPECIFIED
relativeUri: string
attemptDeadline: string
description: string
httpTarget:
body: string
headers:
string: string
httpMethod: HTTP_METHOD_UNSPECIFIED
oauthToken:
scope: string
serviceAccountEmail: string
oidcToken:
audience: string
serviceAccountEmail: string
uri: string
location: string
name: string
project: string
pubsubTarget:
attributes:
string: string
data: string
topicName: string
retryConfig:
maxBackoffDuration: string
maxDoublings: 0
maxRetryDuration: string
minBackoffDuration: string
retryCount: 0
schedule: string
timeZone: string
Job Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Job resource accepts the following input properties:
- App
Engine Pulumi.Http Target Google Native. Cloud Scheduler. V1. Inputs. App Engine Http Target - App Engine HTTP target.
- Attempt
Deadline 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 default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. - Description string
- Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
- Http
Target Pulumi.Google Native. Cloud Scheduler. V1. Inputs. Http Target - HTTP target.
- Location string
- Name string
- Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. *PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects *LOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. *JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - Project string
- Pubsub
Target Pulumi.Google Native. Cloud Scheduler. V1. Inputs. Pubsub Target - Pub/Sub target.
- Retry
Config Pulumi.Google Native. Cloud Scheduler. V1. Inputs. Retry Config - Settings that determine the retry behavior.
- Schedule string
- Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab * English-like schedule As a general rule, execution
n + 1
of a job will not begin until executionn
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1
th execution is scheduled to run at 16:00 but then
th execution takes until 16:15, then+1
th execution will not start until16:15
. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. - Time
Zone 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. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
- App
Engine AppHttp Target Engine Http Target Args - App Engine HTTP target.
- Attempt
Deadline 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 default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. - Description string
- Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
- Http
Target HttpTarget Args - HTTP target.
- Location string
- Name string
- Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. *PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects *LOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. *JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - Project string
- Pubsub
Target PubsubTarget Args - Pub/Sub target.
- Retry
Config RetryConfig Args - Settings that determine the retry behavior.
- Schedule string
- Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab * English-like schedule As a general rule, execution
n + 1
of a job will not begin until executionn
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1
th execution is scheduled to run at 16:00 but then
th execution takes until 16:15, then+1
th execution will not start until16:15
. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. - Time
Zone 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. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
- app
Engine AppHttp Target Engine Http Target - App Engine HTTP target.
- attempt
Deadline 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 default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. - description String
- Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
- http
Target HttpTarget - HTTP target.
- location String
- name String
- Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. *PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects *LOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. *JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - project String
- pubsub
Target PubsubTarget - Pub/Sub target.
- retry
Config RetryConfig - Settings that determine the retry behavior.
- schedule String
- Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab * English-like schedule As a general rule, execution
n + 1
of a job will not begin until executionn
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1
th execution is scheduled to run at 16:00 but then
th execution takes until 16:15, then+1
th execution will not start until16:15
. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. - time
Zone 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. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
- app
Engine AppHttp Target Engine Http Target - App Engine HTTP target.
- attempt
Deadline 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 default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. - description string
- Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
- http
Target HttpTarget - HTTP target.
- location string
- name string
- Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. *PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects *LOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. *JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - project string
- pubsub
Target PubsubTarget - Pub/Sub target.
- retry
Config RetryConfig - Settings that determine the retry behavior.
- schedule string
- Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab * English-like schedule As a general rule, execution
n + 1
of a job will not begin until executionn
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1
th execution is scheduled to run at 16:00 but then
th execution takes until 16:15, then+1
th execution will not start until16:15
. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. - time
Zone 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. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
- app_
engine_ Apphttp_ target Engine Http Target Args - App Engine HTTP target.
- attempt_
deadline str - 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 default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. - description str
- Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
- http_
target HttpTarget Args - HTTP target.
- location str
- name str
- Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. *PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects *LOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. *JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - project str
- pubsub_
target PubsubTarget Args - Pub/Sub target.
- retry_
config RetryConfig Args - Settings that determine the retry behavior.
- schedule str
- Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab * English-like schedule As a general rule, execution
n + 1
of a job will not begin until executionn
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1
th execution is scheduled to run at 16:00 but then
th execution takes until 16:15, then+1
th execution will not start until16:15
. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. - time_
zone str - 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. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
- app
Engine Property MapHttp Target - App Engine HTTP target.
- attempt
Deadline 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 default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. - description String
- Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
- http
Target Property Map - HTTP target.
- location String
- name String
- Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. *PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects *LOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. *JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - project String
- pubsub
Target Property Map - Pub/Sub target.
- retry
Config Property Map - Settings that determine the retry behavior.
- schedule String
- Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab * English-like schedule As a general rule, execution
n + 1
of a job will not begin until executionn
has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1
th execution is scheduled to run at 16:00 but then
th execution takes until 16:15, then+1
th execution will not start until16:15
. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. - time
Zone 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. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
Outputs
All input properties are implicitly available as output properties. Additionally, the Job resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Attempt stringTime - The time the last job attempt started.
- Schedule
Time string - The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
- State string
- State of the job.
- Status
Pulumi.
Google Native. Cloud Scheduler. V1. Outputs. Status Response - The response from the target for the last attempted execution.
- User
Update stringTime - The creation time of the job.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Attempt stringTime - The time the last job attempt started.
- Schedule
Time string - The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
- State string
- State of the job.
- Status
Status
Response - The response from the target for the last attempted execution.
- User
Update stringTime - The creation time of the job.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Attempt StringTime - The time the last job attempt started.
- schedule
Time String - The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
- state String
- State of the job.
- status
Status
Response - The response from the target for the last attempted execution.
- user
Update StringTime - The creation time of the job.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Attempt stringTime - The time the last job attempt started.
- schedule
Time string - The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
- state string
- State of the job.
- status
Status
Response - The response from the target for the last attempted execution.
- user
Update stringTime - The creation time of the job.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
attempt_ strtime - The time the last job attempt started.
- schedule_
time str - The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
- state str
- State of the job.
- status
Status
Response - The response from the target for the last attempted execution.
- user_
update_ strtime - The creation time of the job.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Attempt StringTime - The time the last job attempt started.
- schedule
Time String - The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
- state String
- State of the job.
- status Property Map
- The response from the target for the last attempted execution.
- user
Update StringTime - The creation time of the job.
Supporting Types
AppEngineHttpTarget, AppEngineHttpTargetArgs
- App
Engine Pulumi.Routing Google Native. Cloud Scheduler. V1. Inputs. App Engine Routing - App Engine Routing setting for the job.
- Body string
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- Headers Dictionary<string, string>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - Http
Method Pulumi.Google Native. Cloud Scheduler. V1. App Engine Http Target Http Method - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- Relative
Uri string - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- App
Engine AppRouting Engine Routing - App Engine Routing setting for the job.
- Body string
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- Headers map[string]string
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - Http
Method AppEngine Http Target Http Method - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- Relative
Uri string - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine AppRouting Engine Routing - App Engine Routing setting for the job.
- body String
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- headers Map<String,String>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - http
Method AppEngine Http Target Http Method - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- relative
Uri String - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine AppRouting Engine Routing - App Engine Routing setting for the job.
- body string
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- headers {[key: string]: string}
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - http
Method AppEngine Http Target Http Method - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- relative
Uri string - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app_
engine_ Approuting Engine Routing - App Engine Routing setting for the job.
- body str
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- headers Mapping[str, str]
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - http_
method AppEngine Http Target Http Method - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- relative_
uri str - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine Property MapRouting - App Engine Routing setting for the job.
- body String
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- headers Map<String>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - http
Method "HTTP_METHOD_UNSPECIFIED" | "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- relative
Uri String - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
AppEngineHttpTargetHttpMethod, AppEngineHttpTargetHttpMethodArgs
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- App
Engine Http Target Http Method Http Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- App
Engine Http Target Http Method Post - POSTHTTP POST
- App
Engine Http Target Http Method Get - GETHTTP GET
- App
Engine Http Target Http Method Head - HEADHTTP HEAD
- App
Engine Http Target Http Method Put - PUTHTTP PUT
- App
Engine Http Target Http Method Delete - DELETEHTTP DELETE
- App
Engine Http Target Http Method Patch - PATCHHTTP PATCH
- App
Engine Http Target Http Method Options - OPTIONSHTTP OPTIONS
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- HTTP_METHOD_UNSPECIFIED
- HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- POST
- POSTHTTP POST
- GET
- GETHTTP GET
- HEAD
- HEADHTTP HEAD
- PUT
- PUTHTTP PUT
- DELETE
- DELETEHTTP DELETE
- PATCH
- PATCHHTTP PATCH
- OPTIONS
- OPTIONSHTTP OPTIONS
- "HTTP_METHOD_UNSPECIFIED"
- HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- "POST"
- POSTHTTP POST
- "GET"
- GETHTTP GET
- "HEAD"
- HEADHTTP HEAD
- "PUT"
- PUTHTTP PUT
- "DELETE"
- DELETEHTTP DELETE
- "PATCH"
- PATCHHTTP PATCH
- "OPTIONS"
- OPTIONSHTTP OPTIONS
AppEngineHttpTargetResponse, AppEngineHttpTargetResponseArgs
- App
Engine Pulumi.Routing Google Native. Cloud Scheduler. V1. Inputs. App Engine Routing Response - App Engine Routing setting for the job.
- Body string
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- Headers Dictionary<string, string>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - Http
Method string - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- Relative
Uri string - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- App
Engine AppRouting Engine Routing Response - App Engine Routing setting for the job.
- Body string
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- Headers map[string]string
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - Http
Method string - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- Relative
Uri string - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine AppRouting Engine Routing Response - App Engine Routing setting for the job.
- body String
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- headers Map<String,String>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - http
Method String - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- relative
Uri String - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine AppRouting Engine Routing Response - App Engine Routing setting for the job.
- body string
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- headers {[key: string]: string}
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - http
Method string - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- relative
Uri string - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app_
engine_ Approuting Engine Routing Response - App Engine Routing setting for the job.
- body str
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- headers Mapping[str, str]
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - http_
method str - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- relative_
uri str - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine Property MapRouting - App Engine Routing setting for the job.
- body String
- Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
- headers Map<String>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Scheduler will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The headers below are output only. They cannot be set or overridden: *Content-Length
: This is computed by Cloud Scheduler. *X-Google-*
: For Google internal use only. *X-AppEngine-*
: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. - http
Method String - The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
- relative
Uri String - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and
#
fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
AppEngineRouting, AppEngineRoutingArgs
- Instance string
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- Service string
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- Version string
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- Instance string
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- Service string
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- Version string
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- instance String
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service String
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- version String
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- instance string
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service string
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- version string
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- instance str
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service str
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- version str
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- instance String
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service String
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- version String
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
AppEngineRoutingResponse, AppEngineRoutingResponseArgs
- Host string
- The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the job's project ID. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. - Instance string
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- Service string
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- Version string
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- Host string
- The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the job's project ID. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. - Instance string
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- Service string
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- Version string
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- host String
- The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the job's project ID. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. - instance String
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service String
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- version String
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- host string
- The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the job's project ID. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. - instance string
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service string
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- version string
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- host str
- The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the job's project ID. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. - instance str
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service str
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- version str
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
- host String
- The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the job's project ID. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted. - instance String
- App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service String
- App service. By default, the job is sent to the service which is the default service when the job is attempted.
- version String
- App version. By default, the job is sent to the version which is the default version when the job is attempted.
HttpTarget, HttpTargetArgs
- Uri string
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. - Body string
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- Headers Dictionary<string, string>
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - Http
Method Pulumi.Google Native. Cloud Scheduler. V1. Http Target Http Method - Which HTTP method to use for the request.
- Oauth
Token Pulumi.Google Native. Cloud Scheduler. V1. Inputs. OAuth Token - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - Oidc
Token Pulumi.Google Native. Cloud Scheduler. V1. Inputs. Oidc Token - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
- Uri string
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. - Body string
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- Headers map[string]string
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - Http
Method HttpTarget Http Method - Which HTTP method to use for the request.
- Oauth
Token OAuthToken - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - Oidc
Token OidcToken - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
- uri String
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. - body String
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- headers Map<String,String>
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - http
Method HttpTarget Http Method - Which HTTP method to use for the request.
- oauth
Token OAuthToken - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token OidcToken - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
- uri string
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. - body string
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- headers {[key: string]: string}
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - http
Method HttpTarget Http Method - Which HTTP method to use for the request.
- oauth
Token OAuthToken - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token OidcToken - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
- uri str
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. - body str
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- headers Mapping[str, str]
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - http_
method HttpTarget Http Method - Which HTTP method to use for the request.
- oauth_
token OAuthToken - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc_
token OidcToken - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
- uri String
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. - body String
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- headers Map<String>
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - http
Method "HTTP_METHOD_UNSPECIFIED" | "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" - Which HTTP method to use for the request.
- oauth
Token Property Map - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token Property Map - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
HttpTargetHttpMethod, HttpTargetHttpMethodArgs
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- Http
Target Http Method Http Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- Http
Target Http Method Post - POSTHTTP POST
- Http
Target Http Method Get - GETHTTP GET
- Http
Target Http Method Head - HEADHTTP HEAD
- Http
Target Http Method Put - PUTHTTP PUT
- Http
Target Http Method Delete - DELETEHTTP DELETE
- Http
Target Http Method Patch - PATCHHTTP PATCH
- Http
Target Http Method Options - OPTIONSHTTP OPTIONS
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- HTTP_METHOD_UNSPECIFIED
- HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- POST
- POSTHTTP POST
- GET
- GETHTTP GET
- HEAD
- HEADHTTP HEAD
- PUT
- PUTHTTP PUT
- DELETE
- DELETEHTTP DELETE
- PATCH
- PATCHHTTP PATCH
- OPTIONS
- OPTIONSHTTP OPTIONS
- "HTTP_METHOD_UNSPECIFIED"
- HTTP_METHOD_UNSPECIFIEDHTTP method unspecified. Defaults to POST.
- "POST"
- POSTHTTP POST
- "GET"
- GETHTTP GET
- "HEAD"
- HEADHTTP HEAD
- "PUT"
- PUTHTTP PUT
- "DELETE"
- DELETEHTTP DELETE
- "PATCH"
- PATCHHTTP PATCH
- "OPTIONS"
- OPTIONSHTTP OPTIONS
HttpTargetResponse, HttpTargetResponseArgs
- Body string
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- Headers Dictionary<string, string>
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - Http
Method string - Which HTTP method to use for the request.
- Oauth
Token Pulumi.Google Native. Cloud Scheduler. V1. Inputs. OAuth Token Response - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - Oidc
Token Pulumi.Google Native. Cloud Scheduler. V1. Inputs. Oidc Token Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - Uri string
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
- Body string
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- Headers map[string]string
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - Http
Method string - Which HTTP method to use for the request.
- Oauth
Token OAuthToken Response - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - Oidc
Token OidcToken Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - Uri string
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
- body String
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- headers Map<String,String>
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - http
Method String - Which HTTP method to use for the request.
- oauth
Token OAuthToken Response - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token OidcToken Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - uri String
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
- body string
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- headers {[key: string]: string}
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - http
Method string - Which HTTP method to use for the request.
- oauth
Token OAuthToken Response - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token OidcToken Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - uri string
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
- body str
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- headers Mapping[str, str]
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - http_
method str - Which HTTP method to use for the request.
- oauth_
token OAuthToken Response - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc_
token OidcToken Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - uri str
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
- body String
- HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.
- headers Map<String>
- HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. *
Content-Length
: This will be computed by Cloud Scheduler. *User-Agent
: This will be set to"Google-Cloud-Scheduler"
. *X-Google-*
: Google internal use only. *X-AppEngine-*
: Google internal use only. *X-CloudScheduler
: This header will be set to true. *X-CloudScheduler-JobName
: This header will contain the job name. *X-CloudScheduler-ScheduleTime
: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: *Content-Type
: This will be set to"application/octet-stream"
. You can override this default by explicitly settingContent-Type
to a particular media type when creating the job. For example, you can setContent-Type
to"application/json"
. The total size of headers must be less than 80KB. - http
Method String - Which HTTP method to use for the request.
- oauth
Token Property Map - If specified, an OAuth token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token Property Map - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - uri String
- The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
OAuthToken, OAuthTokenArgs
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope str
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service_
account_ stremail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
OAuthTokenResponse, OAuthTokenResponseArgs
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope str
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service_
account_ stremail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
OidcToken, OidcTokenArgs
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience str
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service_
account_ stremail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
OidcTokenResponse, OidcTokenResponseArgs
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience str
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service_
account_ stremail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.
PubsubTarget, PubsubTargetArgs
- Topic
Name string - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job. - Attributes Dictionary<string, string>
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- Data string
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- Topic
Name string - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job. - Attributes map[string]string
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- Data string
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- topic
Name String - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job. - attributes Map<String,String>
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- data String
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- topic
Name string - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job. - attributes {[key: string]: string}
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- data string
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- topic_
name str - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job. - attributes Mapping[str, str]
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- data str
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- topic
Name String - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job. - attributes Map<String>
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- data String
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
PubsubTargetResponse, PubsubTargetResponseArgs
- Attributes Dictionary<string, string>
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- Data string
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- Topic
Name string - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job.
- Attributes map[string]string
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- Data string
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- Topic
Name string - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job.
- attributes Map<String,String>
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- data String
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- topic
Name String - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job.
- attributes {[key: string]: string}
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- data string
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- topic
Name string - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job.
- attributes Mapping[str, str]
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- data str
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- topic_
name str - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job.
- attributes Map<String>
- Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- data String
- The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
- topic
Name String - The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example
projects/PROJECT_ID/topics/TOPIC_ID
. The topic must be in the same project as the Cloud Scheduler job.
RetryConfig, RetryConfigArgs
- Max
Backoff stringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- Max
Doublings int - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - Max
Retry stringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- Min
Backoff stringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- Retry
Count int - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- Max
Backoff stringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- Max
Doublings int - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - Max
Retry stringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- Min
Backoff stringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- Retry
Count int - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- max
Backoff StringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- max
Doublings Integer - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - max
Retry StringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- min
Backoff StringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- retry
Count Integer - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- max
Backoff stringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- max
Doublings number - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - max
Retry stringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- min
Backoff stringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- retry
Count number - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- max_
backoff_ strduration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- max_
doublings int - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - max_
retry_ strduration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- min_
backoff_ strduration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- retry_
count int - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- max
Backoff StringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- max
Doublings Number - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - max
Retry StringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- min
Backoff StringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- retry
Count Number - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
RetryConfigResponse, RetryConfigResponseArgs
- Max
Backoff stringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- Max
Doublings int - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - Max
Retry stringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- Min
Backoff stringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- Retry
Count int - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- Max
Backoff stringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- Max
Doublings int - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - Max
Retry stringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- Min
Backoff stringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- Retry
Count int - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- max
Backoff StringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- max
Doublings Integer - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - max
Retry StringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- min
Backoff StringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- retry
Count Integer - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- max
Backoff stringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- max
Doublings number - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - max
Retry stringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- min
Backoff stringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- retry
Count number - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- max_
backoff_ strduration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- max_
doublings int - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - max_
retry_ strduration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- min_
backoff_ strduration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- retry_
count int - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
- max
Backoff StringDuration - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
- max
Doublings Number - The time between retries will double
max_doublings
times. A job's retry interval starts at min_backoff_duration, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, andmax_doublings
is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. - max
Retry StringDuration - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
- min
Backoff StringDuration - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
- retry
Count Number - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
StatusResponse, StatusResponseArgs
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<Immutable
Dictionary<string, string>> - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details []map[string]string
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code Integer
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String,String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code number
- The status code, which should be an enum value of google.rpc.Code.
- details {[key: string]: string}[]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code int
- The status code, which should be an enum value of google.rpc.Code.
- details Sequence[Mapping[str, str]]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message str
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code Number
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.