com.oracle.bmc.recovery.DatabaseRecoveryAsync Maven / Gradle / Ivy
Show all versions of oci-java-sdk-shaded-full Show documentation
/**
* Copyright (c) 2016, 2024, 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.recovery;
import com.oracle.bmc.recovery.requests.*;
import com.oracle.bmc.recovery.responses.*;
/** Use Oracle Database Autonomous Recovery Service API to manage Protected Databases. */
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20210216")
public interface DatabaseRecoveryAsync 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);
/**
* Cancels the scheduled deletion of a protected database, and returns the protected database to
* an ACTIVE state. You can cancel the deletion only if the protected database is in the DELETE
* SCHEDULED state.
*
* @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
cancelProtectedDatabaseDeletion(
CancelProtectedDatabaseDeletionRequest request,
com.oracle.bmc.responses.AsyncHandler<
CancelProtectedDatabaseDeletionRequest,
CancelProtectedDatabaseDeletionResponse>
handler);
/**
* Moves a protected database resource from the existing compartment to the specified
* compartment. When provided, If-Match is checked against ETag values of the resource.
*
* @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
changeProtectedDatabaseCompartment(
ChangeProtectedDatabaseCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeProtectedDatabaseCompartmentRequest,
ChangeProtectedDatabaseCompartmentResponse>
handler);
/**
* Associates the protected database with a new cloud service environment, such as Microsoft
* Azure.
*
* @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
changeProtectedDatabaseSubscription(
ChangeProtectedDatabaseSubscriptionRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeProtectedDatabaseSubscriptionRequest,
ChangeProtectedDatabaseSubscriptionResponse>
handler);
/**
* Moves a protection policy resource from the existing compartment to the specified
* compartment. When provided, If-Match is checked against ETag values of the resource.
*
* @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
changeProtectionPolicyCompartment(
ChangeProtectionPolicyCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeProtectionPolicyCompartmentRequest,
ChangeProtectionPolicyCompartmentResponse>
handler);
/**
* Moves a recovery service subnet resource from the existing compartment to the specified
* compartment. When provided, If-Match is checked against ETag values of the resource.
*
* @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
changeRecoveryServiceSubnetCompartment(
ChangeRecoveryServiceSubnetCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeRecoveryServiceSubnetCompartmentRequest,
ChangeRecoveryServiceSubnetCompartmentResponse>
handler);
/**
* Creates a new Protected Database.
*
* @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 createProtectedDatabase(
CreateProtectedDatabaseRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateProtectedDatabaseRequest, CreateProtectedDatabaseResponse>
handler);
/**
* Creates a new Protection Policy.
*
* @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 createProtectionPolicy(
CreateProtectionPolicyRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateProtectionPolicyRequest, CreateProtectionPolicyResponse>
handler);
/**
* Creates a new Recovery Service Subnet.
*
* @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 createRecoveryServiceSubnet(
CreateRecoveryServiceSubnetRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateRecoveryServiceSubnetRequest, CreateRecoveryServiceSubnetResponse>
handler);
/**
* Deletes a protected database based on the specified protected database ID.
*
* @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 deleteProtectedDatabase(
DeleteProtectedDatabaseRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteProtectedDatabaseRequest, DeleteProtectedDatabaseResponse>
handler);
/**
* Deletes a specified protection policy. You can delete custom policies only. Deleting a Oracle
* predefined policies will result in status code 405 Method Not Allowed.
*
* @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 deleteProtectionPolicy(
DeleteProtectionPolicyRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteProtectionPolicyRequest, DeleteProtectionPolicyResponse>
handler);
/**
* Deletes a specified recovery service subnet.
*
* @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 deleteRecoveryServiceSubnet(
DeleteRecoveryServiceSubnetRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteRecoveryServiceSubnetRequest, DeleteRecoveryServiceSubnetResponse>
handler);
/**
* Downloads the network service configuration file 'tnsnames.ora' for a specified protected
* database. Applies to user-defined recovery systems only.
*
* @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
fetchProtectedDatabaseConfiguration(
FetchProtectedDatabaseConfigurationRequest request,
com.oracle.bmc.responses.AsyncHandler<
FetchProtectedDatabaseConfigurationRequest,
FetchProtectedDatabaseConfigurationResponse>
handler);
/**
* Gets information about a specified protected database.
*
* @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 getProtectedDatabase(
GetProtectedDatabaseRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetProtectedDatabaseRequest, GetProtectedDatabaseResponse>
handler);
/**
* Gets information about a specified protection policy.
*
* @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 getProtectionPolicy(
GetProtectionPolicyRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetProtectionPolicyRequest, GetProtectionPolicyResponse>
handler);
/**
* Gets information about a specified recovery service subnet.
*
* @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 getRecoveryServiceSubnet(
GetRecoveryServiceSubnetRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetRecoveryServiceSubnetRequest, GetRecoveryServiceSubnetResponse>
handler);
/**
* Gets the status of the work request based on the specified ID
*
* @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);
/**
* Lists the protected databases based on the specified parameters.
*
* @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 listProtectedDatabases(
ListProtectedDatabasesRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListProtectedDatabasesRequest, ListProtectedDatabasesResponse>
handler);
/**
* Gets a list of protection policies based on the specified parameters.
*
* @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 listProtectionPolicies(
ListProtectionPoliciesRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListProtectionPoliciesRequest, ListProtectionPoliciesResponse>
handler);
/**
* Returns a list of Recovery Service Subnets.
*
* @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 listRecoveryServiceSubnets(
ListRecoveryServiceSubnetsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListRecoveryServiceSubnetsRequest, ListRecoveryServiceSubnetsResponse>
handler);
/**
* Return a (paginated) list of errors for a given work request.
*
* @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);
/**
* Return a (paginated) list of logs for a given work request.
*
* @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);
/**
* Defines a preferred schedule to delete a protected database after you terminate the source
* database. The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can
* occur 72 hours (3 days) after the source database is terminated. The alternate schedule is
* DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database
* only after the policy-defined backup retention period expires.
*
* @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
scheduleProtectedDatabaseDeletion(
ScheduleProtectedDatabaseDeletionRequest request,
com.oracle.bmc.responses.AsyncHandler<
ScheduleProtectedDatabaseDeletionRequest,
ScheduleProtectedDatabaseDeletionResponse>
handler);
/**
* Updates the Protected Database
*
* @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 updateProtectedDatabase(
UpdateProtectedDatabaseRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateProtectedDatabaseRequest, UpdateProtectedDatabaseResponse>
handler);
/**
* Updates the specified protection policy.
*
* @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 updateProtectionPolicy(
UpdateProtectionPolicyRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateProtectionPolicyRequest, UpdateProtectionPolicyResponse>
handler);
/**
* Updates the specified recovery service subnet.
*
* @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 updateRecoveryServiceSubnet(
UpdateRecoveryServiceSubnetRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateRecoveryServiceSubnetRequest, UpdateRecoveryServiceSubnetResponse>
handler);
}