Google Cloud Scheduler v1 API - Class Job (3.5.0) 

public sealed class Job : IMessage<Job>, IEquatable<Job>, IDeepCloneable<Job>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Scheduler v1 API class Job.

Configuration for a job. The maximum allowed size for a job is 1MB.

Inheritance

object > Job

Namespace

Google.Cloud.Scheduler.V1

Assembly

Google.Cloud.Scheduler.V1.dll

Constructors

Job()

public Job()

Job(Job)

public Job(Job other)
Parameter
Name Description
other Job

Properties

AppEngineHttpTarget

public AppEngineHttpTarget AppEngineHttpTarget { get; set; }

App Engine HTTP target.

Property Value
Type Description
AppEngineHttpTarget

AttemptDeadline

public Duration AttemptDeadline { get; set; }

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][google.cloud.scheduler.v1.RetryConfig].

The default and the allowed values depend on the type of target:

  • For [HTTP targets][google.cloud.scheduler.v1.Job.http_target], the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For [App Engine HTTP targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 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][google.cloud.scheduler.v1.Job.pubsub_target], this field is ignored.

Property Value
Type Description
Duration

Description

public string Description { get; set; }

Optionally caller-specified in [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob] or [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

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

Property Value
Type Description
string

HttpTarget

public HttpTarget HttpTarget { get; set; }

HTTP target.

Property Value
Type Description
HttpTarget

JobName

public JobName JobName { get; set; }

JobName-typed view over the Name resource name property.

Property Value
Type Description
JobName

LastAttemptTime

public Timestamp LastAttemptTime { get; set; }

Output only. The time the last job attempt started.

Property Value
Type Description
Timestamp

Name

public string Name { get; set; }

Optionally caller-specified in [CreateJob][google.cloud.scheduler.v1.CloudScheduler.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][google.cloud.location.Locations.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.
Property Value
Type Description
string

PubsubTarget

public PubsubTarget PubsubTarget { get; set; }

Pub/Sub target.

Property Value
Type Description
PubsubTarget

RetryConfig

public RetryConfig RetryConfig { get; set; }

Settings that determine the retry behavior.

Property Value
Type Description
RetryConfig

Schedule

public string Schedule { get; set; }

Required, except when used with [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob].

Describes the schedule on which the job will be executed.

The schedule can be either of the following types:

As a general rule, execution n + 1 of a job will not begin until execution n has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the n+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th execution will not start until 16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs.

If [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] > 0 and a job attempt fails, the job will be tried a total of [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times, with exponential backoff, until the next scheduled start time.

Property Value
Type Description
string

ScheduleTime

public Timestamp ScheduleTime { get; set; }

Output only. 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.

Property Value
Type Description
Timestamp

State

public Job.Types.State State { get; set; }

Output only. State of the job.

Property Value
Type Description
JobTypesState

Status

public Status Status { get; set; }

Output only. The response from the target for the last attempted execution.

Property Value
Type Description
Status

TargetCase

public Job.TargetOneofCase TargetCase { get; }
Property Value
Type Description
JobTargetOneofCase

TimeZone

public string TimeZone { get; set; }

Specifies the time zone to be used in interpreting [schedule][google.cloud.scheduler.v1.Job.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).

Property Value
Type Description
string

UserUpdateTime

public Timestamp UserUpdateTime { get; set; }

Output only. The creation time of the job.

Property Value
Type Description
Timestamp