Package com.oracle.bmc.batch

Interface BatchComputing

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    BatchComputingClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20251031")
public interface BatchComputing
extends AutoCloseable
    Use the Batch Control Plane API to encapsulate and manage all aspects of computationally intensive jobs.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • cancelBatchJob

        CancelBatchJobResponse cancelBatchJob​(CancelBatchJobRequest request)
        Cancels a batch job.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/CancelBatchJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelBatchJob API.

      • changeBatchContextCompartment

        ChangeBatchContextCompartmentResponse changeBatchContextCompartment​(ChangeBatchContextCompartmentRequest request)
        Moves a batch context into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources to a Different Compartment.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ChangeBatchContextCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBatchContextCompartment API.

      • changeBatchJobCompartment

        ChangeBatchJobCompartmentResponse changeBatchJobCompartment​(ChangeBatchJobCompartmentRequest request)
        Moves a batch job into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources to a Different Compartment.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ChangeBatchJobCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBatchJobCompartment API.

      • changeBatchJobPoolCompartment

        ChangeBatchJobPoolCompartmentResponse changeBatchJobPoolCompartment​(ChangeBatchJobPoolCompartmentRequest request)
        Moves a batch job pool into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources to a Different Compartment.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ChangeBatchJobPoolCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBatchJobPoolCompartment API.

      • changeBatchTaskEnvironmentCompartment

        ChangeBatchTaskEnvironmentCompartmentResponse changeBatchTaskEnvironmentCompartment​(ChangeBatchTaskEnvironmentCompartmentRequest request)
        Moves a batch task environment into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources to a Different Compartment.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ChangeBatchTaskEnvironmentCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBatchTaskEnvironmentCompartment API.

      • changeBatchTaskProfileCompartment

        ChangeBatchTaskProfileCompartmentResponse changeBatchTaskProfileCompartment​(ChangeBatchTaskProfileCompartmentRequest request)
        Moves a batch task profile into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources to a Different Compartment.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ChangeBatchTaskProfileCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBatchTaskProfileCompartment API.

      • createBatchContext

        CreateBatchContextResponse createBatchContext​(CreateBatchContextRequest request)
        Creates a batch context.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/CreateBatchContextExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBatchContext API.

      • createBatchJob

        CreateBatchJobResponse createBatchJob​(CreateBatchJobRequest request)
        Creates a batch job.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/CreateBatchJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBatchJob API.

      • createBatchJobPool

        CreateBatchJobPoolResponse createBatchJobPool​(CreateBatchJobPoolRequest request)
        Creates a batch job pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/CreateBatchJobPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBatchJobPool API.

      • createBatchTaskEnvironment

        CreateBatchTaskEnvironmentResponse createBatchTaskEnvironment​(CreateBatchTaskEnvironmentRequest request)
        Creates a batch task environment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/CreateBatchTaskEnvironmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBatchTaskEnvironment API.

      • createBatchTaskProfile

        CreateBatchTaskProfileResponse createBatchTaskProfile​(CreateBatchTaskProfileRequest request)
        Creates a batch task profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/CreateBatchTaskProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBatchTaskProfile API.

      • deleteBatchContext

        DeleteBatchContextResponse deleteBatchContext​(DeleteBatchContextRequest request)
        Deletes a batch context.

        All batch job pools associated with the batch context must be deleted beforehand.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/DeleteBatchContextExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBatchContext API.

      • deleteBatchJobPool

        DeleteBatchJobPoolResponse deleteBatchJobPool​(DeleteBatchJobPoolRequest request)
        Deletes a batch job pool.

        All batch jobs associated with the batch job pool must be canceled beforehand.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/DeleteBatchJobPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBatchJobPool API.

      • deleteBatchTaskEnvironment

        DeleteBatchTaskEnvironmentResponse deleteBatchTaskEnvironment​(DeleteBatchTaskEnvironmentRequest request)
        Deletes a batch task environment.

        All batch tasks associated with the batch task environment must be canceled beforehand.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/DeleteBatchTaskEnvironmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBatchTaskEnvironment API.

      • deleteBatchTaskProfile

        DeleteBatchTaskProfileResponse deleteBatchTaskProfile​(DeleteBatchTaskProfileRequest request)
        Deletes a batch task profile.

        All batch tasks associated with the batch task profile must be canceled beforehand.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/DeleteBatchTaskProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBatchTaskProfile API.

      • getBatchContext

        GetBatchContextResponse getBatchContext​(GetBatchContextRequest request)
        Gets information about a batch context.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/GetBatchContextExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBatchContext API.

      • getBatchJob

        GetBatchJobResponse getBatchJob​(GetBatchJobRequest request)
        Gets information about a batch job.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/GetBatchJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBatchJob API.

      • getBatchJobPool

        GetBatchJobPoolResponse getBatchJobPool​(GetBatchJobPoolRequest request)
        Gets information about a batch job pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/GetBatchJobPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBatchJobPool API.

      • getBatchTask

        GetBatchTaskResponse getBatchTask​(GetBatchTaskRequest request)
        Gets a specific batch task associated with a batch job by its name.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/GetBatchTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBatchTask API.

      • getBatchTaskEnvironment

        GetBatchTaskEnvironmentResponse getBatchTaskEnvironment​(GetBatchTaskEnvironmentRequest request)
        Gets information about a batch task environment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/GetBatchTaskEnvironmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBatchTaskEnvironment API.

      • getBatchTaskProfile

        GetBatchTaskProfileResponse getBatchTaskProfile​(GetBatchTaskProfileRequest request)
        Gets information about a batch task profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/GetBatchTaskProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBatchTaskProfile API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets the details of a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listBatchContextShapes

        ListBatchContextShapesResponse listBatchContextShapes​(ListBatchContextShapesRequest request)
        Lists the shapes allowed to be specified during batch context creation.

        Ordered by the shape name.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListBatchContextShapesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchContextShapes API.

      • listBatchContexts

        ListBatchContextsResponse listBatchContexts​(ListBatchContextsRequest request)
        Lists the batch contexts by compartment or context OCID.

        You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchContext to get the full details on a specific context

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListBatchContextsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchContexts API.

      • listBatchJobPools

        ListBatchJobPoolsResponse listBatchJobPools​(ListBatchJobPoolsRequest request)
        Lists the batch job pools by compartment or job pool OCID.

        You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJobPool to get the full details on a specific context

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListBatchJobPoolsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchJobPools API.

      • listBatchJobTasks

        ListBatchJobTasksResponse listBatchJobTasks​(ListBatchJobTasksRequest request)
        Lists the batch tasks by batch job OCID.

        You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTask to get the full details on a specific context List is incomplete until jobs lifecycle is in_progress

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListBatchJobTasksExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchJobTasks API.

      • listBatchJobs

        ListBatchJobsResponse listBatchJobs​(ListBatchJobsRequest request)
        Lists the batch jobs by compartment or job OCID.

        You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJob to get the full details on a specific context

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListBatchJobsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchJobs API.

      • listBatchTaskEnvironments

        ListBatchTaskEnvironmentsResponse listBatchTaskEnvironments​(ListBatchTaskEnvironmentsRequest request)
        Lists the task environments by compartment or environment OCID.

        You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskEnvironment to get the full details on a specific context

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListBatchTaskEnvironmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchTaskEnvironments API.

      • listBatchTaskProfiles

        ListBatchTaskProfilesResponse listBatchTaskProfiles​(ListBatchTaskProfilesRequest request)
        Lists the task profiles by compartment or profile OCID.

        You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskProfile to get the full details on a specific context

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListBatchTaskProfilesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchTaskProfiles API.

      • listBatchTasks

        ListBatchTasksResponse listBatchTasks​(ListBatchTasksRequest request)
        Lists the batch tasks associated with batch jobs.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListBatchTasksExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchTasks API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Lists the errors for a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.

      • listWorkRequestLogs

        ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Lists the logs for a work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • pauseBatchJob

        PauseBatchJobResponse pauseBatchJob​(PauseBatchJobRequest request)
        Pauses the batch job and all its tasks.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/PauseBatchJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PauseBatchJob API.

      • startBatchContext

        StartBatchContextResponse startBatchContext​(StartBatchContextRequest request)
        Activates a batch context to accept new jobs.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/StartBatchContextExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartBatchContext API.

      • startBatchJobPool

        StartBatchJobPoolResponse startBatchJobPool​(StartBatchJobPoolRequest request)
        Activates the batch job pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/StartBatchJobPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartBatchJobPool API.

      • stopBatchContext

        StopBatchContextResponse stopBatchContext​(StopBatchContextRequest request)
        Stops a batch context from accepting new jobs.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/StopBatchContextExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopBatchContext API.

      • stopBatchJobPool

        StopBatchJobPoolResponse stopBatchJobPool​(StopBatchJobPoolRequest request)
        Deactivates the batch job pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/StopBatchJobPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopBatchJobPool API.

      • unpauseBatchJob

        UnpauseBatchJobResponse unpauseBatchJob​(UnpauseBatchJobRequest request)
        Resumes the batch job and all its tasks.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/UnpauseBatchJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UnpauseBatchJob API.

      • updateBatchContext

        UpdateBatchContextResponse updateBatchContext​(UpdateBatchContextRequest request)
        Updates a batch context.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/UpdateBatchContextExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBatchContext API.

      • updateBatchJob

        UpdateBatchJobResponse updateBatchJob​(UpdateBatchJobRequest request)
        Updates a batch job.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/UpdateBatchJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBatchJob API.

      • updateBatchJobPool

        UpdateBatchJobPoolResponse updateBatchJobPool​(UpdateBatchJobPoolRequest request)
        Updates a batch job pool.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/UpdateBatchJobPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBatchJobPool API.

      • updateBatchTaskEnvironment

        UpdateBatchTaskEnvironmentResponse updateBatchTaskEnvironment​(UpdateBatchTaskEnvironmentRequest request)
        Updates a batch task environment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/UpdateBatchTaskEnvironmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBatchTaskEnvironment API.

      • updateBatchTaskProfile

        UpdateBatchTaskProfileResponse updateBatchTaskProfile​(UpdateBatchTaskProfileRequest request)
        Updates a batch task profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.77.2/batch/UpdateBatchTaskProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBatchTaskProfile API.

      • getWaiters

        BatchComputingWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        BatchComputingPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.