Package com.oracle.bmc.blockchain

Class BlockchainPlatformClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.blockchain.BlockchainPlatformClient

All Implemented Interfaces:

BlockchainPlatform, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20191010")
public class BlockchainPlatformClient
extends BaseSyncClient
implements BlockchainPlatform

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BlockchainPlatformClient.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
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.

Method Summary

Modifier and Type	Method	Description
static BlockchainPlatformClient.Builder	builder()	Create a builder for this client.
ChangeBlockchainPlatformCompartmentResponse	changeBlockchainPlatformCompartment(ChangeBlockchainPlatformCompartmentRequest request)	Change Blockchain Platform Compartment
void	close()
CreateBlockchainPlatformResponse	createBlockchainPlatform(CreateBlockchainPlatformRequest request)	Creates a new Blockchain Platform.
CreateOsnResponse	createOsn(CreateOsnRequest request)	Create Blockchain Platform Osn
CreatePeerResponse	createPeer(CreatePeerRequest request)	Create Blockchain Platform Peer
DeleteBlockchainPlatformResponse	deleteBlockchainPlatform(DeleteBlockchainPlatformRequest request)	Delete a particular of a Blockchain Platform
DeleteOsnResponse	deleteOsn(DeleteOsnRequest request)	Delete a particular OSN of a Blockchain Platform
DeletePeerResponse	deletePeer(DeletePeerRequest request)	Delete a particular peer of a Blockchain Platform
DeleteWorkRequestResponse	deleteWorkRequest(DeleteWorkRequestRequest request)	Attempts to cancel the work request with the given ID.
GetBlockchainPlatformResponse	getBlockchainPlatform(GetBlockchainPlatformRequest request)	Gets information about a Blockchain Platform identified by the specific id
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOsnResponse	getOsn(GetOsnRequest request)	Gets information about an OSN identified by the specific id
BlockchainPlatformPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPeerResponse	getPeer(GetPeerRequest request)	Gets information about a peer identified by the specific id
BlockchainPlatformWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the status of the work request with the given ID.
ListBlockchainPlatformPatchesResponse	listBlockchainPlatformPatches(ListBlockchainPlatformPatchesRequest request)	List Blockchain Platform Patches
ListBlockchainPlatformsResponse	listBlockchainPlatforms(ListBlockchainPlatformsRequest request)	Returns a list Blockchain Platform Instances in a compartment
ListOsnsResponse	listOsns(ListOsnsRequest request)	List Blockchain Platform OSNs
ListPeersResponse	listPeers(ListPeersRequest request)	List Blockchain Platform Peers
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Return a (paginated) list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	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.
PreviewScaleBlockchainPlatformResponse	previewScaleBlockchainPlatform(PreviewScaleBlockchainPlatformRequest request)	Preview Scale Blockchain Platform
void	refreshClient()	Rebuild the backing HttpClient.
ScaleBlockchainPlatformResponse	scaleBlockchainPlatform(ScaleBlockchainPlatformRequest request)	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’).
StartBlockchainPlatformResponse	startBlockchainPlatform(StartBlockchainPlatformRequest request)	Start a Blockchain Platform
StopBlockchainPlatformResponse	stopBlockchainPlatform(StopBlockchainPlatformRequest request)	Stop a Blockchain Platform
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateBlockchainPlatformResponse	updateBlockchainPlatform(UpdateBlockchainPlatformRequest request)	Update a particular of a Blockchain Platform
UpdateOsnResponse	updateOsn(UpdateOsnRequest request)	Update Blockchain Platform OSN
UpdatePeerResponse	updatePeer(UpdatePeerRequest request)	Update Blockchain Platform Peer
UpgradeBlockchainPlatformResponse	upgradeBlockchainPlatform(UpgradeBlockchainPlatformRequest request)	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 com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.blockchain.BlockchainPlatform

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

BlockchainPlatformClient

@Deprecated
public BlockchainPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

BlockchainPlatformClient

@Deprecated
public BlockchainPlatformClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

BlockchainPlatformClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

BlockchainPlatformClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

BlockchainPlatformClient

@Deprecated
public BlockchainPlatformClient(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 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

BlockchainPlatformClient

@Deprecated
public BlockchainPlatformClient(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 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)

BlockchainPlatformClient

@Deprecated
public BlockchainPlatformClient(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 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

BlockchainPlatformClient

@Deprecated
public 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.

Create a new client instance.

Parameters:

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

Method Detail

builder

public static BlockchainPlatformClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: 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.

Specified by:

setRegion in interface BlockchainPlatform

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface BlockchainPlatform

Parameters:

regionId - The public region ID.

changeBlockchainPlatformCompartment

public ChangeBlockchainPlatformCompartmentResponse changeBlockchainPlatformCompartment(ChangeBlockchainPlatformCompartmentRequest request)

Description copied from interface: BlockchainPlatform

Change Blockchain Platform Compartment

Specified by:

changeBlockchainPlatformCompartment in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createBlockchainPlatform

public CreateBlockchainPlatformResponse createBlockchainPlatform(CreateBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Creates a new Blockchain Platform.

Specified by:

createBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOsn

public CreateOsnResponse createOsn(CreateOsnRequest request)

Description copied from interface: BlockchainPlatform

Create Blockchain Platform Osn

Specified by:

createOsn in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPeer

public CreatePeerResponse createPeer(CreatePeerRequest request)

Description copied from interface: BlockchainPlatform

Create Blockchain Platform Peer

Specified by:

createPeer in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteBlockchainPlatform

public DeleteBlockchainPlatformResponse deleteBlockchainPlatform(DeleteBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Delete a particular of a Blockchain Platform

Specified by:

deleteBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOsn

public DeleteOsnResponse deleteOsn(DeleteOsnRequest request)

Description copied from interface: BlockchainPlatform

Delete a particular OSN of a Blockchain Platform

Specified by:

deleteOsn in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePeer

public DeletePeerResponse deletePeer(DeletePeerRequest request)

Description copied from interface: BlockchainPlatform

Delete a particular peer of a Blockchain Platform

Specified by:

deletePeer in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWorkRequest

public DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)

Description copied from interface: BlockchainPlatform

Attempts to cancel the work request with the given ID.

Specified by:

deleteWorkRequest in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getBlockchainPlatform

public GetBlockchainPlatformResponse getBlockchainPlatform(GetBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Gets information about a Blockchain Platform identified by the specific id

Specified by:

getBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOsn

public GetOsnResponse getOsn(GetOsnRequest request)

Description copied from interface: BlockchainPlatform

Gets information about an OSN identified by the specific id

Specified by:

getOsn in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPeer

public GetPeerResponse getPeer(GetPeerRequest request)

Description copied from interface: BlockchainPlatform

Gets information about a peer identified by the specific id

Specified by:

getPeer in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: BlockchainPlatform

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

Specified by:

getWorkRequest in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBlockchainPlatformPatches

public ListBlockchainPlatformPatchesResponse listBlockchainPlatformPatches(ListBlockchainPlatformPatchesRequest request)

Description copied from interface: BlockchainPlatform

List Blockchain Platform Patches

Specified by:

listBlockchainPlatformPatches in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listBlockchainPlatforms

public ListBlockchainPlatformsResponse listBlockchainPlatforms(ListBlockchainPlatformsRequest request)

Description copied from interface: BlockchainPlatform

Returns a list Blockchain Platform Instances in a compartment

Specified by:

listBlockchainPlatforms in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOsns

public ListOsnsResponse listOsns(ListOsnsRequest request)

Description copied from interface: BlockchainPlatform

List Blockchain Platform OSNs

Specified by:

listOsns in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPeers

public ListPeersResponse listPeers(ListPeersRequest request)

Description copied from interface: BlockchainPlatform

List Blockchain Platform Peers

Specified by:

listPeers in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: BlockchainPlatform

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

Specified by:

listWorkRequestErrors in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: BlockchainPlatform

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

Specified by:

listWorkRequestLogs in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: BlockchainPlatform

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

previewScaleBlockchainPlatform

public PreviewScaleBlockchainPlatformResponse previewScaleBlockchainPlatform(PreviewScaleBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Preview Scale Blockchain Platform

Specified by:

previewScaleBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scaleBlockchainPlatform

public ScaleBlockchainPlatformResponse scaleBlockchainPlatform(ScaleBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Scale Blockchain Platform

Specified by:

scaleBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startBlockchainPlatform

public StartBlockchainPlatformResponse startBlockchainPlatform(StartBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Start a Blockchain Platform

Specified by:

startBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopBlockchainPlatform

public StopBlockchainPlatformResponse stopBlockchainPlatform(StopBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Stop a Blockchain Platform

Specified by:

stopBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateBlockchainPlatform

public UpdateBlockchainPlatformResponse updateBlockchainPlatform(UpdateBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Update a particular of a Blockchain Platform

Specified by:

updateBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOsn

public UpdateOsnResponse updateOsn(UpdateOsnRequest request)

Description copied from interface: BlockchainPlatform

Update Blockchain Platform OSN

Specified by:

updateOsn in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePeer

public UpdatePeerResponse updatePeer(UpdatePeerRequest request)

Description copied from interface: BlockchainPlatform

Update Blockchain Platform Peer

Specified by:

updatePeer in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

upgradeBlockchainPlatform

public UpgradeBlockchainPlatformResponse upgradeBlockchainPlatform(UpgradeBlockchainPlatformRequest request)

Description copied from interface: BlockchainPlatform

Upgrade a Blockchain Platform version

Specified by:

upgradeBlockchainPlatform in interface BlockchainPlatform

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public BlockchainPlatformWaiters getWaiters()

Description copied from interface: BlockchainPlatform

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface BlockchainPlatform

Returns:

The service waiters.

getPaginators

public BlockchainPlatformPaginators getPaginators()

Description copied from interface: 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.

Specified by:

getPaginators in interface BlockchainPlatform

Returns:

The service paginators.

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()