Class JobStepInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.sql.fluent.models.JobStepInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class JobStepInner extends com.azure.core.management.ProxyResource
A job step.

  • Constructor Details

    • JobStepInner

      public JobStepInner()
      Creates an instance of JobStepInner class.

  • Method Details

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.

    • stepId

      public Integer stepId()
      Get the stepId property: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
      Returns:
      the stepId value.

    • withStepId

      public JobStepInner withStepId(Integer stepId)
      Set the stepId property: The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
      Parameters:
      stepId - the stepId value to set.
      Returns:
      the JobStepInner object itself.

    • targetGroup

      public String targetGroup()
      Get the targetGroup property: The resource ID of the target group that the job step will be executed on.
      Returns:
      the targetGroup value.

    • withTargetGroup

      public JobStepInner withTargetGroup(String targetGroup)
      Set the targetGroup property: The resource ID of the target group that the job step will be executed on.
      Parameters:
      targetGroup - the targetGroup value to set.
      Returns:
      the JobStepInner object itself.

    • credential

      public String credential()
      Get the credential property: The resource ID of the job credential that will be used to connect to the targets.
      Returns:
      the credential value.

    • withCredential

      public JobStepInner withCredential(String credential)
      Set the credential property: The resource ID of the job credential that will be used to connect to the targets.
      Parameters:
      credential - the credential value to set.
      Returns:
      the JobStepInner object itself.

    • action

      public JobStepAction action()
      Get the action property: The action payload of the job step.
      Returns:
      the action value.

    • withAction

      public JobStepInner withAction(JobStepAction action)
      Set the action property: The action payload of the job step.
      Parameters:
      action - the action value to set.
      Returns:
      the JobStepInner object itself.

    • output

      public JobStepOutput output()
      Get the output property: Output destination properties of the job step.
      Returns:
      the output value.

    • withOutput

      public JobStepInner withOutput(JobStepOutput output)
      Set the output property: Output destination properties of the job step.
      Parameters:
      output - the output value to set.
      Returns:
      the JobStepInner object itself.

    • executionOptions

      public JobStepExecutionOptions executionOptions()
      Get the executionOptions property: Execution options for the job step.
      Returns:
      the executionOptions value.

    • withExecutionOptions

      public JobStepInner withExecutionOptions(JobStepExecutionOptions executionOptions)
      Set the executionOptions property: Execution options for the job step.
      Parameters:
      executionOptions - the executionOptions value to set.
      Returns:
      the JobStepInner 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<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.ProxyResource
      Throws:
      IOException

    • fromJson

      public static JobStepInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of JobStepInner from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of JobStepInner 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 JobStepInner.