com.oracle.bmc.disasterrecovery.DisasterRecoveryAsync Maven / Gradle / Ivy
Show all versions of oci-java-sdk-disasterrecovery Show documentation
/**
* Copyright (c) 2016, 2023, 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.
*/
package com.oracle.bmc.disasterrecovery;
import com.oracle.bmc.disasterrecovery.requests.*;
import com.oracle.bmc.disasterrecovery.responses.*;
/**
* Use the Full Stack Disaster Recovery (DR) API to manage disaster recovery for business
* applications. Full Stack DR 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.
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20220125")
public interface DisasterRecoveryAsync extends AutoCloseable {
/** Rebuilds the client from scratch. Useful to refresh certificates. */
void refreshClient();
/**
* Sets the endpoint to call (ex, https://www.example.com).
*
* @param endpoint The endpoint of the serice.
*/
void setEndpoint(String endpoint);
/** Gets the set endpoint for REST call (ex, https://www.example.com) */
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
* Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the
* endpoint. If the service is not available in this region, however, an
* IllegalArgumentException will be raised.
*
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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 {@link
* #setRegion(Region) setRegion}.
*
*
If no known Region could be determined, it will create an endpoint based on the default
* endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
*
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* 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"
*
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint
* template
*/
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled);
/**
* Create an association between the DR protection group identified by *drProtectionGroupId* and
* another DR protection group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future associateDrProtectionGroup(
AssociateDrProtectionGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
AssociateDrProtectionGroupRequest, AssociateDrProtectionGroupResponse>
handler);
/**
* Cancel the DR plan execution identified by *drPlanExecutionId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future cancelDrPlanExecution(
CancelDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
CancelDrPlanExecutionRequest, CancelDrPlanExecutionResponse>
handler);
/**
* Cancel the work request identified by *workRequestId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future cancelWorkRequest(
CancelWorkRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
CancelWorkRequestRequest, CancelWorkRequestResponse>
handler);
/**
* Move the DR protection group identified by *drProtectionGroupId* to a different compartment.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future
changeDrProtectionGroupCompartment(
ChangeDrProtectionGroupCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeDrProtectionGroupCompartmentRequest,
ChangeDrProtectionGroupCompartmentResponse>
handler);
/**
* Create a DR plan of the specified DR plan type.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createDrPlan(
CreateDrPlanRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Execute a DR plan for a DR protection group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createDrPlanExecution(
CreateDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateDrPlanExecutionRequest, CreateDrPlanExecutionResponse>
handler);
/**
* Create a DR protection group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createDrProtectionGroup(
CreateDrProtectionGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateDrProtectionGroupRequest, CreateDrProtectionGroupResponse>
handler);
/**
* Delete the DR plan identified by *drPlanId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteDrPlan(
DeleteDrPlanRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Delete the DR plan execution identified by *drPlanExecutionId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteDrPlanExecution(
DeleteDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteDrPlanExecutionRequest, DeleteDrPlanExecutionResponse>
handler);
/**
* Delete the DR protection group identified by *drProtectionGroupId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteDrProtectionGroup(
DeleteDrProtectionGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteDrProtectionGroupRequest, DeleteDrProtectionGroupResponse>
handler);
/**
* Delete the association between the DR protection group identified by *drProtectionGroupId*.
* and its peer DR protection group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future
disassociateDrProtectionGroup(
DisassociateDrProtectionGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
DisassociateDrProtectionGroupRequest,
DisassociateDrProtectionGroupResponse>
handler);
/**
* Get details for the DR plan identified by *drPlanId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getDrPlan(
GetDrPlanRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Get details for the DR plan execution identified by *drPlanExecutionId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getDrPlanExecution(
GetDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetDrPlanExecutionRequest, GetDrPlanExecutionResponse>
handler);
/**
* Get the DR protection group identified by *drProtectionGroupId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getDrProtectionGroup(
GetDrProtectionGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetDrProtectionGroupRequest, GetDrProtectionGroupResponse>
handler);
/**
* Get the status of the work request identified by *workRequestId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getWorkRequest(
GetWorkRequestRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Ignore the failed group or step in DR plan execution identified by *drPlanExecutionId* and
* resume execution.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future ignoreDrPlanExecution(
IgnoreDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
IgnoreDrPlanExecutionRequest, IgnoreDrPlanExecutionResponse>
handler);
/**
* Get a summary list of all DR plan executions for a DR protection group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listDrPlanExecutions(
ListDrPlanExecutionsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListDrPlanExecutionsRequest, ListDrPlanExecutionsResponse>
handler);
/**
* Get a summary list of all DR plans for a DR protection group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listDrPlans(
ListDrPlansRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Get a summary list of all DR protection groups in a compartment.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listDrProtectionGroups(
ListDrProtectionGroupsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListDrProtectionGroupsRequest, ListDrProtectionGroupsResponse>
handler);
/**
* Get a list of work request errors for the work request identified by *workRequestId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listWorkRequestErrors(
ListWorkRequestErrorsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListWorkRequestErrorsRequest, ListWorkRequestErrorsResponse>
handler);
/**
* Get a list of logs for the work request identified by *workRequestId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listWorkRequestLogs(
ListWorkRequestLogsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListWorkRequestLogsRequest, ListWorkRequestLogsResponse>
handler);
/**
* Lists the work requests in a compartment.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listWorkRequests(
ListWorkRequestsRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Pause the DR plan execution identified by *drPlanExecutionId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future pauseDrPlanExecution(
PauseDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
PauseDrPlanExecutionRequest, PauseDrPlanExecutionResponse>
handler);
/**
* Resume the DR plan execution identified by *drPlanExecutionId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future resumeDrPlanExecution(
ResumeDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
ResumeDrPlanExecutionRequest, ResumeDrPlanExecutionResponse>
handler);
/**
* Retry the failed group or step in DR plan execution identified by *drPlanExecutionId* and
* resume execution.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future retryDrPlanExecution(
RetryDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
RetryDrPlanExecutionRequest, RetryDrPlanExecutionResponse>
handler);
/**
* Update the DR plan identified by *drPlanId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateDrPlan(
UpdateDrPlanRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Update the DR plan execution identified by *drPlanExecutionId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateDrPlanExecution(
UpdateDrPlanExecutionRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateDrPlanExecutionRequest, UpdateDrPlanExecutionResponse>
handler);
/**
* Update the DR protection group identified by *drProtectionGroupId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateDrProtectionGroup(
UpdateDrProtectionGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateDrProtectionGroupRequest, UpdateDrProtectionGroupResponse>
handler);
/**
* Update the role of the DR protection group identified by *drProtectionGroupId*.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateDrProtectionGroupRole(
UpdateDrProtectionGroupRoleRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateDrProtectionGroupRoleRequest, UpdateDrProtectionGroupRoleResponse>
handler);
}