Class DataFlowAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.dataflow.DataFlowAsyncClient
-
- All Implemented Interfaces:
DataFlowAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200129") public class DataFlowAsyncClient extends BaseAsyncClient implements DataFlowAsyncAsync client implementation for DataFlow 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 classDataFlowAsyncClient.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 DataFlow.
-
Constructor Summary
Constructors Constructor Description DataFlowAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DataFlowAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DataFlowAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DataFlowAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DataFlowAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DataFlowAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DataFlowAsyncClient(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.dataflow.DataFlowAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DataFlowAsyncClient
@Deprecated public DataFlowAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataFlowAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DataFlowAsyncClient
@Deprecated public DataFlowAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataFlowAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DataFlowAsyncClient
@Deprecated public DataFlowAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataFlowAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DataFlowAsyncClient
@Deprecated public DataFlowAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataFlowAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DataFlowAsyncClient
@Deprecated public DataFlowAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataFlowAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DataFlowAsyncClient
@Deprecated public DataFlowAsyncClient(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 (seeDataFlowAsyncClient.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)
-
DataFlowAsyncClient
@Deprecated public DataFlowAsyncClient(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 (seeDataFlowAsyncClient.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 DataFlowAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DataFlowAsyncSets 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 interfaceDataFlowAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DataFlowAsyncSets 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 interfaceDataFlowAsync- Parameters:
regionId- The public region ID.
-
cascadingDeleteApplication
public Future<CascadingDeleteApplicationResponse> cascadingDeleteApplication(CascadingDeleteApplicationRequest request, AsyncHandler<CascadingDeleteApplicationRequest,CascadingDeleteApplicationResponse> handler)
Description copied from interface:DataFlowAsyncDeletes an application using anapplicationIdand terminates related runs.This operation will timeout in approximate 30 minutes if any related Runs are not terminated successfully.
- Specified by:
cascadingDeleteApplicationin interfaceDataFlowAsync- 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.
-
changeApplicationCompartment
public Future<ChangeApplicationCompartmentResponse> changeApplicationCompartment(ChangeApplicationCompartmentRequest request, AsyncHandler<ChangeApplicationCompartmentRequest,ChangeApplicationCompartmentResponse> handler)
Description copied from interface:DataFlowAsyncMoves an application into a different compartment.When provided, If-Match is checked against ETag values of the resource. Associated resources, like runs, will not be automatically moved.
- Specified by:
changeApplicationCompartmentin interfaceDataFlowAsync- 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.
-
changePoolCompartment
public Future<ChangePoolCompartmentResponse> changePoolCompartment(ChangePoolCompartmentRequest request, AsyncHandler<ChangePoolCompartmentRequest,ChangePoolCompartmentResponse> handler)
Description copied from interface:DataFlowAsyncMoves a pool into a different compartment.When provided, If-Match is checked against ETag values of the resource. Associated resources, like historical metrics, will not be automatically moved. The pool must be in a terminal state (STOPPED, FAILED) in order for it to be moved to a different compartment
- Specified by:
changePoolCompartmentin interfaceDataFlowAsync- 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.
-
changePrivateEndpointCompartment
public Future<ChangePrivateEndpointCompartmentResponse> changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request, AsyncHandler<ChangePrivateEndpointCompartmentRequest,ChangePrivateEndpointCompartmentResponse> handler)
Description copied from interface:DataFlowAsyncMoves a private endpoint into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changePrivateEndpointCompartmentin interfaceDataFlowAsync- 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.
-
changeRunCompartment
public Future<ChangeRunCompartmentResponse> changeRunCompartment(ChangeRunCompartmentRequest request, AsyncHandler<ChangeRunCompartmentRequest,ChangeRunCompartmentResponse> handler)
Description copied from interface:DataFlowAsyncMoves a run into a different compartment.When provided, If-Match is checked against ETag values of the resource. Associated resources, like historical metrics, will not be automatically moved. The run must be in a terminal state (CANCELED, FAILED, SUCCEEDED) in order for it to be moved to a different compartment
- Specified by:
changeRunCompartmentin interfaceDataFlowAsync- 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.
-
changeSqlEndpointCompartment
public Future<ChangeSqlEndpointCompartmentResponse> changeSqlEndpointCompartment(ChangeSqlEndpointCompartmentRequest request, AsyncHandler<ChangeSqlEndpointCompartmentRequest,ChangeSqlEndpointCompartmentResponse> handler)
Description copied from interface:DataFlowAsyncMoves an Sql Endpoint from one compartment to another.When provided, If-Match is checked against ETag values of the Sql Endpoint.
- Specified by:
changeSqlEndpointCompartmentin interfaceDataFlowAsync- 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.
-
createApplication
public Future<CreateApplicationResponse> createApplication(CreateApplicationRequest request, AsyncHandler<CreateApplicationRequest,CreateApplicationResponse> handler)
Description copied from interface:DataFlowAsyncCreates an application.- Specified by:
createApplicationin interfaceDataFlowAsync- 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.
-
createPool
public Future<CreatePoolResponse> createPool(CreatePoolRequest request, AsyncHandler<CreatePoolRequest,CreatePoolResponse> handler)
Description copied from interface:DataFlowAsyncCreate a pool to be used by dataflow runs or applications.- Specified by:
createPoolin interfaceDataFlowAsync- 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.
-
createPrivateEndpoint
public Future<CreatePrivateEndpointResponse> createPrivateEndpoint(CreatePrivateEndpointRequest request, AsyncHandler<CreatePrivateEndpointRequest,CreatePrivateEndpointResponse> handler)
Description copied from interface:DataFlowAsyncCreates a private endpoint to be used by applications.- Specified by:
createPrivateEndpointin interfaceDataFlowAsync- 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.
-
createRun
public Future<CreateRunResponse> createRun(CreateRunRequest request, AsyncHandler<CreateRunRequest,CreateRunResponse> handler)
Description copied from interface:DataFlowAsyncCreates a run for an application.- Specified by:
createRunin interfaceDataFlowAsync- 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.
-
createSqlEndpoint
public Future<CreateSqlEndpointResponse> createSqlEndpoint(CreateSqlEndpointRequest request, AsyncHandler<CreateSqlEndpointRequest,CreateSqlEndpointResponse> handler)
Description copied from interface:DataFlowAsyncCreate a new Sql Endpoint.- Specified by:
createSqlEndpointin interfaceDataFlowAsync- 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.
-
createStatement
public Future<CreateStatementResponse> createStatement(CreateStatementRequest request, AsyncHandler<CreateStatementRequest,CreateStatementResponse> handler)
Description copied from interface:DataFlowAsyncExecutes a statement for a Session run.- Specified by:
createStatementin interfaceDataFlowAsync- 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.
-
deleteApplication
public Future<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest request, AsyncHandler<DeleteApplicationRequest,DeleteApplicationResponse> handler)
Description copied from interface:DataFlowAsyncDeletes an application using anapplicationId.- Specified by:
deleteApplicationin interfaceDataFlowAsync- 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.
-
deletePool
public Future<DeletePoolResponse> deletePool(DeletePoolRequest request, AsyncHandler<DeletePoolRequest,DeletePoolResponse> handler)
Description copied from interface:DataFlowAsyncDeletes a pool using apoolId.- Specified by:
deletePoolin interfaceDataFlowAsync- 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.
-
deletePrivateEndpoint
public Future<DeletePrivateEndpointResponse> deletePrivateEndpoint(DeletePrivateEndpointRequest request, AsyncHandler<DeletePrivateEndpointRequest,DeletePrivateEndpointResponse> handler)
Description copied from interface:DataFlowAsyncDeletes a private endpoint using aprivateEndpointId.- Specified by:
deletePrivateEndpointin interfaceDataFlowAsync- 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.
-
deleteRun
public Future<DeleteRunResponse> deleteRun(DeleteRunRequest request, AsyncHandler<DeleteRunRequest,DeleteRunResponse> handler)
Description copied from interface:DataFlowAsyncCancels the specified run if it has not already completed or was previously cancelled.If a run is in progress, the executing job will be killed.
- Specified by:
deleteRunin interfaceDataFlowAsync- 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.
-
deleteSqlEndpoint
public Future<DeleteSqlEndpointResponse> deleteSqlEndpoint(DeleteSqlEndpointRequest request, AsyncHandler<DeleteSqlEndpointRequest,DeleteSqlEndpointResponse> handler)
Description copied from interface:DataFlowAsyncDelete a Sql Endpoint resource, identified by the SqlEndpoint id.- Specified by:
deleteSqlEndpointin interfaceDataFlowAsync- 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.
-
deleteStatement
public Future<DeleteStatementResponse> deleteStatement(DeleteStatementRequest request, AsyncHandler<DeleteStatementRequest,DeleteStatementResponse> handler)
Description copied from interface:DataFlowAsyncCancels the specified statement for a Session run.- Specified by:
deleteStatementin interfaceDataFlowAsync- 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.
-
getApplication
public Future<GetApplicationResponse> getApplication(GetApplicationRequest request, AsyncHandler<GetApplicationRequest,GetApplicationResponse> handler)
Description copied from interface:DataFlowAsyncRetrieves an application using anapplicationId.- Specified by:
getApplicationin interfaceDataFlowAsync- 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.
-
getPool
public Future<GetPoolResponse> getPool(GetPoolRequest request, AsyncHandler<GetPoolRequest,GetPoolResponse> handler)
Description copied from interface:DataFlowAsyncRetrieves a pool using apoolId.- Specified by:
getPoolin interfaceDataFlowAsync- 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.
-
getPrivateEndpoint
public Future<GetPrivateEndpointResponse> getPrivateEndpoint(GetPrivateEndpointRequest request, AsyncHandler<GetPrivateEndpointRequest,GetPrivateEndpointResponse> handler)
Description copied from interface:DataFlowAsyncRetrieves an private endpoint using aprivateEndpointId.- Specified by:
getPrivateEndpointin interfaceDataFlowAsync- 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.
-
getRun
public Future<GetRunResponse> getRun(GetRunRequest request, AsyncHandler<GetRunRequest,GetRunResponse> handler)
Description copied from interface:DataFlowAsyncRetrieves the run for the specifiedrunId.- Specified by:
getRunin interfaceDataFlowAsync- 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.
-
getRunLog
public Future<GetRunLogResponse> getRunLog(GetRunLogRequest request, AsyncHandler<GetRunLogRequest,GetRunLogResponse> handler)
Description copied from interface:DataFlowAsyncRetrieves the content of an run log.- Specified by:
getRunLogin interfaceDataFlowAsync- 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.
-
getSqlEndpoint
public Future<GetSqlEndpointResponse> getSqlEndpoint(GetSqlEndpointRequest request, AsyncHandler<GetSqlEndpointRequest,GetSqlEndpointResponse> handler)
Description copied from interface:DataFlowAsyncRetrieves a SQL Endpoint using a sqlEndpointId.- Specified by:
getSqlEndpointin interfaceDataFlowAsync- 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.
-
getStatement
public Future<GetStatementResponse> getStatement(GetStatementRequest request, AsyncHandler<GetStatementRequest,GetStatementResponse> handler)
Description copied from interface:DataFlowAsyncRetrieves the statement corresponding to thestatementIdfor a Session run specified byrunId.- Specified by:
getStatementin interfaceDataFlowAsync- 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:DataFlowAsyncGets the status of the work request with the given OCID.- Specified by:
getWorkRequestin interfaceDataFlowAsync- 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.
-
listApplications
public Future<ListApplicationsResponse> listApplications(ListApplicationsRequest request, AsyncHandler<ListApplicationsRequest,ListApplicationsResponse> handler)
Description copied from interface:DataFlowAsyncLists all applications in the specified compartment.Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.
- Specified by:
listApplicationsin interfaceDataFlowAsync- 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.
-
listPools
public Future<ListPoolsResponse> listPools(ListPoolsRequest request, AsyncHandler<ListPoolsRequest,ListPoolsResponse> handler)
Description copied from interface:DataFlowAsyncLists all pools in the specified compartment.The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.
- Specified by:
listPoolsin interfaceDataFlowAsync- 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.
-
listPrivateEndpoints
public Future<ListPrivateEndpointsResponse> listPrivateEndpoints(ListPrivateEndpointsRequest request, AsyncHandler<ListPrivateEndpointsRequest,ListPrivateEndpointsResponse> handler)
Description copied from interface:DataFlowAsyncLists all private endpoints in the specified compartment.The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.
- Specified by:
listPrivateEndpointsin interfaceDataFlowAsync- 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.
-
listRunLogs
public Future<ListRunLogsResponse> listRunLogs(ListRunLogsRequest request, AsyncHandler<ListRunLogsRequest,ListRunLogsResponse> handler)
Description copied from interface:DataFlowAsyncRetrieves summaries of the run’s logs.- Specified by:
listRunLogsin interfaceDataFlowAsync- 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.
-
listRuns
public Future<ListRunsResponse> listRuns(ListRunsRequest request, AsyncHandler<ListRunsRequest,ListRunsResponse> handler)
Description copied from interface:DataFlowAsyncLists all runs of an application in the specified compartment.Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.
- Specified by:
listRunsin interfaceDataFlowAsync- 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.
-
listSqlEndpoints
public Future<ListSqlEndpointsResponse> listSqlEndpoints(ListSqlEndpointsRequest request, AsyncHandler<ListSqlEndpointsRequest,ListSqlEndpointsResponse> handler)
Description copied from interface:DataFlowAsyncLists all Sql Endpoints in the specified compartment.The query must include compartmentId or sqlEndpointId. If the query does not include either compartmentId or sqlEndpointId, an error is returned.
- Specified by:
listSqlEndpointsin interfaceDataFlowAsync- 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.
-
listStatements
public Future<ListStatementsResponse> listStatements(ListStatementsRequest request, AsyncHandler<ListStatementsRequest,ListStatementsResponse> handler)
Description copied from interface:DataFlowAsyncLists all statements for a Session run.- Specified by:
listStatementsin interfaceDataFlowAsync- 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:DataFlowAsyncReturn a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrorsin interfaceDataFlowAsync- 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:DataFlowAsyncReturn a paginated list of logs for a given work request.- Specified by:
listWorkRequestLogsin interfaceDataFlowAsync- 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:DataFlowAsyncLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceDataFlowAsync- 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.
-
startPool
public Future<StartPoolResponse> startPool(StartPoolRequest request, AsyncHandler<StartPoolRequest,StartPoolResponse> handler)
Description copied from interface:DataFlowAsyncStarts the dataflow pool for a givenpoolId.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
startPoolin interfaceDataFlowAsync- 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.
-
startSqlEndpoint
public Future<StartSqlEndpointResponse> startSqlEndpoint(StartSqlEndpointRequest request, AsyncHandler<StartSqlEndpointRequest,StartSqlEndpointResponse> handler)
Description copied from interface:DataFlowAsyncStarts the SqlEndpoint for a givenSqlEndpointId.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
startSqlEndpointin interfaceDataFlowAsync- 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.
-
stopPool
public Future<StopPoolResponse> stopPool(StopPoolRequest request, AsyncHandler<StopPoolRequest,StopPoolResponse> handler)
Description copied from interface:DataFlowAsyncStops the dataflow pool for a givenpoolId.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
stopPoolin interfaceDataFlowAsync- 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.
-
stopSqlEndpoint
public Future<StopSqlEndpointResponse> stopSqlEndpoint(StopSqlEndpointRequest request, AsyncHandler<StopSqlEndpointRequest,StopSqlEndpointResponse> handler)
Description copied from interface:DataFlowAsyncStops the SqlEndpoint for a givenSqlEndpointId.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
stopSqlEndpointin interfaceDataFlowAsync- 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.
-
updateApplication
public Future<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest request, AsyncHandler<UpdateApplicationRequest,UpdateApplicationResponse> handler)
Description copied from interface:DataFlowAsyncUpdates an application using anapplicationId.- Specified by:
updateApplicationin interfaceDataFlowAsync- 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.
-
updatePool
public Future<UpdatePoolResponse> updatePool(UpdatePoolRequest request, AsyncHandler<UpdatePoolRequest,UpdatePoolResponse> handler)
Description copied from interface:DataFlowAsyncUpdates a pool using apoolId.If changes to a pool doesn’t match a previously defined pool,then a 409 status code will be returned.This indicates that a conflict has been detected.- Specified by:
updatePoolin interfaceDataFlowAsync- 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.
-
updatePrivateEndpoint
public Future<UpdatePrivateEndpointResponse> updatePrivateEndpoint(UpdatePrivateEndpointRequest request, AsyncHandler<UpdatePrivateEndpointRequest,UpdatePrivateEndpointResponse> handler)
Description copied from interface:DataFlowAsyncUpdates a private endpoint using aprivateEndpointId.If changes to a private endpoint match a previously defined private endpoint, then a 409 status code will be returned. This indicates that a conflict has been detected.
- Specified by:
updatePrivateEndpointin interfaceDataFlowAsync- 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.
-
updateRun
public Future<UpdateRunResponse> updateRun(UpdateRunRequest request, AsyncHandler<UpdateRunRequest,UpdateRunResponse> handler)
Description copied from interface:DataFlowAsyncUpdates a run using arunId.- Specified by:
updateRunin interfaceDataFlowAsync- 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.
-
updateSqlEndpoint
public Future<UpdateSqlEndpointResponse> updateSqlEndpoint(UpdateSqlEndpointRequest request, AsyncHandler<UpdateSqlEndpointRequest,UpdateSqlEndpointResponse> handler)
Description copied from interface:DataFlowAsyncUpdate a Sql Endpoint resource, identified by the SqlEndpoint id.- Specified by:
updateSqlEndpointin interfaceDataFlowAsync- 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()
-
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
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint- The endpoint template in userequiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
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)
-
-