Package com.oracle.bmc.blockchain

Class BlockchainPlatformAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.blockchain.BlockchainPlatformAsyncClient

All Implemented Interfaces:

BlockchainPlatformAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20191010")
public class BlockchainPlatformAsyncClient
extends BaseAsyncClient
implements BlockchainPlatformAsync

Async client implementation for BlockchainPlatform service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, 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 class	BlockchainPlatformAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static BlockchainPlatformAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeBlockchainPlatformCompartmentResponse>	changeBlockchainPlatformCompartment(ChangeBlockchainPlatformCompartmentRequest request, AsyncHandler<ChangeBlockchainPlatformCompartmentRequest,ChangeBlockchainPlatformCompartmentResponse> handler)	Change Blockchain Platform Compartment
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)
void	close()
Future<CreateBlockchainPlatformResponse>	createBlockchainPlatform(CreateBlockchainPlatformRequest request, AsyncHandler<CreateBlockchainPlatformRequest,CreateBlockchainPlatformResponse> handler)	Creates a new Blockchain Platform.
Future<CreateOsnResponse>	createOsn(CreateOsnRequest request, AsyncHandler<CreateOsnRequest,CreateOsnResponse> handler)	Create Blockchain Platform Osn
Future<CreatePeerResponse>	createPeer(CreatePeerRequest request, AsyncHandler<CreatePeerRequest,CreatePeerResponse> handler)	Create Blockchain Platform Peer
Future<DeleteBlockchainPlatformResponse>	deleteBlockchainPlatform(DeleteBlockchainPlatformRequest request, AsyncHandler<DeleteBlockchainPlatformRequest,DeleteBlockchainPlatformResponse> handler)	Delete a particular of a Blockchain Platform
Future<DeleteOsnResponse>	deleteOsn(DeleteOsnRequest request, AsyncHandler<DeleteOsnRequest,DeleteOsnResponse> handler)	Delete a particular OSN of a Blockchain Platform
Future<DeletePeerResponse>	deletePeer(DeletePeerRequest request, AsyncHandler<DeletePeerRequest,DeletePeerResponse> handler)	Delete a particular peer of a Blockchain Platform
Future<DeleteWorkRequestResponse>	deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)	Attempts to cancel the work request with the given ID.
Future<GetBlockchainPlatformResponse>	getBlockchainPlatform(GetBlockchainPlatformRequest request, AsyncHandler<GetBlockchainPlatformRequest,GetBlockchainPlatformResponse> handler)	Gets information about a Blockchain Platform identified by the specific id
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetOsnResponse>	getOsn(GetOsnRequest request, AsyncHandler<GetOsnRequest,GetOsnResponse> handler)	Gets information about an OSN identified by the specific id
Future<GetPeerResponse>	getPeer(GetPeerRequest request, AsyncHandler<GetPeerRequest,GetPeerResponse> handler)	Gets information about a peer identified by the specific id
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)	Gets the status of the work request with the given ID.
Future<ListBlockchainPlatformPatchesResponse>	listBlockchainPlatformPatches(ListBlockchainPlatformPatchesRequest request, AsyncHandler<ListBlockchainPlatformPatchesRequest,ListBlockchainPlatformPatchesResponse> handler)	List Blockchain Platform Patches
Future<ListBlockchainPlatformsResponse>	listBlockchainPlatforms(ListBlockchainPlatformsRequest request, AsyncHandler<ListBlockchainPlatformsRequest,ListBlockchainPlatformsResponse> handler)	Returns a list Blockchain Platform Instances in a compartment
Future<ListOsnsResponse>	listOsns(ListOsnsRequest request, AsyncHandler<ListOsnsRequest,ListOsnsResponse> handler)	List Blockchain Platform OSNs
Future<ListPeersResponse>	listPeers(ListPeersRequest request, AsyncHandler<ListPeersRequest,ListPeersResponse> handler)	List Blockchain Platform Peers
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)	Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)	Return a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)	Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
Future<PreviewScaleBlockchainPlatformResponse>	previewScaleBlockchainPlatform(PreviewScaleBlockchainPlatformRequest request, AsyncHandler<PreviewScaleBlockchainPlatformRequest,PreviewScaleBlockchainPlatformResponse> handler)	Preview Scale Blockchain Platform
void	refreshClient()	Rebuild the backing HttpClient.
Future<ScaleBlockchainPlatformResponse>	scaleBlockchainPlatform(ScaleBlockchainPlatformRequest request, AsyncHandler<ScaleBlockchainPlatformRequest,ScaleBlockchainPlatformResponse> handler)	Scale Blockchain Platform
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
Future<StartBlockchainPlatformResponse>	startBlockchainPlatform(StartBlockchainPlatformRequest request, AsyncHandler<StartBlockchainPlatformRequest,StartBlockchainPlatformResponse> handler)	Start a Blockchain Platform
Future<StopBlockchainPlatformResponse>	stopBlockchainPlatform(StopBlockchainPlatformRequest request, AsyncHandler<StopBlockchainPlatformRequest,StopBlockchainPlatformResponse> handler)	Stop a Blockchain Platform
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateBlockchainPlatformResponse>	updateBlockchainPlatform(UpdateBlockchainPlatformRequest request, AsyncHandler<UpdateBlockchainPlatformRequest,UpdateBlockchainPlatformResponse> handler)	Update a particular of a Blockchain Platform
Future<UpdateOsnResponse>	updateOsn(UpdateOsnRequest request, AsyncHandler<UpdateOsnRequest,UpdateOsnResponse> handler)	Update Blockchain Platform OSN
Future<UpdatePeerResponse>	updatePeer(UpdatePeerRequest request, AsyncHandler<UpdatePeerRequest,UpdatePeerResponse> handler)	Update Blockchain Platform Peer
Future<UpgradeBlockchainPlatformResponse>	upgradeBlockchainPlatform(UpgradeBlockchainPlatformRequest request, AsyncHandler<UpgradeBlockchainPlatformRequest,UpgradeBlockchainPlatformResponse> handler)	Upgrade a Blockchain Platform version
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

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.blockchain.BlockchainPlatformAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for BlockchainPlatform.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

BlockchainPlatformAsyncClient

@Deprecated
public BlockchainPlatformAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockchainPlatformAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

BlockchainPlatformAsyncClient

@Deprecated
public BlockchainPlatformAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockchainPlatformAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

BlockchainPlatformAsyncClient

@Deprecated
public BlockchainPlatformAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration,
                                     ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockchainPlatformAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

BlockchainPlatformAsyncClient

@Deprecated
public BlockchainPlatformAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration,
                                     ClientConfigurator clientConfigurator,
                                     RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockchainPlatformAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

BlockchainPlatformAsyncClient

@Deprecated
public BlockchainPlatformAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration,
                                     ClientConfigurator clientConfigurator,
                                     RequestSignerFactory defaultRequestSignerFactory,
                                     List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockchainPlatformAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

BlockchainPlatformAsyncClient

@Deprecated
public BlockchainPlatformAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration,
                                     ClientConfigurator clientConfigurator,
                                     RequestSignerFactory defaultRequestSignerFactory,
                                     List<ClientConfigurator> additionalClientConfigurators,
                                     String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockchainPlatformAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

BlockchainPlatformAsyncClient

@Deprecated
public BlockchainPlatformAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration,
                                     ClientConfigurator clientConfigurator,
                                     RequestSignerFactory defaultRequestSignerFactory,
                                     Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                     List<ClientConfigurator> additionalClientConfigurators,
                                     String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see BlockchainPlatformAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static BlockchainPlatformAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: BlockchainPlatformAsync

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

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

Specified by:

setRegion in interface BlockchainPlatformAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: BlockchainPlatformAsync

Sets the region to call (ex, ‘us-phoenix-1’).

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

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

Specified by:

setRegion in interface BlockchainPlatformAsync

Parameters:

regionId - The public region ID.

changeBlockchainPlatformCompartment

public Future<ChangeBlockchainPlatformCompartmentResponse> changeBlockchainPlatformCompartment(ChangeBlockchainPlatformCompartmentRequest request,
                                                                                               AsyncHandler<ChangeBlockchainPlatformCompartmentRequest,ChangeBlockchainPlatformCompartmentResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Change Blockchain Platform Compartment

Specified by:

changeBlockchainPlatformCompartment in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

createBlockchainPlatform

public Future<CreateBlockchainPlatformResponse> createBlockchainPlatform(CreateBlockchainPlatformRequest request,
                                                                         AsyncHandler<CreateBlockchainPlatformRequest,CreateBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Creates a new Blockchain Platform.

Specified by:

createBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

createOsn

public Future<CreateOsnResponse> createOsn(CreateOsnRequest request,
                                           AsyncHandler<CreateOsnRequest,CreateOsnResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Create Blockchain Platform Osn

Specified by:

createOsn in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

createPeer

public Future<CreatePeerResponse> createPeer(CreatePeerRequest request,
                                             AsyncHandler<CreatePeerRequest,CreatePeerResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Create Blockchain Platform Peer

Specified by:

createPeer in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

deleteBlockchainPlatform

public Future<DeleteBlockchainPlatformResponse> deleteBlockchainPlatform(DeleteBlockchainPlatformRequest request,
                                                                         AsyncHandler<DeleteBlockchainPlatformRequest,DeleteBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Delete a particular of a Blockchain Platform

Specified by:

deleteBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

deleteOsn

public Future<DeleteOsnResponse> deleteOsn(DeleteOsnRequest request,
                                           AsyncHandler<DeleteOsnRequest,DeleteOsnResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Delete a particular OSN of a Blockchain Platform

Specified by:

deleteOsn in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

deletePeer

public Future<DeletePeerResponse> deletePeer(DeletePeerRequest request,
                                             AsyncHandler<DeletePeerRequest,DeletePeerResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Delete a particular peer of a Blockchain Platform

Specified by:

deletePeer in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

deleteWorkRequest

public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request,
                                                           AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Attempts to cancel the work request with the given ID.

Specified by:

deleteWorkRequest in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

getBlockchainPlatform

public Future<GetBlockchainPlatformResponse> getBlockchainPlatform(GetBlockchainPlatformRequest request,
                                                                   AsyncHandler<GetBlockchainPlatformRequest,GetBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Gets information about a Blockchain Platform identified by the specific id

Specified by:

getBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

getOsn

public Future<GetOsnResponse> getOsn(GetOsnRequest request,
                                     AsyncHandler<GetOsnRequest,GetOsnResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Gets information about an OSN identified by the specific id

Specified by:

getOsn in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

getPeer

public Future<GetPeerResponse> getPeer(GetPeerRequest request,
                                       AsyncHandler<GetPeerRequest,GetPeerResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Gets information about a peer identified by the specific id

Specified by:

getPeer in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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: BlockchainPlatformAsync

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listBlockchainPlatformPatches

public Future<ListBlockchainPlatformPatchesResponse> listBlockchainPlatformPatches(ListBlockchainPlatformPatchesRequest request,
                                                                                   AsyncHandler<ListBlockchainPlatformPatchesRequest,ListBlockchainPlatformPatchesResponse> handler)

Description copied from interface: BlockchainPlatformAsync

List Blockchain Platform Patches

Specified by:

listBlockchainPlatformPatches in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listBlockchainPlatforms

public Future<ListBlockchainPlatformsResponse> listBlockchainPlatforms(ListBlockchainPlatformsRequest request,
                                                                       AsyncHandler<ListBlockchainPlatformsRequest,ListBlockchainPlatformsResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Returns a list Blockchain Platform Instances in a compartment

Specified by:

listBlockchainPlatforms in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listOsns

public Future<ListOsnsResponse> listOsns(ListOsnsRequest request,
                                         AsyncHandler<ListOsnsRequest,ListOsnsResponse> handler)

Description copied from interface: BlockchainPlatformAsync

List Blockchain Platform OSNs

Specified by:

listOsns in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

listPeers

public Future<ListPeersResponse> listPeers(ListPeersRequest request,
                                           AsyncHandler<ListPeersRequest,ListPeersResponse> handler)

Description copied from interface: BlockchainPlatformAsync

List Blockchain Platform Peers

Specified by:

listPeers in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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: BlockchainPlatformAsync

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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: BlockchainPlatformAsync

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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: BlockchainPlatformAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

previewScaleBlockchainPlatform

public Future<PreviewScaleBlockchainPlatformResponse> previewScaleBlockchainPlatform(PreviewScaleBlockchainPlatformRequest request,
                                                                                     AsyncHandler<PreviewScaleBlockchainPlatformRequest,PreviewScaleBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Preview Scale Blockchain Platform

Specified by:

previewScaleBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

scaleBlockchainPlatform

public Future<ScaleBlockchainPlatformResponse> scaleBlockchainPlatform(ScaleBlockchainPlatformRequest request,
                                                                       AsyncHandler<ScaleBlockchainPlatformRequest,ScaleBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Scale Blockchain Platform

Specified by:

scaleBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

startBlockchainPlatform

public Future<StartBlockchainPlatformResponse> startBlockchainPlatform(StartBlockchainPlatformRequest request,
                                                                       AsyncHandler<StartBlockchainPlatformRequest,StartBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Start a Blockchain Platform

Specified by:

startBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

stopBlockchainPlatform

public Future<StopBlockchainPlatformResponse> stopBlockchainPlatform(StopBlockchainPlatformRequest request,
                                                                     AsyncHandler<StopBlockchainPlatformRequest,StopBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Stop a Blockchain Platform

Specified by:

stopBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

updateBlockchainPlatform

public Future<UpdateBlockchainPlatformResponse> updateBlockchainPlatform(UpdateBlockchainPlatformRequest request,
                                                                         AsyncHandler<UpdateBlockchainPlatformRequest,UpdateBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Update a particular of a Blockchain Platform

Specified by:

updateBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

updateOsn

public Future<UpdateOsnResponse> updateOsn(UpdateOsnRequest request,
                                           AsyncHandler<UpdateOsnRequest,UpdateOsnResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Update Blockchain Platform OSN

Specified by:

updateOsn in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

updatePeer

public Future<UpdatePeerResponse> updatePeer(UpdatePeerRequest request,
                                             AsyncHandler<UpdatePeerRequest,UpdatePeerResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Update Blockchain Platform Peer

Specified by:

updatePeer in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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.

upgradeBlockchainPlatform

public Future<UpgradeBlockchainPlatformResponse> upgradeBlockchainPlatform(UpgradeBlockchainPlatformRequest request,
                                                                           AsyncHandler<UpgradeBlockchainPlatformRequest,UpgradeBlockchainPlatformResponse> handler)

Description copied from interface: BlockchainPlatformAsync

Upgrade a Blockchain Platform version

Specified by:

upgradeBlockchainPlatform in interface BlockchainPlatformAsync

Parameters:

request - The request object containing the details to send

handler - 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 use

requiredParametersMap - 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 backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

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)