Package version:

Interface FlinkJobProperties

Properties of flink job.

interface FlinkJobProperties {
    action?: string;
    actionResult?: string;
    args?: string;
    entryClass?: string;
    flinkConfiguration?: {
        [propertyName: string]: string;
    };
    jarName?: string;
    jobId?: string;
    jobJarDirectory?: string;
    jobName?: string;
    jobOutput?: string;
    jobType: "FlinkJob";
    lastSavePoint?: string;
    runId?: string;
    savePointName?: string;
    status?: string;
}

Hierarchy (view full)

Properties

action? actionResult? args? entryClass? flinkConfiguration? jarName? jobId? jobJarDirectory? jobName? jobOutput? jobType lastSavePoint? runId? savePointName? status?

Properties

Optionalaction

action?: string

A string property that indicates the action to be performed on the Flink job. It can have one of the following enum values => NEW, UPDATE, STATELESS_UPDATE, STOP, START, CANCEL, SAVEPOINT, LIST_SAVEPOINT, or DELETE.

Optional ReadonlyactionResult

actionResult?: string

Action result of job. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalargs

args?: string

A string property representing additional JVM arguments for the Flink job. It should be space separated value.

OptionalentryClass

entryClass?: string

A string property that specifies the entry class for the Flink job.

OptionalflinkConfiguration

flinkConfiguration?: {
    [propertyName: string]: string;
}

Additional properties used to configure Flink jobs. It allows users to set properties such as parallelism and jobSavePointDirectory. It accepts additional key-value pairs as properties, where the keys are strings and the values are strings as well.

OptionaljarName

jarName?: string

A string property that represents the name of the job JAR.

Optional ReadonlyjobId

jobId?: string

Unique id for identifying a job NOTE: This property will not be serialized. It can only be populated by the server.

OptionaljobJarDirectory

jobJarDirectory?: string

A string property that specifies the directory where the job JAR is located.

OptionaljobName

jobName?: string

Name of job

Optional ReadonlyjobOutput

jobOutput?: string

Output of job. NOTE: This property will not be serialized. It can only be populated by the server.

jobType

jobType: "FlinkJob"

Polymorphic discriminator, which specifies the different types this object can be

Optional ReadonlylastSavePoint

lastSavePoint?: string

The last savepoint. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalrunId

runId?: string

Run id of job

OptionalsavePointName

savePointName?: string

A string property that represents the name of the savepoint for the Flink job

Optional Readonlystatus

status?: string

Status of job. NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility