Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BlockchainPlatformClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • BlockchainPlatformClient

Constructors

constructor

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

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "BlockchainPlatform"

Static Protected endpointServiceName

endpointServiceName: string = ""

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

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeBlockchainPlatformCompartment

close

  • close(): void

createBlockchainPlatform

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

listBlockchainPlatformPatches

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

listWorkRequestLogs

listWorkRequests

previewScaleBlockchainPlatform

scaleBlockchainPlatform

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startBlockchainPlatform

stopBlockchainPlatform

updateBlockchainPlatform

updateOsn

updatePeer

upgradeBlockchainPlatform