JobExecutionsClient Interface

public interface JobExecutionsClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<JobExecutionInner>,JobExecutionInner> beginCreate(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic job execution.

abstract SyncPoller<PollResult<JobExecutionInner>,JobExecutionInner> beginCreate(String resourceGroupName, String serverName, String jobAgentName, String jobName, Context context)

Starts an elastic job execution.

abstract PollerFlux<PollResult<JobExecutionInner>,JobExecutionInner> beginCreateAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic job execution.

abstract SyncPoller<PollResult<JobExecutionInner>,JobExecutionInner> beginCreateOrUpdate(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Creates or updates a job execution.

abstract SyncPoller<PollResult<JobExecutionInner>,JobExecutionInner> beginCreateOrUpdate(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, Context context)

Creates or updates a job execution.

abstract PollerFlux<PollResult<JobExecutionInner>,JobExecutionInner> beginCreateOrUpdateAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Creates or updates a job execution.

abstract void cancel(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Requests cancellation of a job execution.

abstract Mono<Void> cancelAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Requests cancellation of a job execution.

abstract Response<Void> cancelWithResponse(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, Context context)

Requests cancellation of a job execution.

abstract Mono<Response<Void>> cancelWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Requests cancellation of a job execution.

abstract JobExecutionInner create(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic job execution.

abstract JobExecutionInner create(String resourceGroupName, String serverName, String jobAgentName, String jobName, Context context)

Starts an elastic job execution.

abstract Mono<JobExecutionInner> createAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic job execution.

abstract JobExecutionInner createOrUpdate(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Creates or updates a job execution.

abstract JobExecutionInner createOrUpdate(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, Context context)

Creates or updates a job execution.

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

Creates or updates a job execution.

abstract Mono<Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Creates or updates a job execution.

abstract Mono<Response<Flux<ByteBuffer>>> createWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic job execution.

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

Gets a job execution.

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

Gets a job execution.

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

Gets a job execution.

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

Gets a job execution.

abstract PagedIterable<JobExecutionInner> listByAgent(String resourceGroupName, String serverName, String jobAgentName)

Lists all executions in a job agent.

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

Lists all executions in a job agent.

abstract PagedFlux<JobExecutionInner> listByAgentAsync(String resourceGroupName, String serverName, String jobAgentName)

Lists all executions in a job agent.

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

Lists all executions in a job agent.

abstract PagedIterable<JobExecutionInner> listByJob(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Lists a job's executions.

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

Lists a job's executions.

abstract PagedFlux<JobExecutionInner> listByJobAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Lists a job's executions.

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

Lists a job's executions.

Method Details

beginCreate

public abstract SyncPoller,JobExecutionInner> beginCreate(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic 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.

Returns:

the SyncPoller<T,U> for polling of an execution of a job.

beginCreate

public abstract SyncPoller,JobExecutionInner> beginCreate(String resourceGroupName, String serverName, String jobAgentName, String jobName, Context context)

Starts an elastic 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.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of an execution of a job.

beginCreateAsync

public abstract PollerFlux,JobExecutionInner> beginCreateAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic 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.

Returns:

the PollerFlux<T,U> for polling of an execution of a job.

beginCreateOrUpdate

public abstract SyncPoller,JobExecutionInner> beginCreateOrUpdate(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Creates or updates 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 job execution id to create the job execution under.

Returns:

the SyncPoller<T,U> for polling of an execution of a job.

beginCreateOrUpdate

public abstract SyncPoller,JobExecutionInner> beginCreateOrUpdate(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, Context context)

Creates or updates 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 job execution id to create the job execution under.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of an execution of a job.

beginCreateOrUpdateAsync

public abstract PollerFlux,JobExecutionInner> beginCreateOrUpdateAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Creates or updates 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 job execution id to create the job execution under.

Returns:

the PollerFlux<T,U> for polling of an execution of a job.

cancel

public abstract void cancel(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId)

Requests cancellation 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.
jobExecutionId - The id of the job execution to cancel.

cancelAsync

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

Requests cancellation 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.
jobExecutionId - The id of the job execution to cancel.

Returns:

A Mono that completes when a successful response is received.

cancelWithResponse

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

Requests cancellation 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.
jobExecutionId - The id of the job execution to cancel.
context - The context to associate with this operation.

Returns:

cancelWithResponseAsync

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

Requests cancellation 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.
jobExecutionId - The id of the job execution to cancel.

Returns:

the Response<T> on successful completion of Mono.

create

public abstract JobExecutionInner create(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic 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.

Returns:

an execution of a job.

create

public abstract JobExecutionInner create(String resourceGroupName, String serverName, String jobAgentName, String jobName, Context context)

Starts an elastic 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.
context - The context to associate with this operation.

Returns:

an execution of a job.

createAsync

public abstract Mono createAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic 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.

Returns:

an execution of a job on successful completion of Mono.

createOrUpdate

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

Creates or updates 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 job execution id to create the job execution under.

Returns:

an execution of a job.

createOrUpdate

public abstract JobExecutionInner createOrUpdate(String resourceGroupName, String serverName, String jobAgentName, String jobName, UUID jobExecutionId, Context context)

Creates or updates 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 job execution id to create the job execution under.
context - The context to associate with this operation.

Returns:

an execution of a job.

createOrUpdateAsync

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

Creates or updates 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 job execution id to create the job execution under.

Returns:

an execution of a job on successful completion of Mono.

createOrUpdateWithResponseAsync

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

Creates or updates 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 job execution id to create the job execution under.

Returns:

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

createWithResponseAsync

public abstract Mono>> createWithResponseAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Starts an elastic 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.

Returns:

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

get

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

Gets 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.
jobExecutionId - The id of the job execution.

Returns:

a job execution.

getAsync

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

Gets 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.
jobExecutionId - The id of the job execution.

Returns:

a job execution on successful completion of Mono.

getWithResponse

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

Gets 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.
jobExecutionId - The id of the job execution.
context - The context to associate with this operation.

Returns:

a job execution along with Response<T>.

getWithResponseAsync

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

Gets 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.
jobExecutionId - The id of the job execution.

Returns:

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

listByAgent

public abstract PagedIterable listByAgent(String resourceGroupName, String serverName, String jobAgentName)

Lists all executions in a job agent.

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.

Returns:

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

listByAgent

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

Lists all executions in a job agent.

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

listByAgentAsync

public abstract PagedFlux listByAgentAsync(String resourceGroupName, String serverName, String jobAgentName)

Lists all executions in a job agent.

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.

Returns:

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

listByAgentAsync

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

Lists all executions in a job agent.

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

listByJob

public abstract PagedIterable listByJob(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Lists a job's executions.

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.

Returns:

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

listByJob

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

Lists a job's executions.

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

listByJobAsync

public abstract PagedFlux listByJobAsync(String resourceGroupName, String serverName, String jobAgentName, String jobName)

Lists a job's executions.

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.

Returns:

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

listByJobAsync

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

Lists a job's executions.

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