@Generated(value="OracleSDKGenerator", comments="API Version: 20191010") public class BlockchainPlatformClient extends BaseSyncClient implements BlockchainPlatform
Modifier and Type | Class and Description |
---|---|
static class |
BlockchainPlatformClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for BlockchainPlatform.
|
Constructor and Description |
---|
BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
BlockchainPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
BlockchainPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
BlockchainPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint
close
public static final Service SERVICE
Service instance for BlockchainPlatform.
@Deprecated public BlockchainPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockchainPlatformClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public BlockchainPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockchainPlatformClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public BlockchainPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockchainPlatformClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockchainPlatformClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockchainPlatformClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockchainPlatformClient.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)
@Deprecated public BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockchainPlatformClient.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
@Deprecated public BlockchainPlatformClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see BlockchainPlatformClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
- BlockchainPlatformClient.Builder.executorService
public static BlockchainPlatformClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
BlockchainPlatform
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.
setRegion
in interface BlockchainPlatform
region
- The region of the service.public void setRegion(String regionId)
BlockchainPlatform
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
.
setRegion
in interface BlockchainPlatform
regionId
- The public region ID.public ChangeBlockchainPlatformCompartmentResponse changeBlockchainPlatformCompartment(ChangeBlockchainPlatformCompartmentRequest request)
BlockchainPlatform
Change Blockchain Platform Compartment
changeBlockchainPlatformCompartment
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic CreateBlockchainPlatformResponse createBlockchainPlatform(CreateBlockchainPlatformRequest request)
BlockchainPlatform
Creates a new Blockchain Platform.
createBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic CreateOsnResponse createOsn(CreateOsnRequest request)
BlockchainPlatform
Create Blockchain Platform Osn
createOsn
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic CreatePeerResponse createPeer(CreatePeerRequest request)
BlockchainPlatform
Create Blockchain Platform Peer
createPeer
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic DeleteBlockchainPlatformResponse deleteBlockchainPlatform(DeleteBlockchainPlatformRequest request)
BlockchainPlatform
Delete a particular of a Blockchain Platform
deleteBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic DeleteOsnResponse deleteOsn(DeleteOsnRequest request)
BlockchainPlatform
Delete a particular OSN of a Blockchain Platform
deleteOsn
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic DeletePeerResponse deletePeer(DeletePeerRequest request)
BlockchainPlatform
Delete a particular peer of a Blockchain Platform
deletePeer
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
BlockchainPlatform
Attempts to cancel the work request with the given ID.
deleteWorkRequest
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic GetBlockchainPlatformResponse getBlockchainPlatform(GetBlockchainPlatformRequest request)
BlockchainPlatform
Gets information about a Blockchain Platform identified by the specific id
getBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic GetOsnResponse getOsn(GetOsnRequest request)
BlockchainPlatform
Gets information about an OSN identified by the specific id
getOsn
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic GetPeerResponse getPeer(GetPeerRequest request)
BlockchainPlatform
Gets information about a peer identified by the specific id
getPeer
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
BlockchainPlatform
Gets the status of the work request with the given ID.
getWorkRequest
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic ListBlockchainPlatformPatchesResponse listBlockchainPlatformPatches(ListBlockchainPlatformPatchesRequest request)
BlockchainPlatform
List Blockchain Platform Patches
listBlockchainPlatformPatches
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic ListBlockchainPlatformsResponse listBlockchainPlatforms(ListBlockchainPlatformsRequest request)
BlockchainPlatform
Returns a list Blockchain Platform Instances in a compartment
listBlockchainPlatforms
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic ListOsnsResponse listOsns(ListOsnsRequest request)
BlockchainPlatform
List Blockchain Platform OSNs
listOsns
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic ListPeersResponse listPeers(ListPeersRequest request)
BlockchainPlatform
List Blockchain Platform Peers
listPeers
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
BlockchainPlatform
Return a (paginated) list of errors for a given work request.
listWorkRequestErrors
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
BlockchainPlatform
Return a (paginated) list of logs for a given work request.
listWorkRequestLogs
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
BlockchainPlatform
Lists the work requests in a compartment.
listWorkRequests
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic PreviewScaleBlockchainPlatformResponse previewScaleBlockchainPlatform(PreviewScaleBlockchainPlatformRequest request)
BlockchainPlatform
Preview Scale Blockchain Platform
previewScaleBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic ScaleBlockchainPlatformResponse scaleBlockchainPlatform(ScaleBlockchainPlatformRequest request)
BlockchainPlatform
Scale Blockchain Platform
scaleBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic StartBlockchainPlatformResponse startBlockchainPlatform(StartBlockchainPlatformRequest request)
BlockchainPlatform
Start a Blockchain Platform
startBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic StopBlockchainPlatformResponse stopBlockchainPlatform(StopBlockchainPlatformRequest request)
BlockchainPlatform
Stop a Blockchain Platform
stopBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic UpdateBlockchainPlatformResponse updateBlockchainPlatform(UpdateBlockchainPlatformRequest request)
BlockchainPlatform
Update a particular of a Blockchain Platform
updateBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic UpdateOsnResponse updateOsn(UpdateOsnRequest request)
BlockchainPlatform
Update Blockchain Platform OSN
updateOsn
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic UpdatePeerResponse updatePeer(UpdatePeerRequest request)
BlockchainPlatform
Update Blockchain Platform Peer
updatePeer
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic UpgradeBlockchainPlatformResponse upgradeBlockchainPlatform(UpgradeBlockchainPlatformRequest request)
BlockchainPlatform
Upgrade a Blockchain Platform version
upgradeBlockchainPlatform
in interface BlockchainPlatform
request
- The request object containing the details to sendpublic BlockchainPlatformWaiters getWaiters()
BlockchainPlatform
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface BlockchainPlatform
public BlockchainPlatformPaginators getPaginators()
BlockchainPlatform
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
getPaginators
in interface BlockchainPlatform
protected ClientConfigurator getDefaultConfigurator()
public final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
Copyright © 2016–2023. All rights reserved.