Package com.oracle.bmc.recovery.requests

Class CreateProtectedDatabaseRequest.Builder

java.lang.Object

com.oracle.bmc.recovery.requests.CreateProtectedDatabaseRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<CreateProtectedDatabaseRequest,CreateProtectedDatabaseDetails>

Enclosing class:

CreateProtectedDatabaseRequest

public static class CreateProtectedDatabaseRequest.Builder
extends Object
implements BmcRequest.Builder<CreateProtectedDatabaseRequest,CreateProtectedDatabaseDetails>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateProtectedDatabaseRequest.Builder	body$(CreateProtectedDatabaseDetails body)	Alternative setter for the body parameter.
CreateProtectedDatabaseRequest	build()	Build the instance of CreateProtectedDatabaseRequest as configured by this builder
CreateProtectedDatabaseRequest	buildWithoutInvocationCallback()	Build the instance of CreateProtectedDatabaseRequest as configured by this builder
CreateProtectedDatabaseRequest.Builder	copy(CreateProtectedDatabaseRequest o)	Copy method to populate the builder with values from the given instance.
CreateProtectedDatabaseRequest.Builder	createProtectedDatabaseDetails(CreateProtectedDatabaseDetails createProtectedDatabaseDetails)	Describes the parameters required to create a protected database.
CreateProtectedDatabaseRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
CreateProtectedDatabaseRequest.Builder	opcDryRun(Boolean opcDryRun)	Indicates if the request is to test the preparedness for creating a protected database, without actually creating a protected database.
CreateProtectedDatabaseRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
CreateProtectedDatabaseRequest.Builder	opcRetryToken(String opcRetryToken)	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.
CreateProtectedDatabaseRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

createProtectedDatabaseDetails

public CreateProtectedDatabaseRequest.Builder createProtectedDatabaseDetails(CreateProtectedDatabaseDetails createProtectedDatabaseDetails)

Describes the parameters required to create a protected database.

Parameters:

createProtectedDatabaseDetails - the value to set

Returns:

this builder instance

opcRetryToken

public CreateProtectedDatabaseRequest.Builder opcRetryToken(String opcRetryToken)

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Parameters:

opcRetryToken - the value to set

Returns:

this builder instance

opcRequestId

public CreateProtectedDatabaseRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

opcDryRun

public CreateProtectedDatabaseRequest.Builder opcDryRun(Boolean opcDryRun)

Indicates if the request is to test the preparedness for creating a protected database, without actually creating a protected database.

If you set the opcDryRun option as true, then Recovery Service only performs a test run to check for any missing prerequisites or configurations required to create a protected database, and then returns error messages to warn you about any missing requirements.

If an error occurs, you can review, correct, and repeat the dry run until the createProtectedDatabase request does not return any errors.

These are the common issues that you can identify by performing a dry run of the createProtectedDatabase request:

The Recovery Service subnet has insufficient free IP addresses to support the required number of private endpoints. See, [troubleshooting](https://docs.oracle.com/en/cloud/paas/recovery-service/dbrsu/troubleshoot-backup-failures-recovery-service.html#GUID-05FA08B8-421D-4E52-B84B-7AFB84ADECF9) information * Recovery Service does not have permissions to manage the network resources in a chosen compartment * Recovery Service is out of capacity. See, [Service Limits](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/servicelimits.htm) for more information * Recovery Service resources exceed quota limits * A protected database, having the same database ID, already exists * The specified protection policy does not exist, or it is not in an Active state * The specified Recovery Service subnet does not exist, or it is not in an Active state

See, [Prerequisites for Using Recovery Service](https://docs.oracle.com/en/cloud/paas/recovery-service/dbrsu/backup-recover-recovery-service.html#GUID-B2ABF281-DFF8-4A4E-AC85-629801AAF36A) for more information.

Parameters:

opcDryRun - the value to set

Returns:

this builder instance

invocationCallback

public CreateProtectedDatabaseRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public CreateProtectedDatabaseRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public CreateProtectedDatabaseRequest.Builder copy(CreateProtectedDatabaseRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<CreateProtectedDatabaseRequest,CreateProtectedDatabaseDetails>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public CreateProtectedDatabaseRequest build()

Build the instance of CreateProtectedDatabaseRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<CreateProtectedDatabaseRequest,CreateProtectedDatabaseDetails>

Returns:

instance of CreateProtectedDatabaseRequest

body$

public CreateProtectedDatabaseRequest.Builder body$(CreateProtectedDatabaseDetails body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<CreateProtectedDatabaseRequest,CreateProtectedDatabaseDetails>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public CreateProtectedDatabaseRequest buildWithoutInvocationCallback()

Build the instance of CreateProtectedDatabaseRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of CreateProtectedDatabaseRequest