Class FlinkJobProperties

java.lang.Object
com.azure.resourcemanager.hdinsight.containers.models.ClusterJobProperties
com.azure.resourcemanager.hdinsight.containers.models.FlinkJobProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ClusterJobProperties>
public final class FlinkJobProperties extends ClusterJobProperties
Properties of flink job.

  • Constructor Details

    • FlinkJobProperties

      public FlinkJobProperties()
      Creates an instance of FlinkJobProperties class.

  • Method Details

    • jobType

      public JobType jobType()
      Get the jobType property: Type of cluster job.
      Overrides:
      jobType in class ClusterJobProperties
      Returns:
      the jobType value.

    • runId

      public String runId()
      Get the runId property: Run id of job.
      Returns:
      the runId value.

    • withRunId

      public FlinkJobProperties withRunId(String runId)
      Set the runId property: Run id of job.
      Parameters:
      runId - the runId value to set.
      Returns:
      the FlinkJobProperties object itself.

    • jobName

      public String jobName()
      Get the jobName property: Name of job.
      Returns:
      the jobName value.

    • withJobName

      public FlinkJobProperties withJobName(String jobName)
      Set the jobName property: Name of job.
      Parameters:
      jobName - the jobName value to set.
      Returns:
      the FlinkJobProperties object itself.

    • jobJarDirectory

      public String jobJarDirectory()
      Get the jobJarDirectory property: A string property that specifies the directory where the job JAR is located.
      Returns:
      the jobJarDirectory value.

    • withJobJarDirectory

      public FlinkJobProperties withJobJarDirectory(String jobJarDirectory)
      Set the jobJarDirectory property: A string property that specifies the directory where the job JAR is located.
      Parameters:
      jobJarDirectory - the jobJarDirectory value to set.
      Returns:
      the FlinkJobProperties object itself.

    • jarName

      public String jarName()
      Get the jarName property: A string property that represents the name of the job JAR.
      Returns:
      the jarName value.

    • withJarName

      public FlinkJobProperties withJarName(String jarName)
      Set the jarName property: A string property that represents the name of the job JAR.
      Parameters:
      jarName - the jarName value to set.
      Returns:
      the FlinkJobProperties object itself.

    • entryClass

      public String entryClass()
      Get the entryClass property: A string property that specifies the entry class for the Flink job.
      Returns:
      the entryClass value.

    • withEntryClass

      public FlinkJobProperties withEntryClass(String entryClass)
      Set the entryClass property: A string property that specifies the entry class for the Flink job.
      Parameters:
      entryClass - the entryClass value to set.
      Returns:
      the FlinkJobProperties object itself.

    • args

      public String args()
      Get the args property: A string property representing additional JVM arguments for the Flink job. It should be space separated value.
      Returns:
      the args value.

    • withArgs

      public FlinkJobProperties withArgs(String args)
      Set the args property: A string property representing additional JVM arguments for the Flink job. It should be space separated value.
      Parameters:
      args - the args value to set.
      Returns:
      the FlinkJobProperties object itself.

    • savePointName

      public String savePointName()
      Get the savePointName property: A string property that represents the name of the savepoint for the Flink job.
      Returns:
      the savePointName value.

    • withSavePointName

      public FlinkJobProperties withSavePointName(String savePointName)
      Set the savePointName property: A string property that represents the name of the savepoint for the Flink job.
      Parameters:
      savePointName - the savePointName value to set.
      Returns:
      the FlinkJobProperties object itself.

    • action

      public Action action()
      Get the action property: 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.
      Returns:
      the action value.

    • withAction

      public FlinkJobProperties withAction(Action action)
      Set the action property: 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.
      Parameters:
      action - the action value to set.
      Returns:
      the FlinkJobProperties object itself.

    • flinkConfiguration

      public Map<String,String> flinkConfiguration()
      Get the flinkConfiguration property: 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.
      Returns:
      the flinkConfiguration value.

    • withFlinkConfiguration

      public FlinkJobProperties withFlinkConfiguration(Map<String,String> flinkConfiguration)
      Set the flinkConfiguration property: 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.
      Parameters:
      flinkConfiguration - the flinkConfiguration value to set.
      Returns:
      the FlinkJobProperties object itself.

    • jobId

      public String jobId()
      Get the jobId property: Unique id for identifying a job.
      Returns:
      the jobId value.

    • status

      public String status()
      Get the status property: Status of job.
      Returns:
      the status value.

    • jobOutput

      public String jobOutput()
      Get the jobOutput property: Output of job.
      Returns:
      the jobOutput value.

    • actionResult

      public String actionResult()
      Get the actionResult property: Action result of job.
      Returns:
      the actionResult value.

    • lastSavePoint

      public String lastSavePoint()
      Get the lastSavePoint property: The last savepoint.
      Returns:
      the lastSavePoint value.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ClusterJobProperties
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ClusterJobProperties>
      Overrides:
      toJson in class ClusterJobProperties
      Throws:
      IOException

    • fromJson

      public static FlinkJobProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of FlinkJobProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of FlinkJobProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the FlinkJobProperties.