Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BlockchainPlatformClient

This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.

Hierarchy

  • BlockchainPlatformClient

Constructors

constructor

  • new BlockchainPlatformClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): BlockchainPlatformClient

Properties

Protected _circuitBreaker

_circuitBreaker: null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _waiters

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://blockchain.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

Methods

changeBlockchainPlatformCompartment

createBlockchainPlatform

  • Creates a new Blockchain Platform.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateBlockchainPlatform API.

    Parameters

    Returns Promise<CreateBlockchainPlatformResponse>

    CreateBlockchainPlatformResponse

createOsn

  • Create Blockchain Platform Osn This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateOsn API.

    Parameters

    Returns Promise<CreateOsnResponse>

    CreateOsnResponse

createPeer

createWaiters

deleteBlockchainPlatform

deleteOsn

  • Delete a particular OSN of a Blockchain Platform This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteOsn API.

    Parameters

    Returns Promise<DeleteOsnResponse>

    DeleteOsnResponse

deletePeer

  • Delete a particular peer of a Blockchain Platform This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeletePeer API.

    Parameters

    Returns Promise<DeletePeerResponse>

    DeletePeerResponse

deleteWorkRequest

getBlockchainPlatform

getOsn

  • Gets information about an OSN identified by the specific id This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetOsn API.

    Parameters

    Returns Promise<GetOsnResponse>

    GetOsnResponse

getPeer

  • Gets information about a peer identified by the specific id This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPeer API.

    Parameters

    Returns Promise<GetPeerResponse>

    GetPeerResponse

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listBlockchainPlatforms

listOsns

  • List Blockchain Platform OSNs This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListOsns API.

    Parameters

    Returns Promise<ListOsnsResponse>

    ListOsnsResponse

listPeers

listWorkRequestErrors

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

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

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

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the work requests in a compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

previewScaleBlockchainPlatform

scaleBlockchainPlatform

startBlockchainPlatform

stopBlockchainPlatform

updateBlockchainPlatform

updateOsn

updatePeer