JobStepExecutionsClient Interface

public interface JobStepExecutionsClient

An instance of this class provides access to all the operations defined in JobStepExecutionsClient.

Method Summary

Modifier and Type Method and Description
abstract JobExecutionInner get(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, String stepName)

Gets a step execution of a job execution.

abstract Mono<JobExecutionInner> getAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, String stepName)

Gets a step execution of a job execution.

abstract Response<JobExecutionInner> getWithResponse(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, String stepName, Context context)

Gets a step execution of a job execution.

abstract Mono<Response<JobExecutionInner>> getWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, String stepName)

Gets a step execution of a job execution.

abstract PagedIterable<JobExecutionInner> listByJobExecution(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Lists the step executions of a job execution.

abstract PagedIterable<JobExecutionInner> listByJobExecution(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, OffsetDateTime createTimeMin, OffsetDateTime createTimeMax, OffsetDateTime endTimeMin, OffsetDateTime endTimeMax, Boolean isActive, Long skip, Long top, Context context)

Lists the step executions of a job execution.

abstract PagedFlux<JobExecutionInner> listByJobExecutionAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Lists the step executions of a job execution.

abstract PagedFlux<JobExecutionInner> listByJobExecutionAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, OffsetDateTime createTimeMin, OffsetDateTime createTimeMax, OffsetDateTime endTimeMin, OffsetDateTime endTimeMax, Boolean isActive, Long skip, Long top)

Lists the step executions of a job execution.

Method Details

get

public abstract JobExecutionInner get(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, String stepName)

Gets a step execution of a job execution.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName - The name of the server.
jobAgentName - The name of the job agent.
jobName - The name of the job to get.
jobExecutionId - The unique id of the job execution.
stepName - The name of the step.

Returns:

a step execution of a job execution.

getAsync

public abstract Mono getAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, String stepName)

Gets a step execution of a job execution.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName - The name of the server.
jobAgentName - The name of the job agent.
jobName - The name of the job to get.
jobExecutionId - The unique id of the job execution.
stepName - The name of the step.

Returns:

a step execution of a job execution on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, String stepName, Context context)

Gets a step execution of a job execution.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName - The name of the server.
jobAgentName - The name of the job agent.
jobName - The name of the job to get.
jobExecutionId - The unique id of the job execution.
stepName - The name of the step.
context - The context to associate with this operation.

Returns:

a step execution of a job execution along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, String stepName)

Gets a step execution of a job execution.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName - The name of the server.
jobAgentName - The name of the job agent.
jobName - The name of the job to get.
jobExecutionId - The unique id of the job execution.
stepName - The name of the step.

Returns:

a step execution of a job execution along with Response<T> on successful completion of Mono.

listByJobExecution

public abstract PagedIterable listByJobExecution(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Lists the step executions of a job execution.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName - The name of the server.
jobAgentName - The name of the job agent.
jobName - The name of the job to get.
jobExecutionId - The id of the job execution.

Returns:

a list of job executions as paginated response with PagedIterable<T>.

listByJobExecution

public abstract PagedIterable listByJobExecution(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, OffsetDateTime createTimeMin, OffsetDateTime createTimeMax, OffsetDateTime endTimeMin, OffsetDateTime endTimeMax, Boolean isActive, Long skip, Long top, Context context)

Lists the step executions of a job execution.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName - The name of the server.
jobAgentName - The name of the job agent.
jobName - The name of the job to get.
jobExecutionId - The id of the job execution.
createTimeMin - If specified, only job executions created at or after the specified time are included.
createTimeMax - If specified, only job executions created before the specified time are included.
endTimeMin - If specified, only job executions completed at or after the specified time are included.
endTimeMax - If specified, only job executions completed before the specified time are included.
isActive - If specified, only active or only completed job executions are included.
skip - The number of elements in the collection to skip.
top - The number of elements to return from the collection.
context - The context to associate with this operation.

Returns:

a list of job executions as paginated response with PagedIterable<T>.

listByJobExecutionAsync

public abstract PagedFlux listByJobExecutionAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Lists the step executions of a job execution.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName - The name of the server.
jobAgentName - The name of the job agent.
jobName - The name of the job to get.
jobExecutionId - The id of the job execution.

Returns:

a list of job executions as paginated response with PagedFlux<T>.

listByJobExecutionAsync

public abstract PagedFlux listByJobExecutionAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, OffsetDateTime createTimeMin, OffsetDateTime createTimeMax, OffsetDateTime endTimeMin, OffsetDateTime endTimeMax, Boolean isActive, Long skip, Long top)

Lists the step executions of a job execution.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName - The name of the server.
jobAgentName - The name of the job agent.
jobName - The name of the job to get.
jobExecutionId - The id of the job execution.
createTimeMin - If specified, only job executions created at or after the specified time are included.
createTimeMax - If specified, only job executions created before the specified time are included.
endTimeMin - If specified, only job executions completed at or after the specified time are included.
endTimeMax - If specified, only job executions completed before the specified time are included.
isActive - If specified, only active or only completed job executions are included.
skip - The number of elements in the collection to skip.
top - The number of elements to return from the collection.

Returns:

a list of job executions as paginated response with PagedFlux<T>.

Applies to