JobStepInner Class

public final class JobStepInner
extends ProxyResource

A job step.

Constructor Summary

Constructor Description
JobStepInner()

Creates an instance of JobStepInner 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.

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.

void validate()

Validates the instance.

JobStepInner withAction(JobStepAction action)

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

JobStepInner withCredential(String credential)

Set the credential property: The resource ID of the job credential that will be used to connect to the targets.

JobStepInner withExecutionOptions(JobStepExecutionOptions executionOptions)

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

JobStepInner withOutput(JobStepOutput output)

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

JobStepInner withStepId(Integer stepId)

Set the stepId property: The job step's index within the job.

JobStepInner 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 ProxyResource

Methods inherited from java.lang.Object

Constructor Details

JobStepInner

public JobStepInner()

Creates an instance of JobStepInner 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.

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.

validate

public void validate()

Validates the instance.

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.

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.

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.

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.

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.

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.

Applies to