Class FlinkJobProfile

java.lang.Object
com.azure.resourcemanager.hdinsight.containers.models.FlinkJobProfile
All Implemented Interfaces:
com.azure.json.JsonSerializable<FlinkJobProfile>
public final class FlinkJobProfile extends Object implements com.azure.json.JsonSerializable<FlinkJobProfile>
Job specifications for flink clusters in application deployment mode. The specification is immutable even if job properties are changed by calling the RunJob API, please use the ListJob API to get the latest job information.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlinkJobProfile()
    Creates an instance of FlinkJobProfile class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    args()
    Get the args property: A string property representing additional JVM arguments for the Flink job.
    String
    entryClass()
    Get the entryClass property: A string property that specifies the entry class for the Flink job.
    static FlinkJobProfile
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of FlinkJobProfile from the JsonReader.
    String
    jarName()
    Get the jarName property: A string property that represents the name of the job JAR.
    String
    jobJarDirectory()
    Get the jobJarDirectory property: A string property that specifies the directory where the job JAR is located.
    String
    savePointName()
    Get the savePointName property: A string property that represents the name of the savepoint for the Flink job.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    UpgradeMode
    upgradeMode()
    Get the upgradeMode property: A string property that indicates the upgrade mode to be performed on the Flink job.
    void
    validate()
    Validates the instance.
    FlinkJobProfile
    withArgs(String args)
    Set the args property: A string property representing additional JVM arguments for the Flink job.
    FlinkJobProfile
    withEntryClass(String entryClass)
    Set the entryClass property: A string property that specifies the entry class for the Flink job.
    FlinkJobProfile
    withJarName(String jarName)
    Set the jarName property: A string property that represents the name of the job JAR.
    FlinkJobProfile
    withJobJarDirectory(String jobJarDirectory)
    Set the jobJarDirectory property: A string property that specifies the directory where the job JAR is located.
    FlinkJobProfile
    withSavePointName(String savePointName)
    Set the savePointName property: A string property that represents the name of the savepoint for the Flink job.
    FlinkJobProfile
    withUpgradeMode(UpgradeMode upgradeMode)
    Set the upgradeMode property: A string property that indicates the upgrade mode to be performed on the Flink job.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • FlinkJobProfile

      public FlinkJobProfile()
      Creates an instance of FlinkJobProfile class.

  • Method Details

    • 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 FlinkJobProfile 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 FlinkJobProfile 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 FlinkJobProfile 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 FlinkJobProfile object itself.

    • entryClass

      public String entryClass()
      Get the entryClass property: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package.
      Returns:
      the entryClass value.

    • withEntryClass

      public FlinkJobProfile withEntryClass(String entryClass)
      Set the entryClass property: A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package.
      Parameters:
      entryClass - the entryClass value to set.
      Returns:
      the FlinkJobProfile 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 FlinkJobProfile 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 FlinkJobProfile 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 FlinkJobProfile 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 FlinkJobProfile object itself.

    • upgradeMode

      public UpgradeMode upgradeMode()
      Get the upgradeMode property: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE.
      Returns:
      the upgradeMode value.

    • withUpgradeMode

      public FlinkJobProfile withUpgradeMode(UpgradeMode upgradeMode)
      Set the upgradeMode property: A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE.
      Parameters:
      upgradeMode - the upgradeMode value to set.
      Returns:
      the FlinkJobProfile object itself.

    • validate

      public void validate()
      Validates the instance.
      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<FlinkJobProfile>
      Throws:
      IOException

    • fromJson

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