Class Job

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

Inheritance
object
Job
Implements
Inherited Members
Namespace: Google.Apis.CloudScheduler.v1beta1.Data
Assembly: Google.Apis.CloudScheduler.v1beta1.dll
Syntax
public class Job : IDirectResponseSchema

Properties

AppEngineHttpTarget

App Engine HTTP target.

Declaration
[JsonProperty("appEngineHttpTarget")]
public virtual AppEngineHttpTarget AppEngineHttpTarget { get; set; }
Property Value
Type Description
AppEngineHttpTarget

AttemptDeadline

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.

Declaration
[JsonProperty("attemptDeadline")]
public virtual object AttemptDeadline { get; set; }
Property Value
Type Description
object

Description

Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

HttpTarget

HTTP target.

Declaration
[JsonProperty("httpTarget")]
public virtual HttpTarget HttpTarget { get; set; }
Property Value
Type Description
HttpTarget

LastAttemptTime

object representation of LastAttemptTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastAttemptTimeDateTimeOffset instead.")]
public virtual object LastAttemptTime { get; set; }
Property Value
Type Description
object

LastAttemptTimeDateTimeOffset

DateTimeOffset representation of LastAttemptTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastAttemptTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

LastAttemptTimeRaw

Output only. The time the last job attempt started.

Declaration
[JsonProperty("lastAttemptTime")]
public virtual string LastAttemptTimeRaw { get; set; }
Property Value
Type Description
string

LegacyAppEngineCron

Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.

Declaration
[JsonProperty("legacyAppEngineCron")]
public virtual bool? LegacyAppEngineCron { get; set; }
Property Value
Type Description
bool?

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PubsubTarget

Pub/Sub target.

Declaration
[JsonProperty("pubsubTarget")]
public virtual PubsubTarget PubsubTarget { get; set; }
Property Value
Type Description
PubsubTarget

RetryConfig

Settings that determine the retry behavior.

Declaration
[JsonProperty("retryConfig")]
public virtual RetryConfig RetryConfig { get; set; }
Property Value
Type Description
RetryConfig

Schedule

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

Declaration
[JsonProperty("schedule")]
public virtual string Schedule { get; set; }
Property Value
Type Description
string

ScheduleTime

object representation of ScheduleTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ScheduleTimeDateTimeOffset instead.")]
public virtual object ScheduleTime { get; set; }
Property Value
Type Description
object

ScheduleTimeDateTimeOffset

DateTimeOffset representation of ScheduleTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ScheduleTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ScheduleTimeRaw

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.

Declaration
[JsonProperty("scheduleTime")]
public virtual string ScheduleTimeRaw { get; set; }
Property Value
Type Description
string

State

Output only. State of the job.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Status

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

Declaration
[JsonProperty("status")]
public virtual Status Status { get; set; }
Property Value
Type Description
Status

TimeZone

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).

Declaration
[JsonProperty("timeZone")]
public virtual string TimeZone { get; set; }
Property Value
Type Description
string

UserUpdateTime

object representation of UserUpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UserUpdateTimeDateTimeOffset instead.")]
public virtual object UserUpdateTime { get; set; }
Property Value
Type Description
object

UserUpdateTimeDateTimeOffset

DateTimeOffset representation of UserUpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UserUpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UserUpdateTimeRaw

Output only. The creation time of the job.

Declaration
[JsonProperty("userUpdateTime")]
public virtual string UserUpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements