JobStepProperties Class

Package:

com.azure.resourcemanager.sql.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-sql:2.53.7

• java.lang.Object
• • com.azure.resourcemanager.sql.fluent.models.JobStepProperties

Implements

JsonSerializable<JobStepProperties>

public final class JobStepProperties
implements JsonSerializable<JobStepProperties>

Properties of a job step.

Constructor Summary

Constructor	Description
JobStepProperties()	Creates an instance of JobStepProperties class.

Method Summary

Modifier and Type	Method and Description
JobStepAction	action() Get the action property: The action payload of the job step.
String	credential() Get the credential property: The resource ID of the job credential that will be used to connect to the targets.
JobStepExecutionOptions	executionOptions() Get the executionOptions property: Execution options for the job step.
static JobStepProperties	fromJson(JsonReader jsonReader) Reads an instance of JobStepProperties from the JsonReader.
JobStepOutput	output() Get the output property: Output destination properties of the job step.
Integer	stepId() Get the stepId property: The job step's index within the job.
String	targetGroup() Get the targetGroup property: The resource ID of the target group that the job step will be executed on.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
JobStepProperties	withAction(JobStepAction action) Set the action property: The action payload of the job step.
JobStepProperties	withCredential(String credential) Set the credential property: The resource ID of the job credential that will be used to connect to the targets.
JobStepProperties	withExecutionOptions(JobStepExecutionOptions executionOptions) Set the executionOptions property: Execution options for the job step.
JobStepProperties	withOutput(JobStepOutput output) Set the output property: Output destination properties of the job step.
JobStepProperties	withStepId(Integer stepId) Set the stepId property: The job step's index within the job.
JobStepProperties	withTargetGroup(String targetGroup) Set the targetGroup property: The resource ID of the target group that the job step will be executed on.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

JobStepProperties

public JobStepProperties()

Creates an instance of JobStepProperties class.

Method Details

action

public JobStepAction action()

Get the action property: The action payload of the job step.

Returns:

the action value.

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.

executionOptions

public JobStepExecutionOptions executionOptions()

Get the executionOptions property: Execution options for the job step.

Returns:

the executionOptions value.

fromJson

public static JobStepProperties fromJson(JsonReader jsonReader)

Reads an instance of JobStepProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of JobStepProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

output

public JobStepOutput output()

Get the output property: Output destination properties of the job step.

Returns:

the output 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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAction

public JobStepProperties withAction(JobStepAction action)

Set the action property: The action payload of the job step.

Parameters:

action - the action value to set.

Returns:

the JobStepProperties object itself.

withCredential

public JobStepProperties 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 JobStepProperties object itself.

withExecutionOptions

public JobStepProperties withExecutionOptions(JobStepExecutionOptions executionOptions)

Set the executionOptions property: Execution options for the job step.

Parameters:

executionOptions - the executionOptions value to set.

Returns:

the JobStepProperties object itself.

withOutput

public JobStepProperties withOutput(JobStepOutput output)

Set the output property: Output destination properties of the job step.

Parameters:

output - the output value to set.

Returns:

the JobStepProperties object itself.

withStepId

public JobStepProperties 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 JobStepProperties object itself.

withTargetGroup

public JobStepProperties 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 JobStepProperties object itself.