Package com.oracle.bmc.disasterrecovery

Class DisasterRecoveryClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.disasterrecovery.DisasterRecoveryClient

All Implemented Interfaces:

DisasterRecovery, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220125")
public class DisasterRecoveryClient
extends BaseSyncClient
implements DisasterRecovery

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DisasterRecoveryClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for DisasterRecovery.

Constructor Summary

Constructors

Constructor	Description
DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
DisasterRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
DisasterRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
DisasterRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
AssociateDrProtectionGroupResponse	associateDrProtectionGroup(AssociateDrProtectionGroupRequest request)	Create an association between the DR protection group identified by drProtectionGroupId and another DR protection group.
static DisasterRecoveryClient.Builder	builder()	Create a builder for this client.
CancelDrPlanExecutionResponse	cancelDrPlanExecution(CancelDrPlanExecutionRequest request)	Cancel the DR plan execution identified by drPlanExecutionId.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request)	Cancel the work request identified by workRequestId.
ChangeDrProtectionGroupCompartmentResponse	changeDrProtectionGroupCompartment(ChangeDrProtectionGroupCompartmentRequest request)	Move the DR protection group identified by drProtectionGroupId to a different compartment.
void	close()
CreateDrPlanResponse	createDrPlan(CreateDrPlanRequest request)	Create a DR plan of the specified DR plan type.
CreateDrPlanExecutionResponse	createDrPlanExecution(CreateDrPlanExecutionRequest request)	Execute a DR plan for a DR protection group.
CreateDrProtectionGroupResponse	createDrProtectionGroup(CreateDrProtectionGroupRequest request)	Create a DR protection group.
DeleteDrPlanResponse	deleteDrPlan(DeleteDrPlanRequest request)	Delete the DR plan identified by drPlanId.
DeleteDrPlanExecutionResponse	deleteDrPlanExecution(DeleteDrPlanExecutionRequest request)	Delete the DR plan execution identified by drPlanExecutionId.
DeleteDrProtectionGroupResponse	deleteDrProtectionGroup(DeleteDrProtectionGroupRequest request)	Delete the DR protection group identified by drProtectionGroupId.
DisassociateDrProtectionGroupResponse	disassociateDrProtectionGroup(DisassociateDrProtectionGroupRequest request)	Delete the association between the DR protection group identified by drProtectionGroupId.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDrPlanResponse	getDrPlan(GetDrPlanRequest request)	Get details for the DR plan identified by drPlanId.
GetDrPlanExecutionResponse	getDrPlanExecution(GetDrPlanExecutionRequest request)	Get details for the DR plan execution identified by drPlanExecutionId.
GetDrProtectionGroupResponse	getDrProtectionGroup(GetDrProtectionGroupRequest request)	Get the DR protection group identified by drProtectionGroupId.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
DisasterRecoveryPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
DisasterRecoveryWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Get the status of the work request identified by workRequestId.
IgnoreDrPlanExecutionResponse	ignoreDrPlanExecution(IgnoreDrPlanExecutionRequest request)	Ignore the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.
ListDrPlanExecutionsResponse	listDrPlanExecutions(ListDrPlanExecutionsRequest request)	Get a summary list of all DR plan executions for a DR protection group.
ListDrPlansResponse	listDrPlans(ListDrPlansRequest request)	Get a summary list of all DR plans for a DR protection group.
ListDrProtectionGroupsResponse	listDrProtectionGroups(ListDrProtectionGroupsRequest request)	Get a summary list of all DR protection groups in a compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Get a list of work request errors for the work request identified by workRequestId.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Get a list of logs for the work request identified by workRequestId.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	Lists the work requests in a compartment.
PauseDrPlanExecutionResponse	pauseDrPlanExecution(PauseDrPlanExecutionRequest request)	Pause the DR plan execution identified by drPlanExecutionId.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
RefreshDrPlanResponse	refreshDrPlan(RefreshDrPlanRequest request)	Refresh DR Plan identified by drPlanId.
ResumeDrPlanExecutionResponse	resumeDrPlanExecution(ResumeDrPlanExecutionRequest request)	Resume the DR plan execution identified by drPlanExecutionId.
RetryDrPlanExecutionResponse	retryDrPlanExecution(RetryDrPlanExecutionRequest request)	Retry the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateDrPlanResponse	updateDrPlan(UpdateDrPlanRequest request)	Update the DR plan identified by drPlanId.
UpdateDrPlanExecutionResponse	updateDrPlanExecution(UpdateDrPlanExecutionRequest request)	Update the DR plan execution identified by drPlanExecutionId.
UpdateDrProtectionGroupResponse	updateDrProtectionGroup(UpdateDrProtectionGroupRequest request)	Update the DR protection group identified by drProtectionGroupId.
UpdateDrProtectionGroupRoleResponse	updateDrProtectionGroupRole(UpdateDrProtectionGroupRoleRequest request)	Update the role of the DR protection group identified by drProtectionGroupId.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.
VerifyDrPlanResponse	verifyDrPlan(VerifyDrPlanRequest request)	Verify DR Plan identified by drPlanId.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.disasterrecovery.DisasterRecovery

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DisasterRecovery.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

DisasterRecoveryClient

@Deprecated
public DisasterRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DisasterRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DisasterRecoveryClient

@Deprecated
public DisasterRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DisasterRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DisasterRecoveryClient

@Deprecated
public DisasterRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DisasterRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DisasterRecoveryClient

@Deprecated
public DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DisasterRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DisasterRecoveryClient

@Deprecated
public DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DisasterRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DisasterRecoveryClient

@Deprecated
public DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              List<ClientConfigurator> additionalClientConfigurators,
                              String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DisasterRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

DisasterRecoveryClient

@Deprecated
public DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                              List<ClientConfigurator> additionalClientConfigurators,
                              String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DisasterRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

DisasterRecoveryClient

@Deprecated
public DisasterRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                              List<ClientConfigurator> additionalClientConfigurators,
                              String endpoint,
                              ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DisasterRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - DisasterRecoveryClient.Builder.executorService

Method Detail

builder

public static DisasterRecoveryClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DisasterRecovery

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface DisasterRecovery

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DisasterRecovery

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

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface DisasterRecovery

Parameters:

regionId - The public region ID.

associateDrProtectionGroup

public AssociateDrProtectionGroupResponse associateDrProtectionGroup(AssociateDrProtectionGroupRequest request)

Description copied from interface: DisasterRecovery

Create an association between the DR protection group identified by drProtectionGroupId and another DR protection group.

Specified by:

associateDrProtectionGroup in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelDrPlanExecution

public CancelDrPlanExecutionResponse cancelDrPlanExecution(CancelDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Cancel the DR plan execution identified by drPlanExecutionId.

Specified by:

cancelDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: DisasterRecovery

Cancel the work request identified by workRequestId.

Specified by:

cancelWorkRequest in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDrProtectionGroupCompartment

public ChangeDrProtectionGroupCompartmentResponse changeDrProtectionGroupCompartment(ChangeDrProtectionGroupCompartmentRequest request)

Description copied from interface: DisasterRecovery

Move the DR protection group identified by drProtectionGroupId to a different compartment.

Specified by:

changeDrProtectionGroupCompartment in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDrPlan

public CreateDrPlanResponse createDrPlan(CreateDrPlanRequest request)

Description copied from interface: DisasterRecovery

Create a DR plan of the specified DR plan type.

Specified by:

createDrPlan in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDrPlanExecution

public CreateDrPlanExecutionResponse createDrPlanExecution(CreateDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Execute a DR plan for a DR protection group.

Specified by:

createDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDrProtectionGroup

public CreateDrProtectionGroupResponse createDrProtectionGroup(CreateDrProtectionGroupRequest request)

Description copied from interface: DisasterRecovery

Create a DR protection group.

Specified by:

createDrProtectionGroup in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDrPlan

public DeleteDrPlanResponse deleteDrPlan(DeleteDrPlanRequest request)

Description copied from interface: DisasterRecovery

Delete the DR plan identified by drPlanId.

Specified by:

deleteDrPlan in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDrPlanExecution

public DeleteDrPlanExecutionResponse deleteDrPlanExecution(DeleteDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Delete the DR plan execution identified by drPlanExecutionId.

Specified by:

deleteDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDrProtectionGroup

public DeleteDrProtectionGroupResponse deleteDrProtectionGroup(DeleteDrProtectionGroupRequest request)

Description copied from interface: DisasterRecovery

Delete the DR protection group identified by drProtectionGroupId.

Specified by:

deleteDrProtectionGroup in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

disassociateDrProtectionGroup

public DisassociateDrProtectionGroupResponse disassociateDrProtectionGroup(DisassociateDrProtectionGroupRequest request)

Description copied from interface: DisasterRecovery

Delete the association between the DR protection group identified by drProtectionGroupId.

and its peer DR protection group.

Specified by:

disassociateDrProtectionGroup in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDrPlan

public GetDrPlanResponse getDrPlan(GetDrPlanRequest request)

Description copied from interface: DisasterRecovery

Get details for the DR plan identified by drPlanId.

Specified by:

getDrPlan in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDrPlanExecution

public GetDrPlanExecutionResponse getDrPlanExecution(GetDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Get details for the DR plan execution identified by drPlanExecutionId.

Specified by:

getDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDrProtectionGroup

public GetDrProtectionGroupResponse getDrProtectionGroup(GetDrProtectionGroupRequest request)

Description copied from interface: DisasterRecovery

Get the DR protection group identified by drProtectionGroupId.

Specified by:

getDrProtectionGroup in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: DisasterRecovery

Get the status of the work request identified by workRequestId.

Specified by:

getWorkRequest in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

ignoreDrPlanExecution

public IgnoreDrPlanExecutionResponse ignoreDrPlanExecution(IgnoreDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Ignore the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.

Specified by:

ignoreDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDrPlanExecutions

public ListDrPlanExecutionsResponse listDrPlanExecutions(ListDrPlanExecutionsRequest request)

Description copied from interface: DisasterRecovery

Get a summary list of all DR plan executions for a DR protection group.

Specified by:

listDrPlanExecutions in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDrPlans

public ListDrPlansResponse listDrPlans(ListDrPlansRequest request)

Description copied from interface: DisasterRecovery

Get a summary list of all DR plans for a DR protection group.

Specified by:

listDrPlans in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDrProtectionGroups

public ListDrProtectionGroupsResponse listDrProtectionGroups(ListDrProtectionGroupsRequest request)

Description copied from interface: DisasterRecovery

Get a summary list of all DR protection groups in a compartment.

Specified by:

listDrProtectionGroups in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: DisasterRecovery

Get a list of work request errors for the work request identified by workRequestId.

Specified by:

listWorkRequestErrors in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: DisasterRecovery

Get a list of logs for the work request identified by workRequestId.

Specified by:

listWorkRequestLogs in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: DisasterRecovery

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

pauseDrPlanExecution

public PauseDrPlanExecutionResponse pauseDrPlanExecution(PauseDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Pause the DR plan execution identified by drPlanExecutionId.

Specified by:

pauseDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

refreshDrPlan

public RefreshDrPlanResponse refreshDrPlan(RefreshDrPlanRequest request)

Description copied from interface: DisasterRecovery

Refresh DR Plan identified by drPlanId.

Specified by:

refreshDrPlan in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

resumeDrPlanExecution

public ResumeDrPlanExecutionResponse resumeDrPlanExecution(ResumeDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Resume the DR plan execution identified by drPlanExecutionId.

Specified by:

resumeDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

retryDrPlanExecution

public RetryDrPlanExecutionResponse retryDrPlanExecution(RetryDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Retry the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.

Specified by:

retryDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDrPlan

public UpdateDrPlanResponse updateDrPlan(UpdateDrPlanRequest request)

Description copied from interface: DisasterRecovery

Update the DR plan identified by drPlanId.

Specified by:

updateDrPlan in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDrPlanExecution

public UpdateDrPlanExecutionResponse updateDrPlanExecution(UpdateDrPlanExecutionRequest request)

Description copied from interface: DisasterRecovery

Update the DR plan execution identified by drPlanExecutionId.

Specified by:

updateDrPlanExecution in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDrProtectionGroup

public UpdateDrProtectionGroupResponse updateDrProtectionGroup(UpdateDrProtectionGroupRequest request)

Description copied from interface: DisasterRecovery

Update the DR protection group identified by drProtectionGroupId.

Specified by:

updateDrProtectionGroup in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDrProtectionGroupRole

public UpdateDrProtectionGroupRoleResponse updateDrProtectionGroupRole(UpdateDrProtectionGroupRoleRequest request)

Description copied from interface: DisasterRecovery

Update the role of the DR protection group identified by drProtectionGroupId.

Specified by:

updateDrProtectionGroupRole in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

verifyDrPlan

public VerifyDrPlanResponse verifyDrPlan(VerifyDrPlanRequest request)

Description copied from interface: DisasterRecovery

Verify DR Plan identified by drPlanId.

Specified by:

verifyDrPlan in interface DisasterRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DisasterRecoveryWaiters getWaiters()

Description copied from interface: DisasterRecovery

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface DisasterRecovery

Returns:

The service waiters.

getPaginators

public DisasterRecoveryPaginators getPaginators()

Description copied from interface: DisasterRecovery

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface DisasterRecovery

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()