java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.batch.BatchComputingClient

All Implemented Interfaces:: BatchComputing, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20251031")
public class BatchComputingClient
extends BaseSyncClient
implements BatchComputing

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BatchComputingClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for BatchComputing.

Constructor Summary

Constructors
Constructor	Description
`BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)`	Deprecated. Use the `builder` instead.
`BatchComputingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`BatchComputingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`BatchComputingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static BatchComputingClient.Builder`	`builder()`	Create a builder for this client.
`CancelBatchJobResponse`	`cancelBatchJob(CancelBatchJobRequest request)`	Cancels a batch job.
`ChangeBatchContextCompartmentResponse`	`changeBatchContextCompartment(ChangeBatchContextCompartmentRequest request)`	Moves a batch context into a different compartment within the same tenancy.
`ChangeBatchJobCompartmentResponse`	`changeBatchJobCompartment(ChangeBatchJobCompartmentRequest request)`	Moves a batch job into a different compartment within the same tenancy.
`ChangeBatchJobPoolCompartmentResponse`	`changeBatchJobPoolCompartment(ChangeBatchJobPoolCompartmentRequest request)`	Moves a batch job pool into a different compartment within the same tenancy.
`ChangeBatchTaskEnvironmentCompartmentResponse`	`changeBatchTaskEnvironmentCompartment(ChangeBatchTaskEnvironmentCompartmentRequest request)`	Moves a batch task environment into a different compartment within the same tenancy.
`ChangeBatchTaskProfileCompartmentResponse`	`changeBatchTaskProfileCompartment(ChangeBatchTaskProfileCompartmentRequest request)`	Moves a batch task profile into a different compartment within the same tenancy.
`void`	`close()`
`CreateBatchContextResponse`	`createBatchContext(CreateBatchContextRequest request)`	Creates a batch context.
`CreateBatchJobResponse`	`createBatchJob(CreateBatchJobRequest request)`	Creates a batch job.
`CreateBatchJobPoolResponse`	`createBatchJobPool(CreateBatchJobPoolRequest request)`	Creates a batch job pool.
`CreateBatchTaskEnvironmentResponse`	`createBatchTaskEnvironment(CreateBatchTaskEnvironmentRequest request)`	Creates a batch task environment.
`CreateBatchTaskProfileResponse`	`createBatchTaskProfile(CreateBatchTaskProfileRequest request)`	Creates a batch task profile.
`DeleteBatchContextResponse`	`deleteBatchContext(DeleteBatchContextRequest request)`	Deletes a batch context.
`DeleteBatchJobPoolResponse`	`deleteBatchJobPool(DeleteBatchJobPoolRequest request)`	Deletes a batch job pool.
`DeleteBatchTaskEnvironmentResponse`	`deleteBatchTaskEnvironment(DeleteBatchTaskEnvironmentRequest request)`	Deletes a batch task environment.
`DeleteBatchTaskProfileResponse`	`deleteBatchTaskProfile(DeleteBatchTaskProfileRequest request)`	Deletes a batch task profile.
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`GetBatchContextResponse`	`getBatchContext(GetBatchContextRequest request)`	Gets information about a batch context.
`GetBatchJobResponse`	`getBatchJob(GetBatchJobRequest request)`	Gets information about a batch job.
`GetBatchJobPoolResponse`	`getBatchJobPool(GetBatchJobPoolRequest request)`	Gets information about a batch job pool.
`GetBatchTaskResponse`	`getBatchTask(GetBatchTaskRequest request)`	Gets a specific batch task associated with a batch job by its name.
`GetBatchTaskEnvironmentResponse`	`getBatchTaskEnvironment(GetBatchTaskEnvironmentRequest request)`	Gets information about a batch task environment.
`GetBatchTaskProfileResponse`	`getBatchTaskProfile(GetBatchTaskProfileRequest request)`	Gets information about a batch task profile.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`	Get the endpoint of the client.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Map<String,Boolean>`	`getOptionsMap()`	Return an immutable snapshot representing the current options set for this client.
`BatchComputingPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`String`	`getResolvedEndpoint(Map<String,Object> requiredParametersMap)`	Returns the endpoint after filling in the current options, as determined by `BaseClient.getOptionsMap()`, and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
`BatchComputingWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)`	Gets the details of a work request.
`ListBatchContextsResponse`	`listBatchContexts(ListBatchContextsRequest request)`	Lists the batch contexts by compartment or context OCID.
`ListBatchContextShapesResponse`	`listBatchContextShapes(ListBatchContextShapesRequest request)`	Lists the shapes allowed to be specified during batch context creation.
`ListBatchJobPoolsResponse`	`listBatchJobPools(ListBatchJobPoolsRequest request)`	Lists the batch job pools by compartment or job pool OCID.
`ListBatchJobsResponse`	`listBatchJobs(ListBatchJobsRequest request)`	Lists the batch jobs by compartment or job OCID.
`ListBatchJobTasksResponse`	`listBatchJobTasks(ListBatchJobTasksRequest request)`	Lists the batch tasks by batch job OCID.
`ListBatchTaskEnvironmentsResponse`	`listBatchTaskEnvironments(ListBatchTaskEnvironmentsRequest request)`	Lists the task environments by compartment or environment OCID.
`ListBatchTaskProfilesResponse`	`listBatchTaskProfiles(ListBatchTaskProfilesRequest request)`	Lists the task profiles by compartment or profile OCID.
`ListBatchTasksResponse`	`listBatchTasks(ListBatchTasksRequest request)`	Lists the batch tasks associated with batch jobs.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)`	Lists the errors for a work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)`	Lists the logs for a work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)`	Lists the work requests in a compartment.
`PauseBatchJobResponse`	`pauseBatchJob(PauseBatchJobRequest request)`	Pauses the batch job and all its tasks.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)`	Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)`	Sets the region to call (ex, ‘us-phoenix-1’).
`StartBatchContextResponse`	`startBatchContext(StartBatchContextRequest request)`	Activates a batch context to accept new jobs.
`StartBatchJobPoolResponse`	`startBatchJobPool(StartBatchJobPoolRequest request)`	Activates the batch job pool.
`StopBatchContextResponse`	`stopBatchContext(StopBatchContextRequest request)`	Stops a batch context from accepting new jobs.
`StopBatchJobPoolResponse`	`stopBatchJobPool(StopBatchJobPoolRequest request)`	Deactivates the batch job pool.
`UnpauseBatchJobResponse`	`unpauseBatchJob(UnpauseBatchJobRequest request)`	Resumes the batch job and all its tasks.
`UpdateBatchContextResponse`	`updateBatchContext(UpdateBatchContextRequest request)`	Updates a batch context.
`UpdateBatchJobResponse`	`updateBatchJob(UpdateBatchJobRequest request)`	Updates a batch job.
`UpdateBatchJobPoolResponse`	`updateBatchJobPool(UpdateBatchJobPoolRequest request)`	Updates a batch job pool.
`UpdateBatchTaskEnvironmentResponse`	`updateBatchTaskEnvironment(UpdateBatchTaskEnvironmentRequest request)`	Updates a batch task environment.
`UpdateBatchTaskProfileResponse`	`updateBatchTaskProfile(UpdateBatchTaskProfileRequest request)`	Updates a batch task profile.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.batch.BatchComputing
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for BatchComputing.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - BatchComputingClient
```
@Deprecated
public BatchComputingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see BatchComputingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - BatchComputingClient
```
@Deprecated
public BatchComputingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see BatchComputingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - BatchComputingClient
```
@Deprecated
public BatchComputingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see BatchComputingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - BatchComputingClient
```
@Deprecated
public BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see BatchComputingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - BatchComputingClient
```
@Deprecated
public BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see BatchComputingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - BatchComputingClient
```
@Deprecated
public BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see BatchComputingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - BatchComputingClient
```
@Deprecated
public BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see BatchComputingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
  - BatchComputingClient
```
@Deprecated
public BatchComputingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint,
                            ExecutorService executorService)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see BatchComputingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
    
    executorService - BatchComputingClient.Builder.executorService
- Method Detail
  - builder
```
public static BatchComputingClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: BatchComputing
    
    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.
    
    Specified by:
    
    setRegion in interface BatchComputing
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: BatchComputing
    
    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.
    
    Specified by:
    
    setRegion in interface BatchComputing
    
    Parameters:
    
    regionId - The public region ID.
  - cancelBatchJob
```
public CancelBatchJobResponse cancelBatchJob(CancelBatchJobRequest request)
```
    Description copied from interface: BatchComputing
    
    Cancels a batch job.
    
    Specified by:
    
    cancelBatchJob in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeBatchContextCompartment
```
public ChangeBatchContextCompartmentResponse changeBatchContextCompartment(ChangeBatchContextCompartmentRequest request)
```
    Description copied from interface: BatchComputing
    
    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.
    
    Specified by:
    
    changeBatchContextCompartment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeBatchJobCompartment
```
public ChangeBatchJobCompartmentResponse changeBatchJobCompartment(ChangeBatchJobCompartmentRequest request)
```
    Description copied from interface: BatchComputing
    
    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.
    
    Specified by:
    
    changeBatchJobCompartment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeBatchJobPoolCompartment
```
public ChangeBatchJobPoolCompartmentResponse changeBatchJobPoolCompartment(ChangeBatchJobPoolCompartmentRequest request)
```
    Description copied from interface: BatchComputing
    
    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.
    
    Specified by:
    
    changeBatchJobPoolCompartment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeBatchTaskEnvironmentCompartment
```
public ChangeBatchTaskEnvironmentCompartmentResponse changeBatchTaskEnvironmentCompartment(ChangeBatchTaskEnvironmentCompartmentRequest request)
```
    Description copied from interface: BatchComputing
    
    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.
    
    Specified by:
    
    changeBatchTaskEnvironmentCompartment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeBatchTaskProfileCompartment
```
public ChangeBatchTaskProfileCompartmentResponse changeBatchTaskProfileCompartment(ChangeBatchTaskProfileCompartmentRequest request)
```
    Description copied from interface: BatchComputing
    
    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.
    
    Specified by:
    
    changeBatchTaskProfileCompartment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBatchContext
```
public CreateBatchContextResponse createBatchContext(CreateBatchContextRequest request)
```
    Description copied from interface: BatchComputing
    
    Creates a batch context.
    
    Specified by:
    
    createBatchContext in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBatchJob
```
public CreateBatchJobResponse createBatchJob(CreateBatchJobRequest request)
```
    Description copied from interface: BatchComputing
    
    Creates a batch job.
    
    Specified by:
    
    createBatchJob in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBatchJobPool
```
public CreateBatchJobPoolResponse createBatchJobPool(CreateBatchJobPoolRequest request)
```
    Description copied from interface: BatchComputing
    
    Creates a batch job pool.
    
    Specified by:
    
    createBatchJobPool in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBatchTaskEnvironment
```
public CreateBatchTaskEnvironmentResponse createBatchTaskEnvironment(CreateBatchTaskEnvironmentRequest request)
```
    Description copied from interface: BatchComputing
    
    Creates a batch task environment.
    
    Specified by:
    
    createBatchTaskEnvironment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBatchTaskProfile
```
public CreateBatchTaskProfileResponse createBatchTaskProfile(CreateBatchTaskProfileRequest request)
```
    Description copied from interface: BatchComputing
    
    Creates a batch task profile.
    
    Specified by:
    
    createBatchTaskProfile in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteBatchContext
```
public DeleteBatchContextResponse deleteBatchContext(DeleteBatchContextRequest request)
```
    Description copied from interface: BatchComputing
    
    Deletes a batch context.
    All batch job pools associated with the batch context must be deleted beforehand.
    
    Specified by:
    
    deleteBatchContext in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteBatchJobPool
```
public DeleteBatchJobPoolResponse deleteBatchJobPool(DeleteBatchJobPoolRequest request)
```
    Description copied from interface: BatchComputing
    
    Deletes a batch job pool.
    All batch jobs associated with the batch job pool must be canceled beforehand.
    
    Specified by:
    
    deleteBatchJobPool in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteBatchTaskEnvironment
```
public DeleteBatchTaskEnvironmentResponse deleteBatchTaskEnvironment(DeleteBatchTaskEnvironmentRequest request)
```
    Description copied from interface: BatchComputing
    
    Deletes a batch task environment.
    All batch tasks associated with the batch task environment must be canceled beforehand.
    
    Specified by:
    
    deleteBatchTaskEnvironment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteBatchTaskProfile
```
public DeleteBatchTaskProfileResponse deleteBatchTaskProfile(DeleteBatchTaskProfileRequest request)
```
    Description copied from interface: BatchComputing
    
    Deletes a batch task profile.
    All batch tasks associated with the batch task profile must be canceled beforehand.
    
    Specified by:
    
    deleteBatchTaskProfile in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBatchContext
```
public GetBatchContextResponse getBatchContext(GetBatchContextRequest request)
```
    Description copied from interface: BatchComputing
    
    Gets information about a batch context.
    
    Specified by:
    
    getBatchContext in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBatchJob
```
public GetBatchJobResponse getBatchJob(GetBatchJobRequest request)
```
    Description copied from interface: BatchComputing
    
    Gets information about a batch job.
    
    Specified by:
    
    getBatchJob in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBatchJobPool
```
public GetBatchJobPoolResponse getBatchJobPool(GetBatchJobPoolRequest request)
```
    Description copied from interface: BatchComputing
    
    Gets information about a batch job pool.
    
    Specified by:
    
    getBatchJobPool in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBatchTask
```
public GetBatchTaskResponse getBatchTask(GetBatchTaskRequest request)
```
    Description copied from interface: BatchComputing
    
    Gets a specific batch task associated with a batch job by its name.
    
    Specified by:
    
    getBatchTask in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBatchTaskEnvironment
```
public GetBatchTaskEnvironmentResponse getBatchTaskEnvironment(GetBatchTaskEnvironmentRequest request)
```
    Description copied from interface: BatchComputing
    
    Gets information about a batch task environment.
    
    Specified by:
    
    getBatchTaskEnvironment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBatchTaskProfile
```
public GetBatchTaskProfileResponse getBatchTaskProfile(GetBatchTaskProfileRequest request)
```
    Description copied from interface: BatchComputing
    
    Gets information about a batch task profile.
    
    Specified by:
    
    getBatchTaskProfile in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: BatchComputing
    
    Gets the details of a work request.
    
    Specified by:
    
    getWorkRequest in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBatchContextShapes
```
public ListBatchContextShapesResponse listBatchContextShapes(ListBatchContextShapesRequest request)
```
    Description copied from interface: BatchComputing
    
    Lists the shapes allowed to be specified during batch context creation.
    Ordered by the shape name.
    
    Specified by:
    
    listBatchContextShapes in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBatchContexts
```
public ListBatchContextsResponse listBatchContexts(ListBatchContextsRequest request)
```
    Description copied from interface: BatchComputing
    
    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
    
    Specified by:
    
    listBatchContexts in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBatchJobPools
```
public ListBatchJobPoolsResponse listBatchJobPools(ListBatchJobPoolsRequest request)
```
    Description copied from interface: BatchComputing
    
    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
    
    Specified by:
    
    listBatchJobPools in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBatchJobTasks
```
public ListBatchJobTasksResponse listBatchJobTasks(ListBatchJobTasksRequest request)
```
    Description copied from interface: BatchComputing
    
    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
    
    Specified by:
    
    listBatchJobTasks in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBatchJobs
```
public ListBatchJobsResponse listBatchJobs(ListBatchJobsRequest request)
```
    Description copied from interface: BatchComputing
    
    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
    
    Specified by:
    
    listBatchJobs in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBatchTaskEnvironments
```
public ListBatchTaskEnvironmentsResponse listBatchTaskEnvironments(ListBatchTaskEnvironmentsRequest request)
```
    Description copied from interface: BatchComputing
    
    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
    
    Specified by:
    
    listBatchTaskEnvironments in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBatchTaskProfiles
```
public ListBatchTaskProfilesResponse listBatchTaskProfiles(ListBatchTaskProfilesRequest request)
```
    Description copied from interface: BatchComputing
    
    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
    
    Specified by:
    
    listBatchTaskProfiles in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBatchTasks
```
public ListBatchTasksResponse listBatchTasks(ListBatchTasksRequest request)
```
    Description copied from interface: BatchComputing
    
    Lists the batch tasks associated with batch jobs.
    
    Specified by:
    
    listBatchTasks in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: BatchComputing
    
    Lists the errors for a work request.
    
    Specified by:
    
    listWorkRequestErrors in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: BatchComputing
    
    Lists the logs for a work request.
    
    Specified by:
    
    listWorkRequestLogs in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: BatchComputing
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - pauseBatchJob
```
public PauseBatchJobResponse pauseBatchJob(PauseBatchJobRequest request)
```
    Description copied from interface: BatchComputing
    
    Pauses the batch job and all its tasks.
    
    Specified by:
    
    pauseBatchJob in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - startBatchContext
```
public StartBatchContextResponse startBatchContext(StartBatchContextRequest request)
```
    Description copied from interface: BatchComputing
    
    Activates a batch context to accept new jobs.
    
    Specified by:
    
    startBatchContext in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - startBatchJobPool
```
public StartBatchJobPoolResponse startBatchJobPool(StartBatchJobPoolRequest request)
```
    Description copied from interface: BatchComputing
    
    Activates the batch job pool.
    
    Specified by:
    
    startBatchJobPool in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - stopBatchContext
```
public StopBatchContextResponse stopBatchContext(StopBatchContextRequest request)
```
    Description copied from interface: BatchComputing
    
    Stops a batch context from accepting new jobs.
    
    Specified by:
    
    stopBatchContext in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - stopBatchJobPool
```
public StopBatchJobPoolResponse stopBatchJobPool(StopBatchJobPoolRequest request)
```
    Description copied from interface: BatchComputing
    
    Deactivates the batch job pool.
    
    Specified by:
    
    stopBatchJobPool in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - unpauseBatchJob
```
public UnpauseBatchJobResponse unpauseBatchJob(UnpauseBatchJobRequest request)
```
    Description copied from interface: BatchComputing
    
    Resumes the batch job and all its tasks.
    
    Specified by:
    
    unpauseBatchJob in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBatchContext
```
public UpdateBatchContextResponse updateBatchContext(UpdateBatchContextRequest request)
```
    Description copied from interface: BatchComputing
    
    Updates a batch context.
    
    Specified by:
    
    updateBatchContext in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBatchJob
```
public UpdateBatchJobResponse updateBatchJob(UpdateBatchJobRequest request)
```
    Description copied from interface: BatchComputing
    
    Updates a batch job.
    
    Specified by:
    
    updateBatchJob in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBatchJobPool
```
public UpdateBatchJobPoolResponse updateBatchJobPool(UpdateBatchJobPoolRequest request)
```
    Description copied from interface: BatchComputing
    
    Updates a batch job pool.
    
    Specified by:
    
    updateBatchJobPool in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBatchTaskEnvironment
```
public UpdateBatchTaskEnvironmentResponse updateBatchTaskEnvironment(UpdateBatchTaskEnvironmentRequest request)
```
    Description copied from interface: BatchComputing
    
    Updates a batch task environment.
    
    Specified by:
    
    updateBatchTaskEnvironment in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBatchTaskProfile
```
public UpdateBatchTaskProfileResponse updateBatchTaskProfile(UpdateBatchTaskProfileRequest request)
```
    Description copied from interface: BatchComputing
    
    Updates a batch task profile.
    
    Specified by:
    
    updateBatchTaskProfile in interface BatchComputing
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public BatchComputingWaiters getWaiters()
```
    Description copied from interface: BatchComputing
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface BatchComputing
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public BatchComputingPaginators getPaginators()
```
    Description copied from interface: BatchComputing
    
    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.
    
    Specified by:
    
    getPaginators in interface BatchComputing
    
    Returns:
    
    The service paginators.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - enableDualStackEndpoints
```
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
```
    This method should be used to enable or disable the use of dual-stack endpoints.
    The default value is false i.e. dual-stack endpoints are disabled by default.
    
    Parameters:
    
    enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
  - getOptionsMap
```
public Map<String,Boolean> getOptionsMap()
```
    Return an immutable snapshot representing the current options set for this client.
    
    Returns:
    
    immutable snapshot representing the current options set for this client
  - getResolvedEndpoint
```
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
```
    Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
    
    Parameters:
    
    requiredParametersMap - the map from required parameter name to their values
    
    Returns:
    
    resolved endpoint, with all options and placeholders filled in
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
    Get the endpoint of the client.
    Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.
    Examples of endpoints this may return:
    
    Unparameterized endpoints
    https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with placeholders
    https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with options
    https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
    
    Parameterized endpoints with placeholders and options
    https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).
    Returns:
    
    the endpoint being used by the client
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```

Class BatchComputingClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.batch.BatchComputing

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

BatchComputingClient

BatchComputingClient

BatchComputingClient

BatchComputingClient

BatchComputingClient

BatchComputingClient

BatchComputingClient

BatchComputingClient

Method Detail

builder

setRegion

setRegion

cancelBatchJob

changeBatchContextCompartment

changeBatchJobCompartment

changeBatchJobPoolCompartment

changeBatchTaskEnvironmentCompartment

changeBatchTaskProfileCompartment

createBatchContext

createBatchJob

createBatchJobPool

createBatchTaskEnvironment

createBatchTaskProfile

deleteBatchContext

deleteBatchJobPool

deleteBatchTaskEnvironment

deleteBatchTaskProfile

getBatchContext

getBatchJob

getBatchJobPool

getBatchTask

getBatchTaskEnvironment

getBatchTaskProfile

getWorkRequest

listBatchContextShapes

listBatchContexts

listBatchJobPools

listBatchJobTasks

listBatchJobs

listBatchTaskEnvironments

listBatchTaskProfiles

listBatchTasks

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

pauseBatchJob

startBatchContext

startBatchJobPool

stopBatchContext

stopBatchJobPool

unpauseBatchJob

updateBatchContext

updateBatchJob

updateBatchJobPool

updateBatchTaskEnvironment

updateBatchTaskProfile

getWaiters

getPaginators

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient