Class BatchComputingAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.batch.BatchComputingAsyncClient
-
- All Implemented Interfaces:
BatchComputingAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20251031") public class BatchComputingAsyncClient extends BaseAsyncClient implements BatchComputingAsyncAsync client implementation for BatchComputing service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBatchComputingAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for BatchComputing.
-
Constructor Summary
Constructors Constructor Description BatchComputingAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.BatchComputingAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.BatchComputingAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BatchComputingAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BatchComputingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.BatchComputingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.BatchComputingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.BatchComputingAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
BatchComputingAsyncClient
@Deprecated public BatchComputingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBatchComputingAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
BatchComputingAsyncClient
@Deprecated public BatchComputingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBatchComputingAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
BatchComputingAsyncClient
@Deprecated public BatchComputingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBatchComputingAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
BatchComputingAsyncClient
@Deprecated public BatchComputingAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBatchComputingAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
BatchComputingAsyncClient
@Deprecated public BatchComputingAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBatchComputingAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
BatchComputingAsyncClient
@Deprecated public BatchComputingAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBatchComputingAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
BatchComputingAsyncClient
@Deprecated public BatchComputingAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBatchComputingAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static BatchComputingAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:BatchComputingAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceBatchComputingAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:BatchComputingAsyncSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceBatchComputingAsync- Parameters:
regionId- The public region ID.
-
cancelBatchJob
public Future<CancelBatchJobResponse> cancelBatchJob(CancelBatchJobRequest request, AsyncHandler<CancelBatchJobRequest,CancelBatchJobResponse> handler)
Description copied from interface:BatchComputingAsyncCancels a batch job.- Specified by:
cancelBatchJobin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeBatchContextCompartment
public Future<ChangeBatchContextCompartmentResponse> changeBatchContextCompartment(ChangeBatchContextCompartmentRequest request, AsyncHandler<ChangeBatchContextCompartmentRequest,ChangeBatchContextCompartmentResponse> handler)
Description copied from interface:BatchComputingAsyncMoves 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:
changeBatchContextCompartmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeBatchJobCompartment
public Future<ChangeBatchJobCompartmentResponse> changeBatchJobCompartment(ChangeBatchJobCompartmentRequest request, AsyncHandler<ChangeBatchJobCompartmentRequest,ChangeBatchJobCompartmentResponse> handler)
Description copied from interface:BatchComputingAsyncMoves 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:
changeBatchJobCompartmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeBatchJobPoolCompartment
public Future<ChangeBatchJobPoolCompartmentResponse> changeBatchJobPoolCompartment(ChangeBatchJobPoolCompartmentRequest request, AsyncHandler<ChangeBatchJobPoolCompartmentRequest,ChangeBatchJobPoolCompartmentResponse> handler)
Description copied from interface:BatchComputingAsyncMoves 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:
changeBatchJobPoolCompartmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeBatchTaskEnvironmentCompartment
public Future<ChangeBatchTaskEnvironmentCompartmentResponse> changeBatchTaskEnvironmentCompartment(ChangeBatchTaskEnvironmentCompartmentRequest request, AsyncHandler<ChangeBatchTaskEnvironmentCompartmentRequest,ChangeBatchTaskEnvironmentCompartmentResponse> handler)
Description copied from interface:BatchComputingAsyncMoves 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:
changeBatchTaskEnvironmentCompartmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeBatchTaskProfileCompartment
public Future<ChangeBatchTaskProfileCompartmentResponse> changeBatchTaskProfileCompartment(ChangeBatchTaskProfileCompartmentRequest request, AsyncHandler<ChangeBatchTaskProfileCompartmentRequest,ChangeBatchTaskProfileCompartmentResponse> handler)
Description copied from interface:BatchComputingAsyncMoves 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:
changeBatchTaskProfileCompartmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBatchContext
public Future<CreateBatchContextResponse> createBatchContext(CreateBatchContextRequest request, AsyncHandler<CreateBatchContextRequest,CreateBatchContextResponse> handler)
Description copied from interface:BatchComputingAsyncCreates a batch context.- Specified by:
createBatchContextin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBatchJob
public Future<CreateBatchJobResponse> createBatchJob(CreateBatchJobRequest request, AsyncHandler<CreateBatchJobRequest,CreateBatchJobResponse> handler)
Description copied from interface:BatchComputingAsyncCreates a batch job.- Specified by:
createBatchJobin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBatchJobPool
public Future<CreateBatchJobPoolResponse> createBatchJobPool(CreateBatchJobPoolRequest request, AsyncHandler<CreateBatchJobPoolRequest,CreateBatchJobPoolResponse> handler)
Description copied from interface:BatchComputingAsyncCreates a batch job pool.- Specified by:
createBatchJobPoolin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBatchTaskEnvironment
public Future<CreateBatchTaskEnvironmentResponse> createBatchTaskEnvironment(CreateBatchTaskEnvironmentRequest request, AsyncHandler<CreateBatchTaskEnvironmentRequest,CreateBatchTaskEnvironmentResponse> handler)
Description copied from interface:BatchComputingAsyncCreates a batch task environment.- Specified by:
createBatchTaskEnvironmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBatchTaskProfile
public Future<CreateBatchTaskProfileResponse> createBatchTaskProfile(CreateBatchTaskProfileRequest request, AsyncHandler<CreateBatchTaskProfileRequest,CreateBatchTaskProfileResponse> handler)
Description copied from interface:BatchComputingAsyncCreates a batch task profile.- Specified by:
createBatchTaskProfilein interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBatchContext
public Future<DeleteBatchContextResponse> deleteBatchContext(DeleteBatchContextRequest request, AsyncHandler<DeleteBatchContextRequest,DeleteBatchContextResponse> handler)
Description copied from interface:BatchComputingAsyncDeletes a batch context.All batch job pools associated with the batch context must be deleted beforehand.
- Specified by:
deleteBatchContextin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBatchJobPool
public Future<DeleteBatchJobPoolResponse> deleteBatchJobPool(DeleteBatchJobPoolRequest request, AsyncHandler<DeleteBatchJobPoolRequest,DeleteBatchJobPoolResponse> handler)
Description copied from interface:BatchComputingAsyncDeletes a batch job pool.All batch jobs associated with the batch job pool must be canceled beforehand.
- Specified by:
deleteBatchJobPoolin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBatchTaskEnvironment
public Future<DeleteBatchTaskEnvironmentResponse> deleteBatchTaskEnvironment(DeleteBatchTaskEnvironmentRequest request, AsyncHandler<DeleteBatchTaskEnvironmentRequest,DeleteBatchTaskEnvironmentResponse> handler)
Description copied from interface:BatchComputingAsyncDeletes a batch task environment.All batch tasks associated with the batch task environment must be canceled beforehand.
- Specified by:
deleteBatchTaskEnvironmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBatchTaskProfile
public Future<DeleteBatchTaskProfileResponse> deleteBatchTaskProfile(DeleteBatchTaskProfileRequest request, AsyncHandler<DeleteBatchTaskProfileRequest,DeleteBatchTaskProfileResponse> handler)
Description copied from interface:BatchComputingAsyncDeletes a batch task profile.All batch tasks associated with the batch task profile must be canceled beforehand.
- Specified by:
deleteBatchTaskProfilein interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBatchContext
public Future<GetBatchContextResponse> getBatchContext(GetBatchContextRequest request, AsyncHandler<GetBatchContextRequest,GetBatchContextResponse> handler)
Description copied from interface:BatchComputingAsyncGets information about a batch context.- Specified by:
getBatchContextin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBatchJob
public Future<GetBatchJobResponse> getBatchJob(GetBatchJobRequest request, AsyncHandler<GetBatchJobRequest,GetBatchJobResponse> handler)
Description copied from interface:BatchComputingAsyncGets information about a batch job.- Specified by:
getBatchJobin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBatchJobPool
public Future<GetBatchJobPoolResponse> getBatchJobPool(GetBatchJobPoolRequest request, AsyncHandler<GetBatchJobPoolRequest,GetBatchJobPoolResponse> handler)
Description copied from interface:BatchComputingAsyncGets information about a batch job pool.- Specified by:
getBatchJobPoolin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBatchTask
public Future<GetBatchTaskResponse> getBatchTask(GetBatchTaskRequest request, AsyncHandler<GetBatchTaskRequest,GetBatchTaskResponse> handler)
Description copied from interface:BatchComputingAsyncGets a specific batch task associated with a batch job by its name.- Specified by:
getBatchTaskin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBatchTaskEnvironment
public Future<GetBatchTaskEnvironmentResponse> getBatchTaskEnvironment(GetBatchTaskEnvironmentRequest request, AsyncHandler<GetBatchTaskEnvironmentRequest,GetBatchTaskEnvironmentResponse> handler)
Description copied from interface:BatchComputingAsyncGets information about a batch task environment.- Specified by:
getBatchTaskEnvironmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBatchTaskProfile
public Future<GetBatchTaskProfileResponse> getBatchTaskProfile(GetBatchTaskProfileRequest request, AsyncHandler<GetBatchTaskProfileRequest,GetBatchTaskProfileResponse> handler)
Description copied from interface:BatchComputingAsyncGets information about a batch task profile.- Specified by:
getBatchTaskProfilein interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:BatchComputingAsyncGets the details of a work request.- Specified by:
getWorkRequestin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBatchContextShapes
public Future<ListBatchContextShapesResponse> listBatchContextShapes(ListBatchContextShapesRequest request, AsyncHandler<ListBatchContextShapesRequest,ListBatchContextShapesResponse> handler)
Description copied from interface:BatchComputingAsyncLists the shapes allowed to be specified during batch context creation.Ordered by the shape name.
- Specified by:
listBatchContextShapesin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBatchContexts
public Future<ListBatchContextsResponse> listBatchContexts(ListBatchContextsRequest request, AsyncHandler<ListBatchContextsRequest,ListBatchContextsResponse> handler)
Description copied from interface:BatchComputingAsyncLists 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:
listBatchContextsin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBatchJobPools
public Future<ListBatchJobPoolsResponse> listBatchJobPools(ListBatchJobPoolsRequest request, AsyncHandler<ListBatchJobPoolsRequest,ListBatchJobPoolsResponse> handler)
Description copied from interface:BatchComputingAsyncLists 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:
listBatchJobPoolsin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBatchJobTasks
public Future<ListBatchJobTasksResponse> listBatchJobTasks(ListBatchJobTasksRequest request, AsyncHandler<ListBatchJobTasksRequest,ListBatchJobTasksResponse> handler)
Description copied from interface:BatchComputingAsyncLists 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:
listBatchJobTasksin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBatchJobs
public Future<ListBatchJobsResponse> listBatchJobs(ListBatchJobsRequest request, AsyncHandler<ListBatchJobsRequest,ListBatchJobsResponse> handler)
Description copied from interface:BatchComputingAsyncLists 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:
listBatchJobsin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBatchTaskEnvironments
public Future<ListBatchTaskEnvironmentsResponse> listBatchTaskEnvironments(ListBatchTaskEnvironmentsRequest request, AsyncHandler<ListBatchTaskEnvironmentsRequest,ListBatchTaskEnvironmentsResponse> handler)
Description copied from interface:BatchComputingAsyncLists 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:
listBatchTaskEnvironmentsin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBatchTaskProfiles
public Future<ListBatchTaskProfilesResponse> listBatchTaskProfiles(ListBatchTaskProfilesRequest request, AsyncHandler<ListBatchTaskProfilesRequest,ListBatchTaskProfilesResponse> handler)
Description copied from interface:BatchComputingAsyncLists 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:
listBatchTaskProfilesin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBatchTasks
public Future<ListBatchTasksResponse> listBatchTasks(ListBatchTasksRequest request, AsyncHandler<ListBatchTasksRequest,ListBatchTasksResponse> handler)
Description copied from interface:BatchComputingAsyncLists the batch tasks associated with batch jobs.- Specified by:
listBatchTasksin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestErrors
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:BatchComputingAsyncLists the errors for a work request.- Specified by:
listWorkRequestErrorsin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestLogs
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:BatchComputingAsyncLists the logs for a work request.- Specified by:
listWorkRequestLogsin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:BatchComputingAsyncLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
pauseBatchJob
public Future<PauseBatchJobResponse> pauseBatchJob(PauseBatchJobRequest request, AsyncHandler<PauseBatchJobRequest,PauseBatchJobResponse> handler)
Description copied from interface:BatchComputingAsyncPauses the batch job and all its tasks.- Specified by:
pauseBatchJobin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
startBatchContext
public Future<StartBatchContextResponse> startBatchContext(StartBatchContextRequest request, AsyncHandler<StartBatchContextRequest,StartBatchContextResponse> handler)
Description copied from interface:BatchComputingAsyncActivates a batch context to accept new jobs.- Specified by:
startBatchContextin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
startBatchJobPool
public Future<StartBatchJobPoolResponse> startBatchJobPool(StartBatchJobPoolRequest request, AsyncHandler<StartBatchJobPoolRequest,StartBatchJobPoolResponse> handler)
Description copied from interface:BatchComputingAsyncActivates the batch job pool.- Specified by:
startBatchJobPoolin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
stopBatchContext
public Future<StopBatchContextResponse> stopBatchContext(StopBatchContextRequest request, AsyncHandler<StopBatchContextRequest,StopBatchContextResponse> handler)
Description copied from interface:BatchComputingAsyncStops a batch context from accepting new jobs.- Specified by:
stopBatchContextin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
stopBatchJobPool
public Future<StopBatchJobPoolResponse> stopBatchJobPool(StopBatchJobPoolRequest request, AsyncHandler<StopBatchJobPoolRequest,StopBatchJobPoolResponse> handler)
Description copied from interface:BatchComputingAsyncDeactivates the batch job pool.- Specified by:
stopBatchJobPoolin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
unpauseBatchJob
public Future<UnpauseBatchJobResponse> unpauseBatchJob(UnpauseBatchJobRequest request, AsyncHandler<UnpauseBatchJobRequest,UnpauseBatchJobResponse> handler)
Description copied from interface:BatchComputingAsyncResumes the batch job and all its tasks.- Specified by:
unpauseBatchJobin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBatchContext
public Future<UpdateBatchContextResponse> updateBatchContext(UpdateBatchContextRequest request, AsyncHandler<UpdateBatchContextRequest,UpdateBatchContextResponse> handler)
Description copied from interface:BatchComputingAsyncUpdates a batch context.- Specified by:
updateBatchContextin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBatchJob
public Future<UpdateBatchJobResponse> updateBatchJob(UpdateBatchJobRequest request, AsyncHandler<UpdateBatchJobRequest,UpdateBatchJobResponse> handler)
Description copied from interface:BatchComputingAsyncUpdates a batch job.- Specified by:
updateBatchJobin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBatchJobPool
public Future<UpdateBatchJobPoolResponse> updateBatchJobPool(UpdateBatchJobPoolRequest request, AsyncHandler<UpdateBatchJobPoolRequest,UpdateBatchJobPoolResponse> handler)
Description copied from interface:BatchComputingAsyncUpdates a batch job pool.- Specified by:
updateBatchJobPoolin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBatchTaskEnvironment
public Future<UpdateBatchTaskEnvironmentResponse> updateBatchTaskEnvironment(UpdateBatchTaskEnvironmentRequest request, AsyncHandler<UpdateBatchTaskEnvironmentRequest,UpdateBatchTaskEnvironmentResponse> handler)
Description copied from interface:BatchComputingAsyncUpdates a batch task environment.- Specified by:
updateBatchTaskEnvironmentin interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBatchTaskProfile
public Future<UpdateBatchTaskProfileResponse> updateBatchTaskProfile(UpdateBatchTaskProfileRequest request, AsyncHandler<UpdateBatchTaskProfileRequest,UpdateBatchTaskProfileResponse> handler)
Description copied from interface:BatchComputingAsyncUpdates a batch task profile.- Specified by:
updateBatchTaskProfilein interfaceBatchComputingAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
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 byBaseClient.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)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-