func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetDatabaseSizesEnumStringValues() []string
GetDatabaseSizesEnumStringValues Enumerates the set of values in String for DatabaseSizesEnum
func GetDeleteProtectedDatabaseDeletionScheduleEnumStringValues() []string
GetDeleteProtectedDatabaseDeletionScheduleEnumStringValues Enumerates the set of values in String for DeleteProtectedDatabaseDeletionScheduleEnum
func GetDeletionScheduleEnumStringValues() []string
GetDeletionScheduleEnumStringValues Enumerates the set of values in String for DeletionScheduleEnum
func GetFetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnumStringValues() []string
GetFetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnumStringValues Enumerates the set of values in String for FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum
func GetHealthEnumStringValues() []string
GetHealthEnumStringValues Enumerates the set of values in String for HealthEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListProtectedDatabasesLifecycleStateEnumStringValues() []string
GetListProtectedDatabasesLifecycleStateEnumStringValues Enumerates the set of values in String for ListProtectedDatabasesLifecycleStateEnum
func GetListProtectedDatabasesSortByEnumStringValues() []string
GetListProtectedDatabasesSortByEnumStringValues Enumerates the set of values in String for ListProtectedDatabasesSortByEnum
func GetListProtectedDatabasesSortOrderEnumStringValues() []string
GetListProtectedDatabasesSortOrderEnumStringValues Enumerates the set of values in String for ListProtectedDatabasesSortOrderEnum
func GetListProtectionPoliciesLifecycleStateEnumStringValues() []string
GetListProtectionPoliciesLifecycleStateEnumStringValues Enumerates the set of values in String for ListProtectionPoliciesLifecycleStateEnum
func GetListProtectionPoliciesOwnerEnumStringValues() []string
GetListProtectionPoliciesOwnerEnumStringValues Enumerates the set of values in String for ListProtectionPoliciesOwnerEnum
func GetListProtectionPoliciesSortByEnumStringValues() []string
GetListProtectionPoliciesSortByEnumStringValues Enumerates the set of values in String for ListProtectionPoliciesSortByEnum
func GetListProtectionPoliciesSortOrderEnumStringValues() []string
GetListProtectionPoliciesSortOrderEnumStringValues Enumerates the set of values in String for ListProtectionPoliciesSortOrderEnum
func GetListRecoveryServiceSubnetsLifecycleStateEnumStringValues() []string
GetListRecoveryServiceSubnetsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRecoveryServiceSubnetsLifecycleStateEnum
func GetListRecoveryServiceSubnetsSortByEnumStringValues() []string
GetListRecoveryServiceSubnetsSortByEnumStringValues Enumerates the set of values in String for ListRecoveryServiceSubnetsSortByEnum
func GetListRecoveryServiceSubnetsSortOrderEnumStringValues() []string
GetListRecoveryServiceSubnetsSortOrderEnumStringValues Enumerates the set of values in String for ListRecoveryServiceSubnetsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelProtectedDatabaseDeletionRequest wrapper for the CancelProtectedDatabaseDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/CancelProtectedDatabaseDeletion.go.html to see an example of how to use CancelProtectedDatabaseDeletionRequest.
type CancelProtectedDatabaseDeletionRequest struct {
// The protected database OCID.
ProtectedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"protectedDatabaseId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelProtectedDatabaseDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelProtectedDatabaseDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelProtectedDatabaseDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelProtectedDatabaseDeletionRequest) String() string
func (request CancelProtectedDatabaseDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelProtectedDatabaseDeletionResponse wrapper for the CancelProtectedDatabaseDeletion operation
type CancelProtectedDatabaseDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelProtectedDatabaseDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelProtectedDatabaseDeletionResponse) String() string
ChangeProtectedDatabaseCompartmentDetails The configuration details required to move a protected database from the existing compartment to a specified compartment.
type ChangeProtectedDatabaseCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the protected database should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeProtectedDatabaseCompartmentDetails) String() string
func (m ChangeProtectedDatabaseCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeProtectedDatabaseCompartmentRequest wrapper for the ChangeProtectedDatabaseCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ChangeProtectedDatabaseCompartment.go.html to see an example of how to use ChangeProtectedDatabaseCompartmentRequest.
type ChangeProtectedDatabaseCompartmentRequest struct {
// The protected database OCID.
ProtectedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"protectedDatabaseId"`
// The configuration details required to move a protected database from the existing compartment to a specified compartment.
ChangeProtectedDatabaseCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeProtectedDatabaseCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeProtectedDatabaseCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeProtectedDatabaseCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeProtectedDatabaseCompartmentRequest) String() string
func (request ChangeProtectedDatabaseCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeProtectedDatabaseCompartmentResponse wrapper for the ChangeProtectedDatabaseCompartment operation
type ChangeProtectedDatabaseCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeProtectedDatabaseCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeProtectedDatabaseCompartmentResponse) String() string
ChangeProtectedDatabaseSubscriptionDetails Subscription details of the new cloud service environment, such as Microsoft Azure, where the protected database will be provisioned.
type ChangeProtectedDatabaseSubscriptionDetails struct {
// The OCID of the new cloud service subscription to which you want to link the protected database.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// Indicates whether it is a Universal Credit Model (UCM) subscription.
IsDefault *bool `mandatory:"false" json:"isDefault"`
}
func (m ChangeProtectedDatabaseSubscriptionDetails) String() string
func (m ChangeProtectedDatabaseSubscriptionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeProtectedDatabaseSubscriptionRequest wrapper for the ChangeProtectedDatabaseSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ChangeProtectedDatabaseSubscription.go.html to see an example of how to use ChangeProtectedDatabaseSubscriptionRequest.
type ChangeProtectedDatabaseSubscriptionRequest struct {
// The protected database OCID.
ProtectedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"protectedDatabaseId"`
// Associate a protected database with a different subscription.
ChangeProtectedDatabaseSubscriptionDetails `contributesTo:"body"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeProtectedDatabaseSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeProtectedDatabaseSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeProtectedDatabaseSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeProtectedDatabaseSubscriptionRequest) String() string
func (request ChangeProtectedDatabaseSubscriptionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeProtectedDatabaseSubscriptionResponse wrapper for the ChangeProtectedDatabaseSubscription operation
type ChangeProtectedDatabaseSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeProtectedDatabaseSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeProtectedDatabaseSubscriptionResponse) String() string
ChangeProtectionPolicyCompartmentDetails The configuration details required to move a protection policy from the existing compartment to a specified compartment.
type ChangeProtectionPolicyCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the Protection Policy should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeProtectionPolicyCompartmentDetails) String() string
func (m ChangeProtectionPolicyCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeProtectionPolicyCompartmentRequest wrapper for the ChangeProtectionPolicyCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ChangeProtectionPolicyCompartment.go.html to see an example of how to use ChangeProtectionPolicyCompartmentRequest.
type ChangeProtectionPolicyCompartmentRequest struct {
// The protection policy OCID.
ProtectionPolicyId *string `mandatory:"true" contributesTo:"path" name:"protectionPolicyId"`
// The configuration details required to move a protection policy from the existing compartment to a specified compartment.
ChangeProtectionPolicyCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeProtectionPolicyCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeProtectionPolicyCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeProtectionPolicyCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeProtectionPolicyCompartmentRequest) String() string
func (request ChangeProtectionPolicyCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeProtectionPolicyCompartmentResponse wrapper for the ChangeProtectionPolicyCompartment operation
type ChangeProtectionPolicyCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeProtectionPolicyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeProtectionPolicyCompartmentResponse) String() string
ChangeRecoveryServiceSubnetCompartmentDetails The configuration details required to move a Recovery Service subnet from the existing compartment to a specified compartment.
type ChangeRecoveryServiceSubnetCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the Recovery Service subnet should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeRecoveryServiceSubnetCompartmentDetails) String() string
func (m ChangeRecoveryServiceSubnetCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeRecoveryServiceSubnetCompartmentRequest wrapper for the ChangeRecoveryServiceSubnetCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ChangeRecoveryServiceSubnetCompartment.go.html to see an example of how to use ChangeRecoveryServiceSubnetCompartmentRequest.
type ChangeRecoveryServiceSubnetCompartmentRequest struct {
// The recovery service subnet OCID.
RecoveryServiceSubnetId *string `mandatory:"true" contributesTo:"path" name:"recoveryServiceSubnetId"`
// The configuration details required to move a Recovery Service subnet from the existing compartment to a specified compartment.
ChangeRecoveryServiceSubnetCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeRecoveryServiceSubnetCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeRecoveryServiceSubnetCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeRecoveryServiceSubnetCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeRecoveryServiceSubnetCompartmentRequest) String() string
func (request ChangeRecoveryServiceSubnetCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeRecoveryServiceSubnetCompartmentResponse wrapper for the ChangeRecoveryServiceSubnetCompartment operation
type ChangeRecoveryServiceSubnetCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeRecoveryServiceSubnetCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeRecoveryServiceSubnetCompartmentResponse) String() string
CreateProtectedDatabaseDetails Describes the parameters required to create a protected database.
type CreateProtectedDatabaseDetails struct {
// The protected database name. You can change the displayName. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
DbUniqueName *string `mandatory:"true" json:"dbUniqueName"`
// Password credential which can be used to connect to Protected Database.
// It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters.
// The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
Password *string `mandatory:"true" json:"password"`
// The OCID of the protection policy associated with the protected database.
ProtectionPolicyId *string `mandatory:"true" json:"protectionPolicyId"`
// List of recovery service subnet resources associated with the protected database.
RecoveryServiceSubnets []RecoveryServiceSubnetInput `mandatory:"true" json:"recoveryServiceSubnets"`
// The OCID of the compartment that contains the protected database.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
DatabaseSize DatabaseSizesEnum `mandatory:"false" json:"databaseSize,omitempty"`
// The OCID of the protected database.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// The size of the database, in gigabytes.
DatabaseSizeInGBs *int `mandatory:"false" json:"databaseSizeInGBs"`
// The percentage of data changes that exist in the database between successive incremental backups.
ChangeRate *float64 `mandatory:"false" json:"changeRate"`
// The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size.
CompressionRatio *float64 `mandatory:"false" json:"compressionRatio"`
// The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service.
// Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
IsRedoLogsShipped *bool `mandatory:"false" json:"isRedoLogsShipped"`
// The OCID of the cloud service subscription to which you want to link the protected database.
// For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateProtectedDatabaseDetails) String() string
func (m CreateProtectedDatabaseDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateProtectedDatabaseRequest wrapper for the CreateProtectedDatabase operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/CreateProtectedDatabase.go.html to see an example of how to use CreateProtectedDatabaseRequest.
type CreateProtectedDatabaseRequest struct {
// Describes the parameters required to create a protected database.
CreateProtectedDatabaseDetails `contributesTo:"body"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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.
OpcDryRun *bool `mandatory:"false" contributesTo:"header" name:"opc-dry-run"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateProtectedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateProtectedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateProtectedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateProtectedDatabaseRequest) String() string
func (request CreateProtectedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateProtectedDatabaseResponse wrapper for the CreateProtectedDatabase operation
type CreateProtectedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProtectedDatabase instance
ProtectedDatabase `presentIn:"body"`
// Relative URL of the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateProtectedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateProtectedDatabaseResponse) String() string
CreateProtectionPolicyDetails Describes the parameters required to create a custom protection policy.
type CreateProtectionPolicyDetails struct {
// A user provided name for the protection policy. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The maximum number of days to retain backups for a protected database.
BackupRetentionPeriodInDays *int `mandatory:"true" json:"backupRetentionPeriodInDays"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned.
// This parameter is applicable if your Oracle Database runs in a different cloud service environment, such as Microsoft Azure.
// If you set the mustEnforceCloudLocality parameter to TRUE, then Recovery Service stores the database backups locally in the same cloud service environment where the database resides. For example, if your Oracle Database is provisioned on Microsoft Azure, then Recovery Service stores the database backups in Azure.
// Note:
// You cannot change the mustEnforceCloudLocality setting for a protection policy after you create it.
MustEnforceCloudLocality *bool `mandatory:"false" json:"mustEnforceCloudLocality"`
// An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
// * The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups.
// * Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect. Therefore, you must set policyLockedDateTime to a date that occurs 14 days after the current date.
// * For example, assuming that the current date is Aug 1, 2023 9 pm, you can set policyLockedDateTime to '2023-08-15T21:00:00.600Z' (Aug 15, 2023, 9:00 pm), or greater.
// * During the 14-day delay period, you can either increase or decrease the retention period in the policy.
// * However, you are only allowed to increase the retention period on or after the retention lock date.
// * You cannot change the value of policyLockedDateTime if the retention lock is already in effect.
PolicyLockedDateTime *string `mandatory:"false" json:"policyLockedDateTime"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateProtectionPolicyDetails) String() string
func (m CreateProtectionPolicyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateProtectionPolicyRequest wrapper for the CreateProtectionPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/CreateProtectionPolicy.go.html to see an example of how to use CreateProtectionPolicyRequest.
type CreateProtectionPolicyRequest struct {
// Describes the parameters required to create a custom protection policy.
CreateProtectionPolicyDetails `contributesTo:"body"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateProtectionPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateProtectionPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateProtectionPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateProtectionPolicyRequest) String() string
func (request CreateProtectionPolicyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateProtectionPolicyResponse wrapper for the CreateProtectionPolicy operation
type CreateProtectionPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProtectionPolicy instance
ProtectionPolicy `presentIn:"body"`
// Relative URL of the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateProtectionPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateProtectionPolicyResponse) String() string
CreateRecoveryServiceSubnetDetails Describes the parameters required to create a Recovery Service Subnet.
type CreateRecoveryServiceSubnetDetails struct {
// A user-provided name for the recovery service subnet. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the virtual cloud network (VCN) that contains the recovery service subnet. You can create a single recovery service subnet per VCN.
VcnId *string `mandatory:"true" json:"vcnId"`
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Deprecated. One of the subnets associated with the Recovery Service subnet.
SubnetId *string `mandatory:"false" json:"subnetId"`
// A list of OCIDs of the subnets associated with the Recovery Service subnet.
Subnets []string `mandatory:"false" json:"subnets"`
// A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet.
// You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet.
// Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet.
// See NetworkSecurityGroup for more information.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateRecoveryServiceSubnetDetails) String() string
func (m CreateRecoveryServiceSubnetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRecoveryServiceSubnetRequest wrapper for the CreateRecoveryServiceSubnet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/CreateRecoveryServiceSubnet.go.html to see an example of how to use CreateRecoveryServiceSubnetRequest.
type CreateRecoveryServiceSubnetRequest struct {
// Describes the parameters required to create a recovery service subnet.
CreateRecoveryServiceSubnetDetails `contributesTo:"body"`
// 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.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateRecoveryServiceSubnetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRecoveryServiceSubnetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRecoveryServiceSubnetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRecoveryServiceSubnetRequest) String() string
func (request CreateRecoveryServiceSubnetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRecoveryServiceSubnetResponse wrapper for the CreateRecoveryServiceSubnet operation
type CreateRecoveryServiceSubnetResponse struct {
// The underlying http response
RawResponse *http.Response
// The RecoveryServiceSubnet instance
RecoveryServiceSubnet `presentIn:"body"`
// Relative URL of the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateRecoveryServiceSubnetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRecoveryServiceSubnetResponse) String() string
DatabaseRecoveryClient a client for DatabaseRecovery
type DatabaseRecoveryClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDatabaseRecoveryClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DatabaseRecoveryClient, err error)
NewDatabaseRecoveryClientWithConfigurationProvider Creates a new default DatabaseRecovery client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDatabaseRecoveryClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DatabaseRecoveryClient, err error)
NewDatabaseRecoveryClientWithOboToken Creates a new default DatabaseRecovery client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client DatabaseRecoveryClient) CancelProtectedDatabaseDeletion(ctx context.Context, request CancelProtectedDatabaseDeletionRequest) (response CancelProtectedDatabaseDeletionResponse, err error)
CancelProtectedDatabaseDeletion 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/CancelProtectedDatabaseDeletion.go.html to see an example of how to use CancelProtectedDatabaseDeletion API. A default retry strategy applies to this operation CancelProtectedDatabaseDeletion()
func (client DatabaseRecoveryClient) ChangeProtectedDatabaseCompartment(ctx context.Context, request ChangeProtectedDatabaseCompartmentRequest) (response ChangeProtectedDatabaseCompartmentResponse, err error)
ChangeProtectedDatabaseCompartment 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ChangeProtectedDatabaseCompartment.go.html to see an example of how to use ChangeProtectedDatabaseCompartment API. A default retry strategy applies to this operation ChangeProtectedDatabaseCompartment()
func (client DatabaseRecoveryClient) ChangeProtectedDatabaseSubscription(ctx context.Context, request ChangeProtectedDatabaseSubscriptionRequest) (response ChangeProtectedDatabaseSubscriptionResponse, err error)
ChangeProtectedDatabaseSubscription Associates the protected database with a new cloud service environment, such as Microsoft Azure.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ChangeProtectedDatabaseSubscription.go.html to see an example of how to use ChangeProtectedDatabaseSubscription API. A default retry strategy applies to this operation ChangeProtectedDatabaseSubscription()
func (client DatabaseRecoveryClient) ChangeProtectionPolicyCompartment(ctx context.Context, request ChangeProtectionPolicyCompartmentRequest) (response ChangeProtectionPolicyCompartmentResponse, err error)
ChangeProtectionPolicyCompartment 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ChangeProtectionPolicyCompartment.go.html to see an example of how to use ChangeProtectionPolicyCompartment API. A default retry strategy applies to this operation ChangeProtectionPolicyCompartment()
func (client DatabaseRecoveryClient) ChangeRecoveryServiceSubnetCompartment(ctx context.Context, request ChangeRecoveryServiceSubnetCompartmentRequest) (response ChangeRecoveryServiceSubnetCompartmentResponse, err error)
ChangeRecoveryServiceSubnetCompartment 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ChangeRecoveryServiceSubnetCompartment.go.html to see an example of how to use ChangeRecoveryServiceSubnetCompartment API. A default retry strategy applies to this operation ChangeRecoveryServiceSubnetCompartment()
func (client *DatabaseRecoveryClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DatabaseRecoveryClient) CreateProtectedDatabase(ctx context.Context, request CreateProtectedDatabaseRequest) (response CreateProtectedDatabaseResponse, err error)
CreateProtectedDatabase Creates a new Protected Database.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/CreateProtectedDatabase.go.html to see an example of how to use CreateProtectedDatabase API. A default retry strategy applies to this operation CreateProtectedDatabase()
func (client DatabaseRecoveryClient) CreateProtectionPolicy(ctx context.Context, request CreateProtectionPolicyRequest) (response CreateProtectionPolicyResponse, err error)
CreateProtectionPolicy Creates a new Protection Policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/CreateProtectionPolicy.go.html to see an example of how to use CreateProtectionPolicy API. A default retry strategy applies to this operation CreateProtectionPolicy()
func (client DatabaseRecoveryClient) CreateRecoveryServiceSubnet(ctx context.Context, request CreateRecoveryServiceSubnetRequest) (response CreateRecoveryServiceSubnetResponse, err error)
CreateRecoveryServiceSubnet Creates a new Recovery Service Subnet.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/CreateRecoveryServiceSubnet.go.html to see an example of how to use CreateRecoveryServiceSubnet API. A default retry strategy applies to this operation CreateRecoveryServiceSubnet()
func (client DatabaseRecoveryClient) DeleteProtectedDatabase(ctx context.Context, request DeleteProtectedDatabaseRequest) (response DeleteProtectedDatabaseResponse, err error)
DeleteProtectedDatabase Deletes a protected database based on the specified protected database ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/DeleteProtectedDatabase.go.html to see an example of how to use DeleteProtectedDatabase API. A default retry strategy applies to this operation DeleteProtectedDatabase()
func (client DatabaseRecoveryClient) DeleteProtectionPolicy(ctx context.Context, request DeleteProtectionPolicyRequest) (response DeleteProtectionPolicyResponse, err error)
DeleteProtectionPolicy 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/DeleteProtectionPolicy.go.html to see an example of how to use DeleteProtectionPolicy API. A default retry strategy applies to this operation DeleteProtectionPolicy()
func (client DatabaseRecoveryClient) DeleteRecoveryServiceSubnet(ctx context.Context, request DeleteRecoveryServiceSubnetRequest) (response DeleteRecoveryServiceSubnetResponse, err error)
DeleteRecoveryServiceSubnet Deletes a specified recovery service subnet.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/DeleteRecoveryServiceSubnet.go.html to see an example of how to use DeleteRecoveryServiceSubnet API. A default retry strategy applies to this operation DeleteRecoveryServiceSubnet()
func (client DatabaseRecoveryClient) FetchProtectedDatabaseConfiguration(ctx context.Context, request FetchProtectedDatabaseConfigurationRequest) (response FetchProtectedDatabaseConfigurationResponse, err error)
FetchProtectedDatabaseConfiguration Downloads the network service configuration file 'tnsnames.ora' for a specified protected database. Applies to user-defined recovery systems only.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/FetchProtectedDatabaseConfiguration.go.html to see an example of how to use FetchProtectedDatabaseConfiguration API. A default retry strategy applies to this operation FetchProtectedDatabaseConfiguration()
func (client DatabaseRecoveryClient) GetProtectedDatabase(ctx context.Context, request GetProtectedDatabaseRequest) (response GetProtectedDatabaseResponse, err error)
GetProtectedDatabase Gets information about a specified protected database.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/GetProtectedDatabase.go.html to see an example of how to use GetProtectedDatabase API. A default retry strategy applies to this operation GetProtectedDatabase()
func (client DatabaseRecoveryClient) GetProtectionPolicy(ctx context.Context, request GetProtectionPolicyRequest) (response GetProtectionPolicyResponse, err error)
GetProtectionPolicy Gets information about a specified protection policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/GetProtectionPolicy.go.html to see an example of how to use GetProtectionPolicy API. A default retry strategy applies to this operation GetProtectionPolicy()
func (client DatabaseRecoveryClient) GetRecoveryServiceSubnet(ctx context.Context, request GetRecoveryServiceSubnetRequest) (response GetRecoveryServiceSubnetResponse, err error)
GetRecoveryServiceSubnet Gets information about a specified recovery service subnet.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/GetRecoveryServiceSubnet.go.html to see an example of how to use GetRecoveryServiceSubnet API. A default retry strategy applies to this operation GetRecoveryServiceSubnet()
func (client DatabaseRecoveryClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request based on the specified ID
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client DatabaseRecoveryClient) ListProtectedDatabases(ctx context.Context, request ListProtectedDatabasesRequest) (response ListProtectedDatabasesResponse, err error)
ListProtectedDatabases Lists the protected databases based on the specified parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListProtectedDatabases.go.html to see an example of how to use ListProtectedDatabases API. A default retry strategy applies to this operation ListProtectedDatabases()
func (client DatabaseRecoveryClient) ListProtectionPolicies(ctx context.Context, request ListProtectionPoliciesRequest) (response ListProtectionPoliciesResponse, err error)
ListProtectionPolicies Gets a list of protection policies based on the specified parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListProtectionPolicies.go.html to see an example of how to use ListProtectionPolicies API. A default retry strategy applies to this operation ListProtectionPolicies()
func (client DatabaseRecoveryClient) ListRecoveryServiceSubnets(ctx context.Context, request ListRecoveryServiceSubnetsRequest) (response ListRecoveryServiceSubnetsResponse, err error)
ListRecoveryServiceSubnets Returns a list of Recovery Service Subnets.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListRecoveryServiceSubnets.go.html to see an example of how to use ListRecoveryServiceSubnets API. A default retry strategy applies to this operation ListRecoveryServiceSubnets()
func (client DatabaseRecoveryClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client DatabaseRecoveryClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client DatabaseRecoveryClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client DatabaseRecoveryClient) ScheduleProtectedDatabaseDeletion(ctx context.Context, request ScheduleProtectedDatabaseDeletionRequest) (response ScheduleProtectedDatabaseDeletionResponse, err error)
ScheduleProtectedDatabaseDeletion 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ScheduleProtectedDatabaseDeletion.go.html to see an example of how to use ScheduleProtectedDatabaseDeletion API. A default retry strategy applies to this operation ScheduleProtectedDatabaseDeletion()
func (client *DatabaseRecoveryClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DatabaseRecoveryClient) UpdateProtectedDatabase(ctx context.Context, request UpdateProtectedDatabaseRequest) (response UpdateProtectedDatabaseResponse, err error)
UpdateProtectedDatabase Updates the Protected Database
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/UpdateProtectedDatabase.go.html to see an example of how to use UpdateProtectedDatabase API. A default retry strategy applies to this operation UpdateProtectedDatabase()
func (client DatabaseRecoveryClient) UpdateProtectionPolicy(ctx context.Context, request UpdateProtectionPolicyRequest) (response UpdateProtectionPolicyResponse, err error)
UpdateProtectionPolicy Updates the specified protection policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/UpdateProtectionPolicy.go.html to see an example of how to use UpdateProtectionPolicy API. A default retry strategy applies to this operation UpdateProtectionPolicy()
func (client DatabaseRecoveryClient) UpdateRecoveryServiceSubnet(ctx context.Context, request UpdateRecoveryServiceSubnetRequest) (response UpdateRecoveryServiceSubnetResponse, err error)
UpdateRecoveryServiceSubnet Updates the specified recovery service subnet.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/UpdateRecoveryServiceSubnet.go.html to see an example of how to use UpdateRecoveryServiceSubnet API. A default retry strategy applies to this operation UpdateRecoveryServiceSubnet()
DatabaseSizesEnum Enum with underlying type: string
type DatabaseSizesEnum string
Set of constants representing the allowable values for DatabaseSizesEnum
const (
DatabaseSizesXs DatabaseSizesEnum = "XS"
DatabaseSizesS DatabaseSizesEnum = "S"
DatabaseSizesM DatabaseSizesEnum = "M"
DatabaseSizesL DatabaseSizesEnum = "L"
DatabaseSizesXl DatabaseSizesEnum = "XL"
DatabaseSizesXxl DatabaseSizesEnum = "XXL"
DatabaseSizesAuto DatabaseSizesEnum = "AUTO"
)
func GetDatabaseSizesEnumValues() []DatabaseSizesEnum
GetDatabaseSizesEnumValues Enumerates the set of values for DatabaseSizesEnum
func GetMappingDatabaseSizesEnum(val string) (DatabaseSizesEnum, bool)
GetMappingDatabaseSizesEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteProtectedDatabaseDeletionScheduleEnum Enum with underlying type: string
type DeleteProtectedDatabaseDeletionScheduleEnum string
Set of constants representing the allowable values for DeleteProtectedDatabaseDeletionScheduleEnum
const (
DeleteProtectedDatabaseDeletionScheduleRetentionPeriod DeleteProtectedDatabaseDeletionScheduleEnum = "DELETE_AFTER_RETENTION_PERIOD"
DeleteProtectedDatabaseDeletionSchedule72Hours DeleteProtectedDatabaseDeletionScheduleEnum = "DELETE_AFTER_72_HOURS"
)
func GetDeleteProtectedDatabaseDeletionScheduleEnumValues() []DeleteProtectedDatabaseDeletionScheduleEnum
GetDeleteProtectedDatabaseDeletionScheduleEnumValues Enumerates the set of values for DeleteProtectedDatabaseDeletionScheduleEnum
func GetMappingDeleteProtectedDatabaseDeletionScheduleEnum(val string) (DeleteProtectedDatabaseDeletionScheduleEnum, bool)
GetMappingDeleteProtectedDatabaseDeletionScheduleEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteProtectedDatabaseRequest wrapper for the DeleteProtectedDatabase operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/DeleteProtectedDatabase.go.html to see an example of how to use DeleteProtectedDatabaseRequest.
type DeleteProtectedDatabaseRequest struct {
// The protected database OCID.
ProtectedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"protectedDatabaseId"`
// 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.
DeletionSchedule DeleteProtectedDatabaseDeletionScheduleEnum `mandatory:"false" contributesTo:"query" name:"deletionSchedule" omitEmpty:"true"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteProtectedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteProtectedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteProtectedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteProtectedDatabaseRequest) String() string
func (request DeleteProtectedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteProtectedDatabaseResponse wrapper for the DeleteProtectedDatabase operation
type DeleteProtectedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteProtectedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteProtectedDatabaseResponse) String() string
DeleteProtectionPolicyRequest wrapper for the DeleteProtectionPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/DeleteProtectionPolicy.go.html to see an example of how to use DeleteProtectionPolicyRequest.
type DeleteProtectionPolicyRequest struct {
// The protection policy OCID.
ProtectionPolicyId *string `mandatory:"true" contributesTo:"path" name:"protectionPolicyId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteProtectionPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteProtectionPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteProtectionPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteProtectionPolicyRequest) String() string
func (request DeleteProtectionPolicyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteProtectionPolicyResponse wrapper for the DeleteProtectionPolicy operation
type DeleteProtectionPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteProtectionPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteProtectionPolicyResponse) String() string
DeleteRecoveryServiceSubnetRequest wrapper for the DeleteRecoveryServiceSubnet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/DeleteRecoveryServiceSubnet.go.html to see an example of how to use DeleteRecoveryServiceSubnetRequest.
type DeleteRecoveryServiceSubnetRequest struct {
// The recovery service subnet OCID.
RecoveryServiceSubnetId *string `mandatory:"true" contributesTo:"path" name:"recoveryServiceSubnetId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteRecoveryServiceSubnetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRecoveryServiceSubnetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRecoveryServiceSubnetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRecoveryServiceSubnetRequest) String() string
func (request DeleteRecoveryServiceSubnetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteRecoveryServiceSubnetResponse wrapper for the DeleteRecoveryServiceSubnet operation
type DeleteRecoveryServiceSubnetResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteRecoveryServiceSubnetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRecoveryServiceSubnetResponse) String() string
DeletionScheduleEnum Enum with underlying type: string
type DeletionScheduleEnum string
Set of constants representing the allowable values for DeletionScheduleEnum
const (
DeletionScheduleDeleteAfterRetentionPeriod DeletionScheduleEnum = "DELETE_AFTER_RETENTION_PERIOD"
DeletionScheduleDeleteAfter72Hours DeletionScheduleEnum = "DELETE_AFTER_72_HOURS"
)
func GetDeletionScheduleEnumValues() []DeletionScheduleEnum
GetDeletionScheduleEnumValues Enumerates the set of values for DeletionScheduleEnum
func GetMappingDeletionScheduleEnum(val string) (DeletionScheduleEnum, bool)
GetMappingDeletionScheduleEnum performs case Insensitive comparison on enum value and return the desired enum
FetchProtectedDatabaseConfigurationDetails Provides which configuration details to get.
type FetchProtectedDatabaseConfigurationDetails struct {
// Currently has four config options ALL, TNSNAMES, HOSTS and CABUNDLE. All will return a zipped folder containing the contents of both tnsnames and the certificateChainPem.
ConfigurationType FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum `mandatory:"false" json:"configurationType,omitempty"`
}
func (m FetchProtectedDatabaseConfigurationDetails) String() string
func (m FetchProtectedDatabaseConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum Enum with underlying type: string
type FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum string
Set of constants representing the allowable values for FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum
const (
FetchProtectedDatabaseConfigurationDetailsConfigurationTypeCabundle FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum = "CABUNDLE"
FetchProtectedDatabaseConfigurationDetailsConfigurationTypeTnsnames FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum = "TNSNAMES"
FetchProtectedDatabaseConfigurationDetailsConfigurationTypeHosts FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum = "HOSTS"
FetchProtectedDatabaseConfigurationDetailsConfigurationTypeRcvconf FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum = "RCVCONF"
FetchProtectedDatabaseConfigurationDetailsConfigurationTypeAll FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum = "ALL"
)
func GetFetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnumValues() []FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum
GetFetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnumValues Enumerates the set of values for FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum
func GetMappingFetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum(val string) (FetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum, bool)
GetMappingFetchProtectedDatabaseConfigurationDetailsConfigurationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FetchProtectedDatabaseConfigurationRequest wrapper for the FetchProtectedDatabaseConfiguration operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/FetchProtectedDatabaseConfiguration.go.html to see an example of how to use FetchProtectedDatabaseConfigurationRequest.
type FetchProtectedDatabaseConfigurationRequest struct {
// The protected database OCID.
ProtectedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"protectedDatabaseId"`
// Which configuration to get
FetchProtectedDatabaseConfigurationDetails `contributesTo:"body"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request FetchProtectedDatabaseConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request FetchProtectedDatabaseConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request FetchProtectedDatabaseConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request FetchProtectedDatabaseConfigurationRequest) String() string
func (request FetchProtectedDatabaseConfigurationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FetchProtectedDatabaseConfigurationResponse wrapper for the FetchProtectedDatabaseConfiguration operation
type FetchProtectedDatabaseConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Contains filename passed in header.
OpcFilename *string `presentIn:"header" name:"opc-filename"`
// Contains file checksum passed in header.
OpcChecksum *string `presentIn:"header" name:"opc-checksum"`
}
func (response FetchProtectedDatabaseConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response FetchProtectedDatabaseConfigurationResponse) String() string
GetProtectedDatabaseRequest wrapper for the GetProtectedDatabase operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/GetProtectedDatabase.go.html to see an example of how to use GetProtectedDatabaseRequest.
type GetProtectedDatabaseRequest struct {
// The protected database OCID.
ProtectedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"protectedDatabaseId"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetProtectedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProtectedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProtectedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProtectedDatabaseRequest) String() string
func (request GetProtectedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetProtectedDatabaseResponse wrapper for the GetProtectedDatabase operation
type GetProtectedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProtectedDatabase instance
ProtectedDatabase `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetProtectedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProtectedDatabaseResponse) String() string
GetProtectionPolicyRequest wrapper for the GetProtectionPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/GetProtectionPolicy.go.html to see an example of how to use GetProtectionPolicyRequest.
type GetProtectionPolicyRequest struct {
// The protection policy OCID.
ProtectionPolicyId *string `mandatory:"true" contributesTo:"path" name:"protectionPolicyId"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetProtectionPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProtectionPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProtectionPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProtectionPolicyRequest) String() string
func (request GetProtectionPolicyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetProtectionPolicyResponse wrapper for the GetProtectionPolicy operation
type GetProtectionPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProtectionPolicy instance
ProtectionPolicy `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetProtectionPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProtectionPolicyResponse) String() string
GetRecoveryServiceSubnetRequest wrapper for the GetRecoveryServiceSubnet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/GetRecoveryServiceSubnet.go.html to see an example of how to use GetRecoveryServiceSubnetRequest.
type GetRecoveryServiceSubnetRequest struct {
// The recovery service subnet OCID.
RecoveryServiceSubnetId *string `mandatory:"true" contributesTo:"path" name:"recoveryServiceSubnetId"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRecoveryServiceSubnetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRecoveryServiceSubnetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRecoveryServiceSubnetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRecoveryServiceSubnetRequest) String() string
func (request GetRecoveryServiceSubnetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetRecoveryServiceSubnetResponse wrapper for the GetRecoveryServiceSubnet operation
type GetRecoveryServiceSubnetResponse struct {
// The underlying http response
RawResponse *http.Response
// The RecoveryServiceSubnet instance
RecoveryServiceSubnet `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetRecoveryServiceSubnetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRecoveryServiceSubnetResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HealthEnum Enum with underlying type: string
type HealthEnum string
Set of constants representing the allowable values for HealthEnum
const (
HealthProtected HealthEnum = "PROTECTED"
HealthWarning HealthEnum = "WARNING"
HealthAlert HealthEnum = "ALERT"
)
func GetHealthEnumValues() []HealthEnum
GetHealthEnumValues Enumerates the set of values for HealthEnum
func GetMappingHealthEnum(val string) (HealthEnum, bool)
GetMappingHealthEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateDeleteScheduled LifecycleStateEnum = "DELETE_SCHEDULED"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectedDatabasesLifecycleStateEnum Enum with underlying type: string
type ListProtectedDatabasesLifecycleStateEnum string
Set of constants representing the allowable values for ListProtectedDatabasesLifecycleStateEnum
const (
ListProtectedDatabasesLifecycleStateCreating ListProtectedDatabasesLifecycleStateEnum = "CREATING"
ListProtectedDatabasesLifecycleStateUpdating ListProtectedDatabasesLifecycleStateEnum = "UPDATING"
ListProtectedDatabasesLifecycleStateActive ListProtectedDatabasesLifecycleStateEnum = "ACTIVE"
ListProtectedDatabasesLifecycleStateDeleteScheduled ListProtectedDatabasesLifecycleStateEnum = "DELETE_SCHEDULED"
ListProtectedDatabasesLifecycleStateDeleting ListProtectedDatabasesLifecycleStateEnum = "DELETING"
ListProtectedDatabasesLifecycleStateDeleted ListProtectedDatabasesLifecycleStateEnum = "DELETED"
ListProtectedDatabasesLifecycleStateFailed ListProtectedDatabasesLifecycleStateEnum = "FAILED"
)
func GetListProtectedDatabasesLifecycleStateEnumValues() []ListProtectedDatabasesLifecycleStateEnum
GetListProtectedDatabasesLifecycleStateEnumValues Enumerates the set of values for ListProtectedDatabasesLifecycleStateEnum
func GetMappingListProtectedDatabasesLifecycleStateEnum(val string) (ListProtectedDatabasesLifecycleStateEnum, bool)
GetMappingListProtectedDatabasesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectedDatabasesRequest wrapper for the ListProtectedDatabases operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListProtectedDatabases.go.html to see an example of how to use ListProtectedDatabasesRequest.
type ListProtectedDatabasesRequest struct {
// The compartment OCID.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only the resources that match the specified lifecycle state.
LifecycleState ListProtectedDatabasesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire 'displayname' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The protected database OCID.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The protection policy OCID.
ProtectionPolicyId *string `mandatory:"false" contributesTo:"query" name:"protectionPolicyId"`
// The recovery service subnet OCID.
RecoveryServiceSubnetId *string `mandatory:"false" contributesTo:"query" name:"recoveryServiceSubnetId"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (ASC) or descending (DESC).
// Allowed values are:
// - ASC
// - DESC
SortOrder ListProtectedDatabasesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If you do not specify a value, then TIMECREATED is used as the default sort order.
// Allowed values are:
// - TIMECREATED
// - DISPLAYNAME
SortBy ListProtectedDatabasesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListProtectedDatabasesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProtectedDatabasesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProtectedDatabasesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProtectedDatabasesRequest) String() string
func (request ListProtectedDatabasesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListProtectedDatabasesResponse wrapper for the ListProtectedDatabases operation
type ListProtectedDatabasesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProtectedDatabaseCollection instances
ProtectedDatabaseCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListProtectedDatabasesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProtectedDatabasesResponse) String() string
ListProtectedDatabasesSortByEnum Enum with underlying type: string
type ListProtectedDatabasesSortByEnum string
Set of constants representing the allowable values for ListProtectedDatabasesSortByEnum
const (
ListProtectedDatabasesSortByTimecreated ListProtectedDatabasesSortByEnum = "timeCreated"
ListProtectedDatabasesSortByDisplayname ListProtectedDatabasesSortByEnum = "displayName"
)
func GetListProtectedDatabasesSortByEnumValues() []ListProtectedDatabasesSortByEnum
GetListProtectedDatabasesSortByEnumValues Enumerates the set of values for ListProtectedDatabasesSortByEnum
func GetMappingListProtectedDatabasesSortByEnum(val string) (ListProtectedDatabasesSortByEnum, bool)
GetMappingListProtectedDatabasesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectedDatabasesSortOrderEnum Enum with underlying type: string
type ListProtectedDatabasesSortOrderEnum string
Set of constants representing the allowable values for ListProtectedDatabasesSortOrderEnum
const (
ListProtectedDatabasesSortOrderAsc ListProtectedDatabasesSortOrderEnum = "ASC"
ListProtectedDatabasesSortOrderDesc ListProtectedDatabasesSortOrderEnum = "DESC"
)
func GetListProtectedDatabasesSortOrderEnumValues() []ListProtectedDatabasesSortOrderEnum
GetListProtectedDatabasesSortOrderEnumValues Enumerates the set of values for ListProtectedDatabasesSortOrderEnum
func GetMappingListProtectedDatabasesSortOrderEnum(val string) (ListProtectedDatabasesSortOrderEnum, bool)
GetMappingListProtectedDatabasesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectionPoliciesLifecycleStateEnum Enum with underlying type: string
type ListProtectionPoliciesLifecycleStateEnum string
Set of constants representing the allowable values for ListProtectionPoliciesLifecycleStateEnum
const (
ListProtectionPoliciesLifecycleStateCreating ListProtectionPoliciesLifecycleStateEnum = "CREATING"
ListProtectionPoliciesLifecycleStateUpdating ListProtectionPoliciesLifecycleStateEnum = "UPDATING"
ListProtectionPoliciesLifecycleStateActive ListProtectionPoliciesLifecycleStateEnum = "ACTIVE"
ListProtectionPoliciesLifecycleStateDeleteScheduled ListProtectionPoliciesLifecycleStateEnum = "DELETE_SCHEDULED"
ListProtectionPoliciesLifecycleStateDeleting ListProtectionPoliciesLifecycleStateEnum = "DELETING"
ListProtectionPoliciesLifecycleStateDeleted ListProtectionPoliciesLifecycleStateEnum = "DELETED"
ListProtectionPoliciesLifecycleStateFailed ListProtectionPoliciesLifecycleStateEnum = "FAILED"
)
func GetListProtectionPoliciesLifecycleStateEnumValues() []ListProtectionPoliciesLifecycleStateEnum
GetListProtectionPoliciesLifecycleStateEnumValues Enumerates the set of values for ListProtectionPoliciesLifecycleStateEnum
func GetMappingListProtectionPoliciesLifecycleStateEnum(val string) (ListProtectionPoliciesLifecycleStateEnum, bool)
GetMappingListProtectionPoliciesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectionPoliciesOwnerEnum Enum with underlying type: string
type ListProtectionPoliciesOwnerEnum string
Set of constants representing the allowable values for ListProtectionPoliciesOwnerEnum
const (
ListProtectionPoliciesOwnerOracle ListProtectionPoliciesOwnerEnum = "oracle"
ListProtectionPoliciesOwnerCustomer ListProtectionPoliciesOwnerEnum = "customer"
)
func GetListProtectionPoliciesOwnerEnumValues() []ListProtectionPoliciesOwnerEnum
GetListProtectionPoliciesOwnerEnumValues Enumerates the set of values for ListProtectionPoliciesOwnerEnum
func GetMappingListProtectionPoliciesOwnerEnum(val string) (ListProtectionPoliciesOwnerEnum, bool)
GetMappingListProtectionPoliciesOwnerEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectionPoliciesRequest wrapper for the ListProtectionPolicies operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListProtectionPolicies.go.html to see an example of how to use ListProtectionPoliciesRequest.
type ListProtectionPoliciesRequest struct {
// The compartment OCID.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ListProtectionPoliciesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire 'displayname' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The protection policy OCID.
ProtectionPolicyId *string `mandatory:"false" contributesTo:"query" name:"protectionPolicyId"`
// A filter to return only the policies that match the owner as 'Customer' or 'Oracle'.
Owner ListProtectionPoliciesOwnerEnum `mandatory:"false" contributesTo:"query" name:"owner" omitEmpty:"true"`
// The maximum number of items to return. Specify a value greater than 4.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (ASC) or descending (DESC).
// Allowed values are:
// - ASC
// - DESC
SortOrder ListProtectionPoliciesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If you do not specify a value, then TIMECREATED is used as the default sort order.
// Allowed values are:
// - TIMECREATED
// - DISPLAYNAME
SortBy ListProtectionPoliciesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListProtectionPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProtectionPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProtectionPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProtectionPoliciesRequest) String() string
func (request ListProtectionPoliciesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListProtectionPoliciesResponse wrapper for the ListProtectionPolicies operation
type ListProtectionPoliciesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProtectionPolicyCollection instances
ProtectionPolicyCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListProtectionPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProtectionPoliciesResponse) String() string
ListProtectionPoliciesSortByEnum Enum with underlying type: string
type ListProtectionPoliciesSortByEnum string
Set of constants representing the allowable values for ListProtectionPoliciesSortByEnum
const (
ListProtectionPoliciesSortByTimecreated ListProtectionPoliciesSortByEnum = "timeCreated"
ListProtectionPoliciesSortByDisplayname ListProtectionPoliciesSortByEnum = "displayName"
)
func GetListProtectionPoliciesSortByEnumValues() []ListProtectionPoliciesSortByEnum
GetListProtectionPoliciesSortByEnumValues Enumerates the set of values for ListProtectionPoliciesSortByEnum
func GetMappingListProtectionPoliciesSortByEnum(val string) (ListProtectionPoliciesSortByEnum, bool)
GetMappingListProtectionPoliciesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectionPoliciesSortOrderEnum Enum with underlying type: string
type ListProtectionPoliciesSortOrderEnum string
Set of constants representing the allowable values for ListProtectionPoliciesSortOrderEnum
const (
ListProtectionPoliciesSortOrderAsc ListProtectionPoliciesSortOrderEnum = "ASC"
ListProtectionPoliciesSortOrderDesc ListProtectionPoliciesSortOrderEnum = "DESC"
)
func GetListProtectionPoliciesSortOrderEnumValues() []ListProtectionPoliciesSortOrderEnum
GetListProtectionPoliciesSortOrderEnumValues Enumerates the set of values for ListProtectionPoliciesSortOrderEnum
func GetMappingListProtectionPoliciesSortOrderEnum(val string) (ListProtectionPoliciesSortOrderEnum, bool)
GetMappingListProtectionPoliciesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecoveryServiceSubnetsLifecycleStateEnum Enum with underlying type: string
type ListRecoveryServiceSubnetsLifecycleStateEnum string
Set of constants representing the allowable values for ListRecoveryServiceSubnetsLifecycleStateEnum
const (
ListRecoveryServiceSubnetsLifecycleStateCreating ListRecoveryServiceSubnetsLifecycleStateEnum = "CREATING"
ListRecoveryServiceSubnetsLifecycleStateUpdating ListRecoveryServiceSubnetsLifecycleStateEnum = "UPDATING"
ListRecoveryServiceSubnetsLifecycleStateActive ListRecoveryServiceSubnetsLifecycleStateEnum = "ACTIVE"
ListRecoveryServiceSubnetsLifecycleStateDeleteScheduled ListRecoveryServiceSubnetsLifecycleStateEnum = "DELETE_SCHEDULED"
ListRecoveryServiceSubnetsLifecycleStateDeleting ListRecoveryServiceSubnetsLifecycleStateEnum = "DELETING"
ListRecoveryServiceSubnetsLifecycleStateDeleted ListRecoveryServiceSubnetsLifecycleStateEnum = "DELETED"
ListRecoveryServiceSubnetsLifecycleStateFailed ListRecoveryServiceSubnetsLifecycleStateEnum = "FAILED"
)
func GetListRecoveryServiceSubnetsLifecycleStateEnumValues() []ListRecoveryServiceSubnetsLifecycleStateEnum
GetListRecoveryServiceSubnetsLifecycleStateEnumValues Enumerates the set of values for ListRecoveryServiceSubnetsLifecycleStateEnum
func GetMappingListRecoveryServiceSubnetsLifecycleStateEnum(val string) (ListRecoveryServiceSubnetsLifecycleStateEnum, bool)
GetMappingListRecoveryServiceSubnetsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecoveryServiceSubnetsRequest wrapper for the ListRecoveryServiceSubnets operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListRecoveryServiceSubnets.go.html to see an example of how to use ListRecoveryServiceSubnetsRequest.
type ListRecoveryServiceSubnetsRequest struct {
// The compartment OCID.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only the resources that match the specified lifecycle state.
LifecycleState ListRecoveryServiceSubnetsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire 'displayname' given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The recovery service subnet OCID.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The OCID of the virtual cloud network (VCN) associated with the recovery service subnet.
VcnId *string `mandatory:"false" contributesTo:"query" name:"vcnId"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (ASC) or descending (DESC).
// Allowed values are:
// - ASC
// - DESC
SortOrder ListRecoveryServiceSubnetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If you do not specify a value, then TIMECREATED is used as the default sort order.
// Allowed values are:
// - TIMECREATED
// - DISPLAYNAME
SortBy ListRecoveryServiceSubnetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRecoveryServiceSubnetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRecoveryServiceSubnetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRecoveryServiceSubnetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRecoveryServiceSubnetsRequest) String() string
func (request ListRecoveryServiceSubnetsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListRecoveryServiceSubnetsResponse wrapper for the ListRecoveryServiceSubnets operation
type ListRecoveryServiceSubnetsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RecoveryServiceSubnetCollection instances
RecoveryServiceSubnetCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListRecoveryServiceSubnetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRecoveryServiceSubnetsResponse) String() string
ListRecoveryServiceSubnetsSortByEnum Enum with underlying type: string
type ListRecoveryServiceSubnetsSortByEnum string
Set of constants representing the allowable values for ListRecoveryServiceSubnetsSortByEnum
const (
ListRecoveryServiceSubnetsSortByTimecreated ListRecoveryServiceSubnetsSortByEnum = "timeCreated"
ListRecoveryServiceSubnetsSortByDisplayname ListRecoveryServiceSubnetsSortByEnum = "displayName"
)
func GetListRecoveryServiceSubnetsSortByEnumValues() []ListRecoveryServiceSubnetsSortByEnum
GetListRecoveryServiceSubnetsSortByEnumValues Enumerates the set of values for ListRecoveryServiceSubnetsSortByEnum
func GetMappingListRecoveryServiceSubnetsSortByEnum(val string) (ListRecoveryServiceSubnetsSortByEnum, bool)
GetMappingListRecoveryServiceSubnetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecoveryServiceSubnetsSortOrderEnum Enum with underlying type: string
type ListRecoveryServiceSubnetsSortOrderEnum string
Set of constants representing the allowable values for ListRecoveryServiceSubnetsSortOrderEnum
const (
ListRecoveryServiceSubnetsSortOrderAsc ListRecoveryServiceSubnetsSortOrderEnum = "ASC"
ListRecoveryServiceSubnetsSortOrderDesc ListRecoveryServiceSubnetsSortOrderEnum = "DESC"
)
func GetListRecoveryServiceSubnetsSortOrderEnumValues() []ListRecoveryServiceSubnetsSortOrderEnum
GetListRecoveryServiceSubnetsSortOrderEnumValues Enumerates the set of values for ListRecoveryServiceSubnetsSortOrderEnum
func GetMappingListRecoveryServiceSubnetsSortOrderEnum(val string) (ListRecoveryServiceSubnetsSortOrderEnum, bool)
GetMappingListRecoveryServiceSubnetsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (ASC) or descending (DESC).
// Allowed values are:
// - ASC
// - DESC
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (ASC) or descending (DESC).
// Allowed values are:
// - ASC
// - DESC
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The compartment OCID.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier of the work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only resources their lifecycleState matches the given OperationStatus.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either ascending (ASC) or descending (DESC).
// Allowed values are:
// - ASC
// - DESC
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
Metrics Backup performance and storage utilization metrics for the protected database.
type Metrics struct {
// Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used.
BackupSpaceUsedInGBs *float32 `mandatory:"false" json:"backupSpaceUsedInGBs"`
// The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database.
BackupSpaceEstimateInGBs *float32 `mandatory:"false" json:"backupSpaceEstimateInGBs"`
// This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available.
// This is the time we received the last backup or last redo-log shipped.
UnprotectedWindowInSeconds *float32 `mandatory:"false" json:"unprotectedWindowInSeconds"`
// The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs.
DbSizeInGBs *float32 `mandatory:"false" json:"dbSizeInGBs"`
// The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service.
// Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
IsRedoLogsEnabled *bool `mandatory:"false" json:"isRedoLogsEnabled"`
// The maximum number of days to retain backups for a protected database.
RetentionPeriodInDays *float32 `mandatory:"false" json:"retentionPeriodInDays"`
// Number of seconds backups are currently retained for this database.
CurrentRetentionPeriodInSeconds *float32 `mandatory:"false" json:"currentRetentionPeriodInSeconds"`
// Number of days of redo/archive to be applied to recover database.
MinimumRecoveryNeededInDays *float32 `mandatory:"false" json:"minimumRecoveryNeededInDays"`
}
func (m Metrics) String() string
func (m Metrics) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MetricsSummary Backup performance and storage utilization metrics for the Protected Database.
type MetricsSummary struct {
// Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used.
BackupSpaceUsedInGBs *float32 `mandatory:"false" json:"backupSpaceUsedInGBs"`
// The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database.
BackupSpaceEstimateInGBs *float32 `mandatory:"false" json:"backupSpaceEstimateInGBs"`
// This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available.
// This is the time we received the last backup or last redo-log shipped.
UnprotectedWindowInSeconds *float32 `mandatory:"false" json:"unprotectedWindowInSeconds"`
// The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs.
DbSizeInGBs *float32 `mandatory:"false" json:"dbSizeInGBs"`
// The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service.
// Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
IsRedoLogsEnabled *bool `mandatory:"false" json:"isRedoLogsEnabled"`
// The maximum number of days to retain backups for a protected database.
RetentionPeriodInDays *float32 `mandatory:"false" json:"retentionPeriodInDays"`
// Number of seconds backups are currently retained for this database.
CurrentRetentionPeriodInSeconds *float32 `mandatory:"false" json:"currentRetentionPeriodInSeconds"`
// Number of days of redo/archive to be applied to recover database.
MinimumRecoveryNeededInDays *float32 `mandatory:"false" json:"minimumRecoveryNeededInDays"`
}
func (m MetricsSummary) String() string
func (m MetricsSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateProtectedDatabase OperationTypeEnum = "CREATE_PROTECTED_DATABASE"
OperationTypeUpdateProtectedDatabase OperationTypeEnum = "UPDATE_PROTECTED_DATABASE"
OperationTypeDeleteProtectedDatabase OperationTypeEnum = "DELETE_PROTECTED_DATABASE"
OperationTypeMoveProtectedDatabase OperationTypeEnum = "MOVE_PROTECTED_DATABASE"
OperationTypeCreateProtectionPolicy OperationTypeEnum = "CREATE_PROTECTION_POLICY"
OperationTypeUpdateProtectionPolicy OperationTypeEnum = "UPDATE_PROTECTION_POLICY"
OperationTypeDeleteProtectionPolicy OperationTypeEnum = "DELETE_PROTECTION_POLICY"
OperationTypeMoveProtectionPolicy OperationTypeEnum = "MOVE_PROTECTION_POLICY"
OperationTypeCreateRecoveryServiceSubnet OperationTypeEnum = "CREATE_RECOVERY_SERVICE_SUBNET"
OperationTypeUpdateRecoveryServiceSubnet OperationTypeEnum = "UPDATE_RECOVERY_SERVICE_SUBNET"
OperationTypeDeleteRecoveryServiceSubnet OperationTypeEnum = "DELETE_RECOVERY_SERVICE_SUBNET"
OperationTypeMoveRecoveryServiceSubnet OperationTypeEnum = "MOVE_RECOVERY_SERVICE_SUBNET"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
ProtectedDatabase A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery
type ProtectedDatabase struct {
// The OCID of the protected database.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the protected database.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
DbUniqueName *string `mandatory:"true" json:"dbUniqueName"`
// The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
VpcUserName *string `mandatory:"true" json:"vpcUserName"`
// The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
DatabaseSize DatabaseSizesEnum `mandatory:"true" json:"databaseSize"`
// The OCID of the protection policy associated with the protected database.
ProtectionPolicyId *string `mandatory:"true" json:"protectionPolicyId"`
// List of recovery service subnet resources associated with the protected database.
RecoveryServiceSubnets []RecoveryServiceSubnetDetails `mandatory:"true" json:"recoveryServiceSubnets"`
// The protected database name. You can change the displayName. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
// The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups.
// Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect.
PolicyLockedDateTime *string `mandatory:"false" json:"policyLockedDateTime"`
// The OCID of the protected database.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// The size of the database in GBs, in gigabytes.
DatabaseSizeInGBs *int `mandatory:"false" json:"databaseSizeInGBs"`
// The percentage of data changes that exist in the database between successive incremental backups.
ChangeRate *float64 `mandatory:"false" json:"changeRate"`
// The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size.
CompressionRatio *float64 `mandatory:"false" json:"compressionRatio"`
// The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service.
// Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional
// configuration is needed on client side.
IsRedoLogsShipped *bool `mandatory:"false" json:"isRedoLogsShipped"`
// An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the Protected Database.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Indicates the protection status of the database.
// A 'PROTECTED' status indicates that Recovery Service can ensure database recovery to any point in time within the entire recovery window. The potential data loss exposure since the last backup is:
// - Less than 10 seconds, if Real-time data protection is enabled
// - Less than 70 minutes if Real-time data protection is disabled
// A 'WARNING' status indicates that Recovery Service can ensure database recovery within the current recovery window - 1 day. The potential data loss exposure since the last backup is:
// - Greater than 10 seconds, if Real-time data protection is enabled
// - Greater than 60 minutes, if if Real-time data protection is disabled
// An 'ALERT' status indicates that Recovery Service cannot recover the database within the current recovery window.
Health HealthEnum `mandatory:"false" json:"health,omitempty"`
// Indicates whether the protected database is created by Recovery Service or created manually.
// Set to <b>TRUE</b> for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource.
// Set to <b>FALSE</b> for a user-defined protected database.
IsReadOnlyResource *bool `mandatory:"false" json:"isReadOnlyResource"`
// Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A message describing the current health of the protected database.
HealthDetails *string `mandatory:"false" json:"healthDetails"`
Metrics *Metrics `mandatory:"false" json:"metrics"`
// The OCID of the cloud service subscription to which the protected database is linked.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ProtectedDatabase) String() string
func (m ProtectedDatabase) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProtectedDatabaseCollection Results of a protected database search operation. The results contain protected database summary and metadata information.
type ProtectedDatabaseCollection struct {
// List of protected databases.
Items []ProtectedDatabaseSummary `mandatory:"true" json:"items"`
}
func (m ProtectedDatabaseCollection) String() string
func (m ProtectedDatabaseCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProtectedDatabaseSummary A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). For information about access control and compartments, see Overview of the Identity Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
type ProtectedDatabaseSummary struct {
// The OCID of the protected database.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the protected database.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
DbUniqueName *string `mandatory:"true" json:"dbUniqueName"`
// The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
VpcUserName *string `mandatory:"true" json:"vpcUserName"`
// The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
DatabaseSize DatabaseSizesEnum `mandatory:"true" json:"databaseSize"`
// The OCID of the protection policy associated with the protected database.
ProtectionPolicyId *string `mandatory:"true" json:"protectionPolicyId"`
// The protected database name. You can change the displayName. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
// The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups.
// Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect.
PolicyLockedDateTime *string `mandatory:"false" json:"policyLockedDateTime"`
// List of recovery service subnet resources associated with the protected database.
RecoveryServiceSubnets []RecoveryServiceSubnetDetails `mandatory:"false" json:"recoveryServiceSubnets"`
// The OCID of the protected database.
DatabaseId *string `mandatory:"false" json:"databaseId"`
// An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z'
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z'
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the Protected Database.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The health of the Protected Database.
Health HealthEnum `mandatory:"false" json:"health,omitempty"`
// Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A message describing the current health of the protected database.
HealthDetails *string `mandatory:"false" json:"healthDetails"`
// Indicates whether the protected database is created by Recovery Service or created manually.
// Set to <b>TRUE</b> for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource.
// Set to <b>FALSE</b> for a user-defined protected database.
IsReadOnlyResource *bool `mandatory:"false" json:"isReadOnlyResource"`
Metrics *MetricsSummary `mandatory:"false" json:"metrics"`
// The OCID of the cloud service subscription to which the protected database is linked.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ProtectedDatabaseSummary) String() string
func (m ProtectedDatabaseSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProtectionPolicy The details of a protection policy.A policy defines the exact number of days to retain protected database backups created by Recovery Service. Each protected database must be associated with one protection policy. You can use Oracle-defined protection policies or create custom policies to suit your internal backup storage regulation demands.
type ProtectionPolicy struct {
// The protection policy OCID.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the protection policy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The maximum number of days to retain backups for a protected database. Specify a period ranging from a minimum 14 days to a maximum 95 days. For example, specify the value 55 if you want to retain backups for 55 days.
BackupRetentionPeriodInDays *int `mandatory:"true" json:"backupRetentionPeriodInDays"`
// Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies.
IsPredefinedPolicy *bool `mandatory:"true" json:"isPredefinedPolicy"`
// A user provided name for the protection policy.
DisplayName *string `mandatory:"false" json:"displayName"`
// An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
PolicyLockedDateTime *string `mandatory:"false" json:"policyLockedDateTime"`
// Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned.
MustEnforceCloudLocality *bool `mandatory:"false" json:"mustEnforceCloudLocality"`
// An RFC3339 formatted datetime string that indicates the created time for the protection policy. For example: '2020-05-22T21:10:29.600Z'.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// An RFC3339 formatted datetime string that indicates the updated time for the protection policy. For example: '2020-05-22T21:10:29.600Z'.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the protection policy.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ProtectionPolicy) String() string
func (m ProtectionPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProtectionPolicyCollection Results of a Protection Policy search. Contains both Protection Policy Summary items and other information, such as metadata.
type ProtectionPolicyCollection struct {
// List of ProtectionPolicies.
Items []ProtectionPolicySummary `mandatory:"true" json:"items"`
}
func (m ProtectionPolicyCollection) String() string
func (m ProtectionPolicyCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProtectionPolicySummary Recovery Service enables policy driven backup storage management. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). For information about access control and compartments, see Overview of the Identity Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
type ProtectionPolicySummary struct {
// The protection policy OCID.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the protection policy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The maximum number of days to retain backups for a protected database.
BackupRetentionPeriodInDays *int `mandatory:"true" json:"backupRetentionPeriodInDays"`
// Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies.
IsPredefinedPolicy *bool `mandatory:"true" json:"isPredefinedPolicy"`
// A user provided name for the protection policy.
DisplayName *string `mandatory:"false" json:"displayName"`
// An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
PolicyLockedDateTime *string `mandatory:"false" json:"policyLockedDateTime"`
// Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned.
MustEnforceCloudLocality *bool `mandatory:"false" json:"mustEnforceCloudLocality"`
// The time the Protection Policy was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the Protection Policy was updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the Protection Policy.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ProtectionPolicySummary) String() string
func (m ProtectionPolicySummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecoveryServiceSubnet The details of a recovery service subnet. Recovery service subnets allows Recovery Service to access protected databases in each VCN. Each recovery service subnet uses a single private endpoint on a subnet of your choice within a VCN. The private endpoint need not be on the same subnet as the Oracle Cloud Database, although, it must be on a subnet that can communicate with the Oracle Cloud Database.
type RecoveryServiceSubnet struct {
// The recovery service subnet OCID.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// VCN Identifier.
VcnId *string `mandatory:"true" json:"vcnId"`
// Deprecated. One of the subnets associated with the Recovery Service subnet.
SubnetId *string `mandatory:"true" json:"subnetId"`
// A user-provided name for the recovery service subnet.
DisplayName *string `mandatory:"false" json:"displayName"`
// A list of OCIDs of all the subnets associated with the Recovery Service subnet.
Subnets []string `mandatory:"false" json:"subnets"`
// A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet.
// You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet.
// Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet.
// See NetworkSecurityGroup for more information.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the recovery service subnet.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m RecoveryServiceSubnet) String() string
func (m RecoveryServiceSubnet) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecoveryServiceSubnetCollection Results of a recovery service subnet search operation. The results contain recovery service subnet summary and metadata information.
type RecoveryServiceSubnetCollection struct {
// List of recovery service subnet resources.
Items []RecoveryServiceSubnetSummary `mandatory:"true" json:"items"`
}
func (m RecoveryServiceSubnetCollection) String() string
func (m RecoveryServiceSubnetCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecoveryServiceSubnetDetails Details of the Recovery Service Subnet.
type RecoveryServiceSubnetDetails struct {
// Recovery Service Subnet Identifier.
RecoveryServiceSubnetId *string `mandatory:"true" json:"recoveryServiceSubnetId"`
// The current state of the Recovery Service Subnet.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m RecoveryServiceSubnetDetails) String() string
func (m RecoveryServiceSubnetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecoveryServiceSubnetInput Parameters to retrieve information about a specific recovery service subnet.
type RecoveryServiceSubnetInput struct {
// The recovery service subnet OCID.
RecoveryServiceSubnetId *string `mandatory:"true" json:"recoveryServiceSubnetId"`
}
func (m RecoveryServiceSubnetInput) String() string
func (m RecoveryServiceSubnetInput) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RecoveryServiceSubnetSummary Each Recovery Service subnet uses a single private endpoint on a subnet of your choice within a VCN. The private endpoint need not be on the same subnet as the Oracle Cloud Database, although, it must be on a subnet that can communicate with the Oracle Cloud Database. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about access control and compartments, see Overview of the Identity Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
type RecoveryServiceSubnetSummary struct {
// The recovery service subnet OCID.
Id *string `mandatory:"true" json:"id"`
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the virtual cloud network (VCN) associated with the recovery service subnet. You can create a single recovery service subnet per VCN.
VcnId *string `mandatory:"true" json:"vcnId"`
// Deprecated. One of the subnets associated with the Recovery Service subnet.
SubnetId *string `mandatory:"true" json:"subnetId"`
// A user-provided name for the recovery service subnet.
DisplayName *string `mandatory:"false" json:"displayName"`
// A list of OCIDs of all the subnets associated with the Recovery Service subnet.
Subnets []string `mandatory:"false" json:"subnets"`
// A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet.
// You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet.
// Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet.
// See NetworkSecurityGroup for more information.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the recovery service subnet.
LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m RecoveryServiceSubnetSummary) String() string
func (m RecoveryServiceSubnetSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleProtectedDatabaseDeletionDetails The details for scheduling deletion of the protected database
type ScheduleProtectedDatabaseDeletionDetails struct {
// 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.
DeletionSchedule DeletionScheduleEnum `mandatory:"false" json:"deletionSchedule,omitempty"`
}
func (m ScheduleProtectedDatabaseDeletionDetails) String() string
func (m ScheduleProtectedDatabaseDeletionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleProtectedDatabaseDeletionRequest wrapper for the ScheduleProtectedDatabaseDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/ScheduleProtectedDatabaseDeletion.go.html to see an example of how to use ScheduleProtectedDatabaseDeletionRequest.
type ScheduleProtectedDatabaseDeletionRequest struct {
// The protected database OCID.
ProtectedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"protectedDatabaseId"`
// The details for scheduling deletion of the protected database
ScheduleProtectedDatabaseDeletionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ScheduleProtectedDatabaseDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ScheduleProtectedDatabaseDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleProtectedDatabaseDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleProtectedDatabaseDeletionRequest) String() string
func (request ScheduleProtectedDatabaseDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleProtectedDatabaseDeletionResponse wrapper for the ScheduleProtectedDatabaseDeletion operation
type ScheduleProtectedDatabaseDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ScheduleProtectedDatabaseDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleProtectedDatabaseDeletionResponse) String() string
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
UpdateProtectedDatabaseDetails Describes the parameters required to update a protected database.
type UpdateProtectedDatabaseDetails struct {
// The protected database name. You can change the displayName. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The size of the database is allowed to be decreased. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
DatabaseSize DatabaseSizesEnum `mandatory:"false" json:"databaseSize,omitempty"`
// The size of the database, in gigabytes.
DatabaseSizeInGBs *int `mandatory:"false" json:"databaseSizeInGBs"`
// Password credential which can be used to connect to Protected Database.
// It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters.
// The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username "admin", regardless of casing.
// Password must not be same as current passsword.
Password *string `mandatory:"false" json:"password"`
// The OCID of the protection policy associated with the protected database.
ProtectionPolicyId *string `mandatory:"false" json:"protectionPolicyId"`
// List of recovery service subnet resources associated with the protected database.
RecoveryServiceSubnets []RecoveryServiceSubnetInput `mandatory:"false" json:"recoveryServiceSubnets"`
// The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service.
// Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional
// configuration is needed on client side.
IsRedoLogsShipped *bool `mandatory:"false" json:"isRedoLogsShipped"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateProtectedDatabaseDetails) String() string
func (m UpdateProtectedDatabaseDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateProtectedDatabaseRequest wrapper for the UpdateProtectedDatabase operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/UpdateProtectedDatabase.go.html to see an example of how to use UpdateProtectedDatabaseRequest.
type UpdateProtectedDatabaseRequest struct {
// The protected database OCID.
ProtectedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"protectedDatabaseId"`
// Describes the parameters required to update a protected database.
UpdateProtectedDatabaseDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateProtectedDatabaseRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateProtectedDatabaseRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateProtectedDatabaseRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateProtectedDatabaseRequest) String() string
func (request UpdateProtectedDatabaseRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateProtectedDatabaseResponse wrapper for the UpdateProtectedDatabase operation
type UpdateProtectedDatabaseResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateProtectedDatabaseResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateProtectedDatabaseResponse) String() string
UpdateProtectionPolicyDetails The information to be updated.
type UpdateProtectionPolicyDetails struct {
// A user provided name for the protection policy. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The maximum number of days to retain backups for a protected database.
BackupRetentionPeriodInDays *int `mandatory:"false" json:"backupRetentionPeriodInDays"`
// An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
// * The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups.
// * Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect. Therefore, you must set policyLockedDateTime to a date that occurs 14 days after the current date.
// * For example, assuming that the current date is Aug 1, 2023 9 pm, you can set policyLockedDateTime to '2023-08-15T21:00:00.600Z' (Aug 15, 2023, 9:00 pm), or greater.
// * During the 14-day delay period, you can either increase or decrease the retention period in the policy.
// * However, you are only allowed to increase the retention period on or after the retention lock date.
// * You cannot change the value of policyLockedDateTime if the retention lock is already in effect.
PolicyLockedDateTime *string `mandatory:"false" json:"policyLockedDateTime"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateProtectionPolicyDetails) String() string
func (m UpdateProtectionPolicyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateProtectionPolicyRequest wrapper for the UpdateProtectionPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/UpdateProtectionPolicy.go.html to see an example of how to use UpdateProtectionPolicyRequest.
type UpdateProtectionPolicyRequest struct {
// The protection policy OCID.
ProtectionPolicyId *string `mandatory:"true" contributesTo:"path" name:"protectionPolicyId"`
// The information to be updated.
UpdateProtectionPolicyDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateProtectionPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateProtectionPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateProtectionPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateProtectionPolicyRequest) String() string
func (request UpdateProtectionPolicyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateProtectionPolicyResponse wrapper for the UpdateProtectionPolicy operation
type UpdateProtectionPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateProtectionPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateProtectionPolicyResponse) String() string
UpdateRecoveryServiceSubnetDetails Describes the parameters required to update a recovery service subnet.
type UpdateRecoveryServiceSubnetDetails struct {
// A user-provided name for the recovery service subnet. The 'displayName' does not have to be unique, and it can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A list of OCIDs of the subnets associated with the recovery service subnet.
Subnets []string `mandatory:"false" json:"subnets"`
// A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet.
// You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet.
// Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet.
// See NetworkSecurityGroup for more information.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`. For more information, see Resource Tags (https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateRecoveryServiceSubnetDetails) String() string
func (m UpdateRecoveryServiceSubnetDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRecoveryServiceSubnetRequest wrapper for the UpdateRecoveryServiceSubnet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/recovery/UpdateRecoveryServiceSubnet.go.html to see an example of how to use UpdateRecoveryServiceSubnetRequest.
type UpdateRecoveryServiceSubnetRequest struct {
// The recovery service subnet OCID.
RecoveryServiceSubnetId *string `mandatory:"true" contributesTo:"path" name:"recoveryServiceSubnetId"`
// Describes the parameters required to update a recovery service subnet.
UpdateRecoveryServiceSubnetDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateRecoveryServiceSubnetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRecoveryServiceSubnetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRecoveryServiceSubnetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRecoveryServiceSubnetRequest) String() string
func (request UpdateRecoveryServiceSubnetRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRecoveryServiceSubnetResponse wrapper for the UpdateRecoveryServiceSubnet operation
type UpdateRecoveryServiceSubnetResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateRecoveryServiceSubnetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRecoveryServiceSubnetResponse) String() string
WorkRequest A description of workrequest status
type WorkRequest struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// The completed percentage of the operation tracked by the work request.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was accepted, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. The precision for this time object is in milliseconds.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. The precision for this time object is in milliseconds.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. The precision for this time object is in milliseconds.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly