Share via

FlinkJobProperties interface

  • Reference
Package:
@azure/arm-hdinsightcontainers

Properties of flink job.

Extends
ClusterJobProperties

Properties

action

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

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

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

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

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

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

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

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

Name of job
jobOutput

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

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

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

Run id of job
savePointName

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

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

Property Details

action

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.

action?: string

Property Value

string

actionResult

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

actionResult?: string

Property Value

string

args

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

args?: string

Property Value

string

entryClass

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

entryClass?: string

Property Value

string

flinkConfiguration

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.

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

Property Value

{[propertyName: string]: string}

jarName

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

jarName?: string

Property Value

string

jobId

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

jobId?: string

Property Value

string

jobJarDirectory

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

jobJarDirectory?: string

Property Value

string

jobName

Name of job

jobName?: string

Property Value

string

jobOutput

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

jobOutput?: string

Property Value

string

jobType

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

jobType: "FlinkJob"

Property Value

"FlinkJob"

lastSavePoint

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

lastSavePoint?: string

Property Value

string

runId

Run id of job

runId?: string

Property Value

string

savePointName

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

savePointName?: string

Property Value

string

status

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

status?: string

Property Value

string