oci-blockchain 2.5.2 → 2.8.0

package/lib/client.d.ts

@@ -16,6 +16,9 @@ import * as responses from "./response";
 import { BlockchainPlatformWaiter } from "./blockchainplatform-waiter";
 export declare enum BlockchainPlatformApiKeys {
 }
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
 export declare class BlockchainPlatformClient {
     protected static serviceEndpointTemplate: string;
     protected "_endpoint": string;
@@ -65,206 +68,231 @@ export declare class BlockchainPlatformClient {
     getWaiters(): BlockchainPlatformWaiter;
     /**
      * Change Blockchain Platform Compartment
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeBlockchainPlatformCompartmentRequest
      * @return ChangeBlockchainPlatformCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/ChangeBlockchainPlatformCompartment.ts.html |here} to see how to use ChangeBlockchainPlatformCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/ChangeBlockchainPlatformCompartment.ts.html |here} to see how to use ChangeBlockchainPlatformCompartment API.
      */
     changeBlockchainPlatformCompartment(changeBlockchainPlatformCompartmentRequest: requests.ChangeBlockchainPlatformCompartmentRequest): Promise<responses.ChangeBlockchainPlatformCompartmentResponse>;
     /**
      * Creates a new Blockchain Platform.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateBlockchainPlatformRequest
      * @return CreateBlockchainPlatformResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/CreateBlockchainPlatform.ts.html |here} to see how to use CreateBlockchainPlatform API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/CreateBlockchainPlatform.ts.html |here} to see how to use CreateBlockchainPlatform API.
      */
     createBlockchainPlatform(createBlockchainPlatformRequest: requests.CreateBlockchainPlatformRequest): Promise<responses.CreateBlockchainPlatformResponse>;
     /**
      * Create Blockchain Platform Osn
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateOsnRequest
      * @return CreateOsnResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/CreateOsn.ts.html |here} to see how to use CreateOsn API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/CreateOsn.ts.html |here} to see how to use CreateOsn API.
      */
     createOsn(createOsnRequest: requests.CreateOsnRequest): Promise<responses.CreateOsnResponse>;
     /**
      * Create Blockchain Platform Peer
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreatePeerRequest
      * @return CreatePeerResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/CreatePeer.ts.html |here} to see how to use CreatePeer API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/CreatePeer.ts.html |here} to see how to use CreatePeer API.
      */
     createPeer(createPeerRequest: requests.CreatePeerRequest): Promise<responses.CreatePeerResponse>;
     /**
      * Delete a particular of a Blockchain Platform
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteBlockchainPlatformRequest
      * @return DeleteBlockchainPlatformResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/DeleteBlockchainPlatform.ts.html |here} to see how to use DeleteBlockchainPlatform API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/DeleteBlockchainPlatform.ts.html |here} to see how to use DeleteBlockchainPlatform API.
      */
     deleteBlockchainPlatform(deleteBlockchainPlatformRequest: requests.DeleteBlockchainPlatformRequest): Promise<responses.DeleteBlockchainPlatformResponse>;
     /**
      * Delete a particular OSN of a Blockchain Platform
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteOsnRequest
      * @return DeleteOsnResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/DeleteOsn.ts.html |here} to see how to use DeleteOsn API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/DeleteOsn.ts.html |here} to see how to use DeleteOsn API.
      */
     deleteOsn(deleteOsnRequest: requests.DeleteOsnRequest): Promise<responses.DeleteOsnResponse>;
     /**
      * Delete a particular peer of a Blockchain Platform
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeletePeerRequest
      * @return DeletePeerResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/DeletePeer.ts.html |here} to see how to use DeletePeer API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/DeletePeer.ts.html |here} to see how to use DeletePeer API.
      */
     deletePeer(deletePeerRequest: requests.DeletePeerRequest): Promise<responses.DeletePeerResponse>;
     /**
      * Attempts to cancel the work request with the given ID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteWorkRequestRequest
      * @return DeleteWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/DeleteWorkRequest.ts.html |here} to see how to use DeleteWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/DeleteWorkRequest.ts.html |here} to see how to use DeleteWorkRequest API.
      */
     deleteWorkRequest(deleteWorkRequestRequest: requests.DeleteWorkRequestRequest): Promise<responses.DeleteWorkRequestResponse>;
     /**
      * Gets information about a Blockchain Platform identified by the specific id
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetBlockchainPlatformRequest
      * @return GetBlockchainPlatformResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/GetBlockchainPlatform.ts.html |here} to see how to use GetBlockchainPlatform API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/GetBlockchainPlatform.ts.html |here} to see how to use GetBlockchainPlatform API.
      */
     getBlockchainPlatform(getBlockchainPlatformRequest: requests.GetBlockchainPlatformRequest): Promise<responses.GetBlockchainPlatformResponse>;
     /**
      * 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.
      * @param GetOsnRequest
      * @return GetOsnResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/GetOsn.ts.html |here} to see how to use GetOsn API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/GetOsn.ts.html |here} to see how to use GetOsn API.
      */
     getOsn(getOsnRequest: requests.GetOsnRequest): Promise<responses.GetOsnResponse>;
     /**
      * 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.
      * @param GetPeerRequest
      * @return GetPeerResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/GetPeer.ts.html |here} to see how to use GetPeer API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/GetPeer.ts.html |here} to see how to use GetPeer API.
      */
     getPeer(getPeerRequest: requests.GetPeerRequest): Promise<responses.GetPeerResponse>;
     /**
      * 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.
      * @param GetWorkRequestRequest
      * @return GetWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
      */
     getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
     /**
      * Returns a list Blockchain Platform Instances in a compartment
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListBlockchainPlatformsRequest
      * @return ListBlockchainPlatformsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/ListBlockchainPlatforms.ts.html |here} to see how to use ListBlockchainPlatforms API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/ListBlockchainPlatforms.ts.html |here} to see how to use ListBlockchainPlatforms API.
      */
     listBlockchainPlatforms(listBlockchainPlatformsRequest: requests.ListBlockchainPlatformsRequest): Promise<responses.ListBlockchainPlatformsResponse>;
     /**
      * List Blockchain Platform OSNs
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListOsnsRequest
      * @return ListOsnsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/ListOsns.ts.html |here} to see how to use ListOsns API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/ListOsns.ts.html |here} to see how to use ListOsns API.
      */
     listOsns(listOsnsRequest: requests.ListOsnsRequest): Promise<responses.ListOsnsResponse>;
     /**
      * List Blockchain Platform Peers
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListPeersRequest
      * @return ListPeersResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/ListPeers.ts.html |here} to see how to use ListPeers API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/ListPeers.ts.html |here} to see how to use ListPeers API.
      */
     listPeers(listPeersRequest: requests.ListPeersRequest): Promise<responses.ListPeersResponse>;
     /**
      * 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.
      * @param ListWorkRequestErrorsRequest
      * @return ListWorkRequestErrorsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
      */
     listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
     /**
      * 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.
      * @param ListWorkRequestLogsRequest
      * @return ListWorkRequestLogsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
      */
     listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
     /**
      * Lists the work requests in a compartment.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListWorkRequestsRequest
      * @return ListWorkRequestsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
      */
     listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
     /**
      * Preview Scale Blockchain Platform
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param PreviewScaleBlockchainPlatformRequest
      * @return PreviewScaleBlockchainPlatformResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/PreviewScaleBlockchainPlatform.ts.html |here} to see how to use PreviewScaleBlockchainPlatform API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/PreviewScaleBlockchainPlatform.ts.html |here} to see how to use PreviewScaleBlockchainPlatform API.
      */
     previewScaleBlockchainPlatform(previewScaleBlockchainPlatformRequest: requests.PreviewScaleBlockchainPlatformRequest): Promise<responses.PreviewScaleBlockchainPlatformResponse>;
     /**
      * Scale Blockchain Platform
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ScaleBlockchainPlatformRequest
      * @return ScaleBlockchainPlatformResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/ScaleBlockchainPlatform.ts.html |here} to see how to use ScaleBlockchainPlatform API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/ScaleBlockchainPlatform.ts.html |here} to see how to use ScaleBlockchainPlatform API.
      */
     scaleBlockchainPlatform(scaleBlockchainPlatformRequest: requests.ScaleBlockchainPlatformRequest): Promise<responses.ScaleBlockchainPlatformResponse>;
     /**
      * Start a Blockchain Platform
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param StartBlockchainPlatformRequest
      * @return StartBlockchainPlatformResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/StartBlockchainPlatform.ts.html |here} to see how to use StartBlockchainPlatform API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/StartBlockchainPlatform.ts.html |here} to see how to use StartBlockchainPlatform API.
      */
     startBlockchainPlatform(startBlockchainPlatformRequest: requests.StartBlockchainPlatformRequest): Promise<responses.StartBlockchainPlatformResponse>;
     /**
      * Stop a Blockchain Platform
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param StopBlockchainPlatformRequest
      * @return StopBlockchainPlatformResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/StopBlockchainPlatform.ts.html |here} to see how to use StopBlockchainPlatform API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/StopBlockchainPlatform.ts.html |here} to see how to use StopBlockchainPlatform API.
      */
     stopBlockchainPlatform(stopBlockchainPlatformRequest: requests.StopBlockchainPlatformRequest): Promise<responses.StopBlockchainPlatformResponse>;
     /**
      * Update a particular of a Blockchain Platform
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateBlockchainPlatformRequest
      * @return UpdateBlockchainPlatformResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/UpdateBlockchainPlatform.ts.html |here} to see how to use UpdateBlockchainPlatform API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/UpdateBlockchainPlatform.ts.html |here} to see how to use UpdateBlockchainPlatform API.
      */
     updateBlockchainPlatform(updateBlockchainPlatformRequest: requests.UpdateBlockchainPlatformRequest): Promise<responses.UpdateBlockchainPlatformResponse>;
     /**
      * Update Blockchain Platform OSN
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateOsnRequest
      * @return UpdateOsnResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/UpdateOsn.ts.html |here} to see how to use UpdateOsn API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/UpdateOsn.ts.html |here} to see how to use UpdateOsn API.
      */
     updateOsn(updateOsnRequest: requests.UpdateOsnRequest): Promise<responses.UpdateOsnResponse>;
     /**
      * Update Blockchain Platform Peer
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdatePeerRequest
      * @return UpdatePeerResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/blockchain/UpdatePeer.ts.html |here} to see how to use UpdatePeer API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/blockchain/UpdatePeer.ts.html |here} to see how to use UpdatePeer API.
      */
     updatePeer(updatePeerRequest: requests.UpdatePeerRequest): Promise<responses.UpdatePeerResponse>;
 }