Job

A scheduled job that can publish a pubsub message or a http request every X interval of time, using crontab format string.

To use Cloud Scheduler your project must contain an App Engine app that is located in one of the supported regions. If your project does not have an App Engine app, you must create one.

To get more information about Job, see:

API documentation
How-to Guides
- Official Documentation

Create a Job Resource

new Job(name: string, args?: JobArgs, opts?: CustomResourceOptions);

def Job(resource_name, opts=None, app_engine_http_target=None, attempt_deadline=None, description=None, http_target=None, name=None, project=None, pubsub_target=None, region=None, retry_config=None, schedule=None, time_zone=None, __props__=None);

func NewJob(ctx *Context, name string, args *JobArgs, opts ...ResourceOption) (*Job, error)

public Job(string name, JobArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Job Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Job resource accepts the following input properties:

AppEngineHttpTarget JobAppEngineHttpTargetArgs: App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
AttemptDeadline string: The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”
Description string: A human-readable description for the job. This string must not contain more than 500 characters.
HttpTarget JobHttpTargetArgs: HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.
Name string: The name of the job.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PubsubTarget JobPubsubTargetArgs: Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
Region string: Region where the scheduler job resides
RetryConfig JobRetryConfigArgs: By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
Schedule string: Describes the schedule on which the job will be executed.
TimeZone 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.

AppEngineHttpTarget JobAppEngineHttpTarget: App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
AttemptDeadline string: The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”
Description string: A human-readable description for the job. This string must not contain more than 500 characters.
HttpTarget JobHttpTarget: HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.
Name string: The name of the job.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PubsubTarget JobPubsubTarget: Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
Region string: Region where the scheduler job resides
RetryConfig JobRetryConfig: By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
Schedule string: Describes the schedule on which the job will be executed.
TimeZone 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.

appEngineHttpTarget JobAppEngineHttpTarget: App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
attemptDeadline string: The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”
description string: A human-readable description for the job. This string must not contain more than 500 characters.
httpTarget JobHttpTarget: HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.
name string: The name of the job.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pubsubTarget JobPubsubTarget: Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
region string: Region where the scheduler job resides
retryConfig JobRetryConfig: By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
schedule string: Describes the schedule on which the job will be executed.
timeZone 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.

app_engine_http_target Dict[JobAppEngineHttpTarget]: App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
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 allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”
description str: A human-readable description for the job. This string must not contain more than 500 characters.
http_target Dict[JobHttpTarget]: HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.
name str: The name of the job.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pubsub_target Dict[JobPubsubTarget]: Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
region str: Region where the scheduler job resides
retry_config Dict[JobRetryConfig]: By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
schedule str: Describes the schedule on which the job will be executed.
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.

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.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Job Resource

Get an existing Job resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: JobState, opts?: CustomResourceOptions): Job

static get(resource_name, id, opts=None, app_engine_http_target=None, attempt_deadline=None, description=None, http_target=None, name=None, project=None, pubsub_target=None, region=None, retry_config=None, schedule=None, time_zone=None, __props__=None);

func GetJob(ctx *Context, name string, id IDInput, state *JobState, opts ...ResourceOption) (*Job, error)

public static Job Get(string name, Input<string> id, JobState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AppEngineHttpTarget JobAppEngineHttpTargetArgs: App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
AttemptDeadline string: The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”
Description string: A human-readable description for the job. This string must not contain more than 500 characters.
HttpTarget JobHttpTargetArgs: HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.
Name string: The name of the job.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PubsubTarget JobPubsubTargetArgs: Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
Region string: Region where the scheduler job resides
RetryConfig JobRetryConfigArgs: By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
Schedule string: Describes the schedule on which the job will be executed.
TimeZone 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.

AppEngineHttpTarget JobAppEngineHttpTarget: App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
AttemptDeadline string: The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”
Description string: A human-readable description for the job. This string must not contain more than 500 characters.
HttpTarget JobHttpTarget: HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.
Name string: The name of the job.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PubsubTarget JobPubsubTarget: Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
Region string: Region where the scheduler job resides
RetryConfig JobRetryConfig: By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
Schedule string: Describes the schedule on which the job will be executed.
TimeZone 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.

appEngineHttpTarget JobAppEngineHttpTarget: App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
attemptDeadline string: The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”
description string: A human-readable description for the job. This string must not contain more than 500 characters.
httpTarget JobHttpTarget: HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.
name string: The name of the job.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pubsubTarget JobPubsubTarget: Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
region string: Region where the scheduler job resides
retryConfig JobRetryConfig: By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
schedule string: Describes the schedule on which the job will be executed.
timeZone 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.

app_engine_http_target Dict[JobAppEngineHttpTarget]: App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
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 allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”
description str: A human-readable description for the job. This string must not contain more than 500 characters.
http_target Dict[JobHttpTarget]: HTTP target. If the job providers a http_target the cron will send a request to the targeted url Structure is documented below.
name str: The name of the job.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pubsub_target Dict[JobPubsubTarget]: Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
region str: Region where the scheduler job resides
retry_config Dict[JobRetryConfig]: By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
schedule str: Describes the schedule on which the job will be executed.
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.

Supporting Types

JobAppEngineHttpTarget

See the input and output API doc for this type.

RelativeUri 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 JobAppEngineHttpTargetAppEngineRoutingArgs: App Engine Routing setting for the job. Structure is documented below.
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>: This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
HttpMethod string: Which HTTP method to use for the request.

RelativeUri 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 JobAppEngineHttpTargetAppEngineRouting: App Engine Routing setting for the job. Structure is documented below.
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: This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
HttpMethod string: Which HTTP method to use for the request.

relativeUri 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 JobAppEngineHttpTargetAppEngineRouting: App Engine Routing setting for the job. Structure is documented below.
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}: This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
httpMethod string: Which HTTP method to use for the request.

relativeUri 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
appEngineRouting Dict[JobAppEngineHttpTargetAppEngineRouting]: App Engine Routing setting for the job. Structure is documented below.
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 Dict[str, str]: This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
httpMethod str: Which HTTP method to use for the request.

JobAppEngineHttpTargetAppEngineRouting

See the input and output API doc for this type.

Instance string: App instance. By default, the job is sent to an instance which is available when the job is attempted.
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.
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.
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.
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.

JobHttpTarget

See the input and output API doc for this type.

Uri string: The full URI path that the request will be sent to.
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>: This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
HttpMethod string: Which HTTP method to use for the request.
OauthToken JobHttpTargetOauthTokenArgs: Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below.
OidcToken JobHttpTargetOidcTokenArgs: Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below.

Uri string: The full URI path that the request will be sent to.
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: This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
HttpMethod string: Which HTTP method to use for the request.
OauthToken JobHttpTargetOauthToken: Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below.
OidcToken JobHttpTargetOidcToken: Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below.

uri string: The full URI path that the request will be sent to.
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}: This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
httpMethod string: Which HTTP method to use for the request.
oauthToken JobHttpTargetOauthToken: Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below.
oidcToken JobHttpTargetOidcToken: Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below.

uri str: The full URI path that the request will be sent to.
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 Dict[str, str]: This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.
httpMethod str: Which HTTP method to use for the request.
oauthToken Dict[JobHttpTargetOauthToken]: Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below.
oidcToken Dict[JobHttpTargetOidcToken]: Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below.

JobHttpTargetOauthToken

See the input and output API doc for this type.

ServiceAccountEmail string: Service account email to be used for generating OAuth token. The service account must be within the same project as the job.
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.

ServiceAccountEmail string: Service account email to be used for generating OAuth token. The service account must be within the same project as the job.
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.

serviceAccountEmail string: Service account email to be used for generating OAuth token. The service account must be within the same project as the job.
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_email str: Service account email to be used for generating OAuth token. The service account must be within the same project as the job.
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.

JobHttpTargetOidcToken

See the input and output API doc for this type.

ServiceAccountEmail string: Service account email to be used for generating OAuth token. The service account must be within the same project as the job.
Audience string: Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

ServiceAccountEmail string: Service account email to be used for generating OAuth token. The service account must be within the same project as the job.
Audience string: Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

serviceAccountEmail string: Service account email to be used for generating OAuth token. The service account must be within the same project as the job.
audience string: Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

service_account_email str: Service account email to be used for generating OAuth token. The service account must be within the same project as the job.
audience str: Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

JobPubsubTarget

See the input and output API doc for this type.

TopicName string: The full resource name for the Cloud Pub/Sub topic to which messages will be published when a job is delivered. ~>NOTE: The topic name must be in the same format as required by PubSub’s PublishRequest.name, e.g. projects/my-project/topics/my-topic.
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.

TopicName string: The full resource name for the Cloud Pub/Sub topic to which messages will be published when a job is delivered. ~>NOTE: The topic name must be in the same format as required by PubSub’s PublishRequest.name, e.g. projects/my-project/topics/my-topic.
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.

topicName string: The full resource name for the Cloud Pub/Sub topic to which messages will be published when a job is delivered. ~>NOTE: The topic name must be in the same format as required by PubSub’s PublishRequest.name, e.g. projects/my-project/topics/my-topic.
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.

topicName str: The full resource name for the Cloud Pub/Sub topic to which messages will be published when a job is delivered. ~>NOTE: The topic name must be in the same format as required by PubSub’s PublishRequest.name, e.g. projects/my-project/topics/my-topic.
attributes Dict[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.

JobRetryConfig

See the input and output API doc for this type.

MaxBackoffDuration string: The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.
MaxDoublings int: The time between retries will double maxDoublings times. A job’s retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times.
MaxRetryDuration string: The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by ’s’.
MinBackoffDuration string: The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.
RetryCount int: The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed.

MaxBackoffDuration string: The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.
MaxDoublings int: The time between retries will double maxDoublings times. A job’s retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times.
MaxRetryDuration string: The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by ’s’.
MinBackoffDuration string: The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.
RetryCount int: The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed.

maxBackoffDuration string: The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.
maxDoublings number: The time between retries will double maxDoublings times. A job’s retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times.
maxRetryDuration string: The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by ’s’.
minBackoffDuration string: The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.
retryCount number: The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed.

maxBackoffDuration str: The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.
maxDoublings float: The time between retries will double maxDoublings times. A job’s retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times.
maxRetryDuration str: The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by ’s’.
minBackoffDuration str: The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.
retryCount float: The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Job

Create a Job Resource

Job Resource Properties

Inputs

Outputs

Look up an Existing Job Resource

Supporting Types

JobAppEngineHttpTarget

JobAppEngineHttpTargetAppEngineRouting

JobHttpTarget

JobHttpTargetOauthToken

JobHttpTargetOidcToken

JobPubsubTarget

JobRetryConfig

Package Details

On This Page