Job

• Implements: IJob

This class encapsulates and extends the ROS resource type ALIYUN::SchedulerX::Job.

Initializers

import com.aliyun.ros.cdk.schedulerx.Job;
Job.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .executeMode(java.lang.String)
    .executeMode(IResolvable)
    .groupId(java.lang.String)
    .groupId(IResolvable)
    .jobType(java.lang.String)
    .jobType(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
    .namespace(java.lang.String)
    .namespace(IResolvable)
    .timeType(java.lang.Number)
    .timeType(IResolvable)
//  .attemptInterval(java.lang.Number)
//  .attemptInterval(IResolvable)
//  .calendar(java.lang.String)
//  .calendar(IResolvable)
//  .className(java.lang.String)
//  .className(IResolvable)
//  .consumerSize(java.lang.Number)
//  .consumerSize(IResolvable)
//  .contactInfo(IResolvable)
//  .contactInfo(java.util.List<IResolvable)
//  .contactInfo(ContactInfoProperty>)
//  .content(java.lang.String)
//  .content(IResolvable)
//  .dataOffset(java.lang.Number)
//  .dataOffset(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .dispatcherSize(java.lang.Number)
//  .dispatcherSize(IResolvable)
//  .failEnable(java.lang.Boolean)
//  .failEnable(IResolvable)
//  .failTimes(java.lang.Number)
//  .failTimes(IResolvable)
//  .maxAttempt(java.lang.Number)
//  .maxAttempt(IResolvable)
//  .maxConcurrency(java.lang.Number)
//  .maxConcurrency(IResolvable)
//  .missWorkerEnable(java.lang.Boolean)
//  .missWorkerEnable(IResolvable)
//  .namespaceSource(java.lang.String)
//  .namespaceSource(IResolvable)
//  .pageSize(java.lang.Number)
//  .pageSize(IResolvable)
//  .parameters(java.lang.String)
//  .parameters(IResolvable)
//  .priority(java.lang.Number)
//  .priority(IResolvable)
//  .queueSize(java.lang.Number)
//  .queueSize(IResolvable)
//  .sendChannel(java.lang.String)
//  .sendChannel(IResolvable)
//  .successNoticeEnable(java.lang.Boolean)
//  .successNoticeEnable(IResolvable)
//  .taskAttemptInterval(java.lang.Number)
//  .taskAttemptInterval(IResolvable)
//  .taskMaxAttempt(java.lang.Number)
//  .taskMaxAttempt(IResolvable)
//  .timeExpression(java.lang.String)
//  .timeExpression(IResolvable)
//  .timeout(java.lang.Number)
//  .timeout(IResolvable)
//  .timeoutEnable(java.lang.Boolean)
//  .timeoutEnable(IResolvable)
//  .timeoutKillEnable(java.lang.Boolean)
//  .timeoutKillEnable(IResolvable)
//  .timezone(java.lang.String)
//  .timezone(IResolvable)
//  .xAttrs(IResolvable)
//  .xAttrs(java.util.Map<java.lang.String, java.lang.Object>)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

executeMode^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property executeMode: The execute mode of the job.

groupId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property groupId: The group ID of the job.

jobType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property jobType: The type of the job.

name^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property name: The name of the job.

namespace^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property namespace: The namespace of the job.

timeType^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property timeType: The time type of the job.

cron：1 fixed_rate：3 second_delay：4 one_time ：5 api：100 none：-1

attemptInterval^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property attemptInterval: The retry interval for a failed job, in seconds.

Defaults to 30.

calendar^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property calendar: For a cron job, you can specify a custom calendar.

className^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property className: The fully qualified class name of the job interface.

Required for java jobs.

consumerSize^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property consumerSize: [Advanced] For parallel and grid jobs, this specifies the number of consumer threads per machine for processing subtasks.

Defaults to 5.

contactInfo^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListContactInfoProperty>

Property contactInfo: The contact information for the job.

This parameter is deprecated.

content^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property content: - For a python, shell, or k8s job, this parameter specifies the script content.

• For a go job, the content must be in the following format: {"jobName":"HelloWorld"}

dataOffset^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property dataOffset: The time offset in seconds for a cron job.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the job.

dispatcherSize^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property dispatcherSize: [Advanced] For parallel and grid jobs, this specifies the number of threads for dispatching subtasks.

Defaults to 5.

failEnable^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property failEnable: Specifies whether to enable alerts for failed jobs.

Valid values:

• true: Enables failure alerts.
• false: Disables failure alerts.

failTimes^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property failTimes: The number of consecutive failures that triggers an alert.

maxAttempt^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxAttempt: The maximum number of retries for a failed job.

Defaults to 0.

maxConcurrency^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxConcurrency: The maximum number of concurrent job instances.

Defaults to 1. If an existing job instance is still running, a new one will not be triggered, even if its scheduled time has passed.

missWorkerEnable^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property missWorkerEnable: Specifies whether to send an alert when no worker is available to run the job.

• true: Enables the alert.
• false: Disables the alert.

namespaceSource^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property namespaceSource: This parameter is required only for specific third-party integrations.

pageSize^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property pageSize: [Advanced] For parallel and grid jobs, this specifies the number of subtasks retrieved per pull.

Defaults to 100.

parameters^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property parameters: The parameters of the job.

priority^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property priority: The job priority.

Valid values:

• 1: Low
• 5: Medium
• 10: High
• 15: Very High

queueSize^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property queueSize: [Advanced] For parallel and grid jobs, this specifies the maximum number of subtasks the queue can hold.

Defaults to 10000.

sendChannel^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sendChannel: The channel for sending alerts.

• For the default channel of the application group, use default.
• For a specific channel for the job, use sms, mail, phone, or webhook.

successNoticeEnable^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property successNoticeEnable: Whether success notice is enabled for the job.

taskAttemptInterval^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property taskAttemptInterval: [Advanced] For parallel and grid jobs, this specifies the retry interval in seconds for a failed subtask.

Defaults to 0.

taskMaxAttempt^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property taskMaxAttempt: [Advanced] For parallel and grid jobs, this specifies the maximum number of retries for a failed subtask.

Defaults to 0.

timeExpression^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property timeExpression: The time expression, which depends on the value of TimeType.

• cron: A standard cron expression.
• api: No time expression is required.
• fixed_rate: A fixed interval in seconds. For example, a value of 30 triggers the job every 30 seconds.
• second_delay: A fixed delay in seconds before the job is executed. Valid values: 1 to 60.
• one_time: A specific time in yyyy-MM-dd HH:mm:ss format or a Unix timestamp in milliseconds. Example: "2022-10-10 10:10:00".

timeout^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property timeout: The timeout threshold in seconds.

Defaults to 7200.

timeoutEnable^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property timeoutEnable: Specifies whether to enable timeout alerts.

Valid values:

• true: Enables timeout alerts.
• false: Disables timeout alerts.

timeoutKillEnable^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property timeoutKillEnable: Specifies whether to terminate the job upon timeout.

Valid values:

• true: Terminates the job if it times out.
• false: The job is not terminated if it times out.

timezone^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property timezone: The timezone of the job.

xAttrs^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property xAttrs: This parameter is required for k8s jobs.
For job tasks: {"resource":"job"}
For shell tasks: {"image":"busybox","resource":"shell"}

.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.schedulerx.Job;
Job.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrJobId^Required

public java.lang.Object getAttrJobId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute JobId: The ID of the job.

props^Required

public JobProps getProps();

• Type: JobProps