oci-disasterrecovery 2.46.0

package/lib/client.d.ts

@@ -0,0 +1,343 @@
+/**
+ * Full Stack Disaster Recovery API
+ * Use the Full Stack Disaster Recovery (FSDR) API to manage disaster recovery for business applications.
+FSDR is an OCI disaster recovery orchestration and management service that provides comprehensive disaster recovery
+capabilities for all layers of an application stack, including infrastructure, middleware, database, and application.
+
+ * OpenAPI spec version: 20220125
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import common = require("oci-common");
+import * as requests from "./request";
+import * as responses from "./response";
+import { DisasterRecoveryWaiter } from "./disasterrecovery-waiter";
+export declare enum DisasterRecoveryApiKeys {
+}
+/**
+ * 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 DisasterRecoveryClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": DisasterRecoveryWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpOptions: any;
+    targetService: string;
+    protected _httpClient: common.HttpClient;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * 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}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * Creates a new DisasterRecoveryWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): DisasterRecoveryWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): DisasterRecoveryWaiter;
+    /**
+     * Create an association the DR Protection Group identified by *drProtectionGroupId* and
+     * another DR Protection Group in a different region.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param AssociateDrProtectionGroupRequest
+     * @return AssociateDrProtectionGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/AssociateDrProtectionGroup.ts.html |here} to see how to use AssociateDrProtectionGroup API.
+     */
+    associateDrProtectionGroup(associateDrProtectionGroupRequest: requests.AssociateDrProtectionGroupRequest): Promise<responses.AssociateDrProtectionGroupResponse>;
+    /**
+     * Cancel the DR Plan Execution indentified by *drPlanExecutionId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CancelDrPlanExecutionRequest
+     * @return CancelDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/CancelDrPlanExecution.ts.html |here} to see how to use CancelDrPlanExecution API.
+     */
+    cancelDrPlanExecution(cancelDrPlanExecutionRequest: requests.CancelDrPlanExecutionRequest): Promise<responses.CancelDrPlanExecutionResponse>;
+    /**
+     * Cancel the work request identified by *workRequestId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CancelWorkRequestRequest
+     * @return CancelWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     */
+    cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
+    /**
+     * Move the DR Protection Group identified by *drProtectionGroupId* to a different compartment.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ChangeDrProtectionGroupCompartmentRequest
+     * @return ChangeDrProtectionGroupCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/ChangeDrProtectionGroupCompartment.ts.html |here} to see how to use ChangeDrProtectionGroupCompartment API.
+     */
+    changeDrProtectionGroupCompartment(changeDrProtectionGroupCompartmentRequest: requests.ChangeDrProtectionGroupCompartmentRequest): Promise<responses.ChangeDrProtectionGroupCompartmentResponse>;
+    /**
+     * Creates a new DR Plan of the specified DR Plan type.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateDrPlanRequest
+     * @return CreateDrPlanResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/CreateDrPlan.ts.html |here} to see how to use CreateDrPlan API.
+     */
+    createDrPlan(createDrPlanRequest: requests.CreateDrPlanRequest): Promise<responses.CreateDrPlanResponse>;
+    /**
+     * Execute a DR Plan for a DR Protection Group.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateDrPlanExecutionRequest
+     * @return CreateDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/CreateDrPlanExecution.ts.html |here} to see how to use CreateDrPlanExecution API.
+     */
+    createDrPlanExecution(createDrPlanExecutionRequest: requests.CreateDrPlanExecutionRequest): Promise<responses.CreateDrPlanExecutionResponse>;
+    /**
+     * Create a new DR Protection Group.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateDrProtectionGroupRequest
+     * @return CreateDrProtectionGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/CreateDrProtectionGroup.ts.html |here} to see how to use CreateDrProtectionGroup API.
+     */
+    createDrProtectionGroup(createDrProtectionGroupRequest: requests.CreateDrProtectionGroupRequest): Promise<responses.CreateDrProtectionGroupResponse>;
+    /**
+     * Delete the DR Plan identified by *drPlanId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteDrPlanRequest
+     * @return DeleteDrPlanResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/DeleteDrPlan.ts.html |here} to see how to use DeleteDrPlan API.
+     */
+    deleteDrPlan(deleteDrPlanRequest: requests.DeleteDrPlanRequest): Promise<responses.DeleteDrPlanResponse>;
+    /**
+     * Delete the DR Plan Execution identified by *drPlanExecutionId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteDrPlanExecutionRequest
+     * @return DeleteDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/DeleteDrPlanExecution.ts.html |here} to see how to use DeleteDrPlanExecution API.
+     */
+    deleteDrPlanExecution(deleteDrPlanExecutionRequest: requests.DeleteDrPlanExecutionRequest): Promise<responses.DeleteDrPlanExecutionResponse>;
+    /**
+     * Delete the DR Protection Group identified by *drProtectionGroupId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteDrProtectionGroupRequest
+     * @return DeleteDrProtectionGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/DeleteDrProtectionGroup.ts.html |here} to see how to use DeleteDrProtectionGroup API.
+     */
+    deleteDrProtectionGroup(deleteDrProtectionGroupRequest: requests.DeleteDrProtectionGroupRequest): Promise<responses.DeleteDrProtectionGroupResponse>;
+    /**
+     * Delete the association between the DR Protection Group identified by *drProtectionGroupId*.
+     * and its peer DR Protection Group.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DisassociateDrProtectionGroupRequest
+     * @return DisassociateDrProtectionGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/DisassociateDrProtectionGroup.ts.html |here} to see how to use DisassociateDrProtectionGroup API.
+     */
+    disassociateDrProtectionGroup(disassociateDrProtectionGroupRequest: requests.DisassociateDrProtectionGroupRequest): Promise<responses.DisassociateDrProtectionGroupResponse>;
+    /**
+     * Get details for the DR Plan identified by *drPlanId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetDrPlanRequest
+     * @return GetDrPlanResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/GetDrPlan.ts.html |here} to see how to use GetDrPlan API.
+     */
+    getDrPlan(getDrPlanRequest: requests.GetDrPlanRequest): Promise<responses.GetDrPlanResponse>;
+    /**
+     * Get details for the DR Plan Execution identified by *drPlanExecutionId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetDrPlanExecutionRequest
+     * @return GetDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/GetDrPlanExecution.ts.html |here} to see how to use GetDrPlanExecution API.
+     */
+    getDrPlanExecution(getDrPlanExecutionRequest: requests.GetDrPlanExecutionRequest): Promise<responses.GetDrPlanExecutionResponse>;
+    /**
+     * Get the DR Protection Group identified by *drProtectionGroupId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetDrProtectionGroupRequest
+     * @return GetDrProtectionGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/GetDrProtectionGroup.ts.html |here} to see how to use GetDrProtectionGroup API.
+     */
+    getDrProtectionGroup(getDrProtectionGroupRequest: requests.GetDrProtectionGroupRequest): Promise<responses.GetDrProtectionGroupResponse>;
+    /**
+     * Get the status of the work request identified by *workRequestId*.
+     * 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.46.0/disasterrecovery/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Ignore failed group or step in DR Plan Execution identified by *drPlanExecutionId* and resume execution.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param IgnoreDrPlanExecutionRequest
+     * @return IgnoreDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/IgnoreDrPlanExecution.ts.html |here} to see how to use IgnoreDrPlanExecution API.
+     */
+    ignoreDrPlanExecution(ignoreDrPlanExecutionRequest: requests.IgnoreDrPlanExecutionRequest): Promise<responses.IgnoreDrPlanExecutionResponse>;
+    /**
+     * Get a summary list of all DR Plan Executions for a DR Protection Group.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListDrPlanExecutionsRequest
+     * @return ListDrPlanExecutionsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/ListDrPlanExecutions.ts.html |here} to see how to use ListDrPlanExecutions API.
+     */
+    listDrPlanExecutions(listDrPlanExecutionsRequest: requests.ListDrPlanExecutionsRequest): Promise<responses.ListDrPlanExecutionsResponse>;
+    /**
+     * Gets a summary list of all DR Plans for a DR Protection Group.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListDrPlansRequest
+     * @return ListDrPlansResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/ListDrPlans.ts.html |here} to see how to use ListDrPlans API.
+     */
+    listDrPlans(listDrPlansRequest: requests.ListDrPlansRequest): Promise<responses.ListDrPlansResponse>;
+    /**
+     * Gets a summary list of all DR Protection Groups in a compartment.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListDrProtectionGroupsRequest
+     * @return ListDrProtectionGroupsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/ListDrProtectionGroups.ts.html |here} to see how to use ListDrProtectionGroups API.
+     */
+    listDrProtectionGroups(listDrProtectionGroupsRequest: requests.ListDrProtectionGroupsRequest): Promise<responses.ListDrProtectionGroupsResponse>;
+    /**
+     * 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.46.0/disasterrecovery/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 the work request identified by *workRequestId*.
+     *
+     * 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.46.0/disasterrecovery/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.46.0/disasterrecovery/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Pause the DR Plan Execution identified by *drPlanExecutionId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param PauseDrPlanExecutionRequest
+     * @return PauseDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/PauseDrPlanExecution.ts.html |here} to see how to use PauseDrPlanExecution API.
+     */
+    pauseDrPlanExecution(pauseDrPlanExecutionRequest: requests.PauseDrPlanExecutionRequest): Promise<responses.PauseDrPlanExecutionResponse>;
+    /**
+     * Resume the DR Plan Execution identified by *drPlanExecutionId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ResumeDrPlanExecutionRequest
+     * @return ResumeDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/ResumeDrPlanExecution.ts.html |here} to see how to use ResumeDrPlanExecution API.
+     */
+    resumeDrPlanExecution(resumeDrPlanExecutionRequest: requests.ResumeDrPlanExecutionRequest): Promise<responses.ResumeDrPlanExecutionResponse>;
+    /**
+     * Retry failed group or step in DR Plan Execution identified by *drPlanExecutionId* and resume execution.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param RetryDrPlanExecutionRequest
+     * @return RetryDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/RetryDrPlanExecution.ts.html |here} to see how to use RetryDrPlanExecution API.
+     */
+    retryDrPlanExecution(retryDrPlanExecutionRequest: requests.RetryDrPlanExecutionRequest): Promise<responses.RetryDrPlanExecutionResponse>;
+    /**
+     * Update the DR Plan identified by *drPlanId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateDrPlanRequest
+     * @return UpdateDrPlanResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/UpdateDrPlan.ts.html |here} to see how to use UpdateDrPlan API.
+     */
+    updateDrPlan(updateDrPlanRequest: requests.UpdateDrPlanRequest): Promise<responses.UpdateDrPlanResponse>;
+    /**
+     * Update the DR Plan Execution identified by *drPlanExecutionId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateDrPlanExecutionRequest
+     * @return UpdateDrPlanExecutionResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/UpdateDrPlanExecution.ts.html |here} to see how to use UpdateDrPlanExecution API.
+     */
+    updateDrPlanExecution(updateDrPlanExecutionRequest: requests.UpdateDrPlanExecutionRequest): Promise<responses.UpdateDrPlanExecutionResponse>;
+    /**
+     * Update the DR Protection Group identified by *drProtectionGroupId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateDrProtectionGroupRequest
+     * @return UpdateDrProtectionGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/UpdateDrProtectionGroup.ts.html |here} to see how to use UpdateDrProtectionGroup API.
+     */
+    updateDrProtectionGroup(updateDrProtectionGroupRequest: requests.UpdateDrProtectionGroupRequest): Promise<responses.UpdateDrProtectionGroupResponse>;
+    /**
+     * Update the role of the DR Protection Group identified by *drProtectionGroupId*.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateDrProtectionGroupRoleRequest
+     * @return UpdateDrProtectionGroupRoleResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.46.0/disasterrecovery/UpdateDrProtectionGroupRole.ts.html |here} to see how to use UpdateDrProtectionGroupRole API.
+     */
+    updateDrProtectionGroupRole(updateDrProtectionGroupRoleRequest: requests.UpdateDrProtectionGroupRoleRequest): Promise<responses.UpdateDrProtectionGroupRoleResponse>;
+}