Interface JobStepExecutionsClient


  • public interface JobStepExecutionsClient
    An instance of this class provides access to all the operations defined in JobStepExecutionsClient.
    • Method Detail

      • listByJobExecutionAsync

        com.azure.core.http.rest.PagedFlux<JobExecutionInner> listByJobExecutionAsync​(String resourceGroupName,
                                                                                      String serverName,
                                                                                      String jobAgentName,
                                                                                      String jobName,
                                                                                      UUID jobExecutionId,
                                                                                      OffsetDateTime createTimeMin,
                                                                                      OffsetDateTime createTimeMax,
                                                                                      OffsetDateTime endTimeMin,
                                                                                      OffsetDateTime endTimeMax,
                                                                                      Boolean isActive,
                                                                                      Integer skip,
                                                                                      Integer 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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByJobExecutionAsync

        com.azure.core.http.rest.PagedFlux<JobExecutionInner> 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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByJobExecution

        com.azure.core.http.rest.PagedIterable<JobExecutionInner> listByJobExecution​(String resourceGroupName,
                                                                                     String serverName,
                                                                                     String jobAgentName,
                                                                                     String jobName,
                                                                                     UUID jobExecutionId,
                                                                                     OffsetDateTime createTimeMin,
                                                                                     OffsetDateTime createTimeMax,
                                                                                     OffsetDateTime endTimeMin,
                                                                                     OffsetDateTime endTimeMax,
                                                                                     Boolean isActive,
                                                                                     Integer skip,
                                                                                     Integer top,
                                                                                     com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByJobExecution

        com.azure.core.http.rest.PagedIterable<JobExecutionInner> 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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWithResponseAsync

        Mono<com.azure.core.http.rest.Response<JobExecutionInner>> 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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAsync

        Mono<JobExecutionInner> 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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • get

        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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWithResponse

        com.azure.core.http.rest.Response<JobExecutionInner> getWithResponse​(String resourceGroupName,
                                                                             String serverName,
                                                                             String jobAgentName,
                                                                             String jobName,
                                                                             UUID jobExecutionId,
                                                                             String stepName,
                                                                             com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.