func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetAutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnumStringValues() []string
GetAutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnumStringValues Enumerates the set of values in String for AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum
func GetAutonomousDatabaseStandbyTypeForDrDrillsEnumStringValues() []string
GetAutonomousDatabaseStandbyTypeForDrDrillsEnumStringValues Enumerates the set of values in String for AutonomousDatabaseStandbyTypeForDrDrillsEnum
func GetDisassociateDrProtectionGroupDetailsTypeEnumStringValues() []string
GetDisassociateDrProtectionGroupDetailsTypeEnumStringValues Enumerates the set of values in String for DisassociateDrProtectionGroupDetailsTypeEnum
func GetDrPlanExecutionControlDetailsActionTypeEnumStringValues() []string
GetDrPlanExecutionControlDetailsActionTypeEnumStringValues Enumerates the set of values in String for DrPlanExecutionControlDetailsActionTypeEnum
func GetDrPlanExecutionLifecycleStateEnumStringValues() []string
GetDrPlanExecutionLifecycleStateEnumStringValues Enumerates the set of values in String for DrPlanExecutionLifecycleStateEnum
func GetDrPlanExecutionOptionDetailsPlanExecutionTypeEnumStringValues() []string
GetDrPlanExecutionOptionDetailsPlanExecutionTypeEnumStringValues Enumerates the set of values in String for DrPlanExecutionOptionDetailsPlanExecutionTypeEnum
func GetDrPlanExecutionOptionsPlanExecutionTypeEnumStringValues() []string
GetDrPlanExecutionOptionsPlanExecutionTypeEnumStringValues Enumerates the set of values in String for DrPlanExecutionOptionsPlanExecutionTypeEnum
func GetDrPlanExecutionTypeEnumStringValues() []string
GetDrPlanExecutionTypeEnumStringValues Enumerates the set of values in String for DrPlanExecutionTypeEnum
func GetDrPlanGroupExecutionStatusEnumStringValues() []string
GetDrPlanGroupExecutionStatusEnumStringValues Enumerates the set of values in String for DrPlanGroupExecutionStatusEnum
func GetDrPlanGroupRefreshStatusEnumStringValues() []string
GetDrPlanGroupRefreshStatusEnumStringValues Enumerates the set of values in String for DrPlanGroupRefreshStatusEnum
func GetDrPlanGroupTypeEnumStringValues() []string
GetDrPlanGroupTypeEnumStringValues Enumerates the set of values in String for DrPlanGroupTypeEnum
func GetDrPlanLifecycleStateEnumStringValues() []string
GetDrPlanLifecycleStateEnumStringValues Enumerates the set of values in String for DrPlanLifecycleStateEnum
func GetDrPlanLifecycleSubStateEnumStringValues() []string
GetDrPlanLifecycleSubStateEnumStringValues Enumerates the set of values in String for DrPlanLifecycleSubStateEnum
func GetDrPlanStepErrorModeEnumStringValues() []string
GetDrPlanStepErrorModeEnumStringValues Enumerates the set of values in String for DrPlanStepErrorModeEnum
func GetDrPlanStepExecutionStatusEnumStringValues() []string
GetDrPlanStepExecutionStatusEnumStringValues Enumerates the set of values in String for DrPlanStepExecutionStatusEnum
func GetDrPlanStepRefreshStatusEnumStringValues() []string
GetDrPlanStepRefreshStatusEnumStringValues Enumerates the set of values in String for DrPlanStepRefreshStatusEnum
func GetDrPlanStepTypeEnumStringValues() []string
GetDrPlanStepTypeEnumStringValues Enumerates the set of values in String for DrPlanStepTypeEnum
func GetDrPlanTypeEnumStringValues() []string
GetDrPlanTypeEnumStringValues Enumerates the set of values in String for DrPlanTypeEnum
func GetDrPlanUserDefinedStepStepTypeEnumStringValues() []string
GetDrPlanUserDefinedStepStepTypeEnumStringValues Enumerates the set of values in String for DrPlanUserDefinedStepStepTypeEnum
func GetDrProtectionGroupLifecycleStateEnumStringValues() []string
GetDrProtectionGroupLifecycleStateEnumStringValues Enumerates the set of values in String for DrProtectionGroupLifecycleStateEnum
func GetDrProtectionGroupLifecycleSubStateEnumStringValues() []string
GetDrProtectionGroupLifecycleSubStateEnumStringValues Enumerates the set of values in String for DrProtectionGroupLifecycleSubStateEnum
func GetDrProtectionGroupMemberTypeEnumStringValues() []string
GetDrProtectionGroupMemberTypeEnumStringValues Enumerates the set of values in String for DrProtectionGroupMemberTypeEnum
func GetDrProtectionGroupRoleEnumStringValues() []string
GetDrProtectionGroupRoleEnumStringValues Enumerates the set of values in String for DrProtectionGroupRoleEnum
func GetListDrPlanExecutionsLifecycleStateEnumStringValues() []string
GetListDrPlanExecutionsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDrPlanExecutionsLifecycleStateEnum
func GetListDrPlanExecutionsSortByEnumStringValues() []string
GetListDrPlanExecutionsSortByEnumStringValues Enumerates the set of values in String for ListDrPlanExecutionsSortByEnum
func GetListDrPlanExecutionsSortOrderEnumStringValues() []string
GetListDrPlanExecutionsSortOrderEnumStringValues Enumerates the set of values in String for ListDrPlanExecutionsSortOrderEnum
func GetListDrPlansDrPlanTypeEnumStringValues() []string
GetListDrPlansDrPlanTypeEnumStringValues Enumerates the set of values in String for ListDrPlansDrPlanTypeEnum
func GetListDrPlansLifecycleStateEnumStringValues() []string
GetListDrPlansLifecycleStateEnumStringValues Enumerates the set of values in String for ListDrPlansLifecycleStateEnum
func GetListDrPlansLifecycleSubStateEnumStringValues() []string
GetListDrPlansLifecycleSubStateEnumStringValues Enumerates the set of values in String for ListDrPlansLifecycleSubStateEnum
func GetListDrPlansSortByEnumStringValues() []string
GetListDrPlansSortByEnumStringValues Enumerates the set of values in String for ListDrPlansSortByEnum
func GetListDrPlansSortOrderEnumStringValues() []string
GetListDrPlansSortOrderEnumStringValues Enumerates the set of values in String for ListDrPlansSortOrderEnum
func GetListDrProtectionGroupsLifecycleStateEnumStringValues() []string
GetListDrProtectionGroupsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsLifecycleStateEnum
func GetListDrProtectionGroupsLifecycleSubStateEnumStringValues() []string
GetListDrProtectionGroupsLifecycleSubStateEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsLifecycleSubStateEnum
func GetListDrProtectionGroupsRoleEnumStringValues() []string
GetListDrProtectionGroupsRoleEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsRoleEnum
func GetListDrProtectionGroupsSortByEnumStringValues() []string
GetListDrProtectionGroupsSortByEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsSortByEnum
func GetListDrProtectionGroupsSortOrderEnumStringValues() []string
GetListDrProtectionGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListDrProtectionGroupsSortOrderEnum
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 GetOkeClusterImageReplicationEnumStringValues() []string
GetOkeClusterImageReplicationEnumStringValues Enumerates the set of values in String for OkeClusterImageReplicationEnum
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 GetRefreshDrPlanDetailsTypeEnumStringValues() []string
GetRefreshDrPlanDetailsTypeEnumStringValues Enumerates the set of values in String for RefreshDrPlanDetailsTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetUpdateDrPlanUserDefinedStepDetailsStepTypeEnumStringValues() []string
GetUpdateDrPlanUserDefinedStepDetailsStepTypeEnumStringValues Enumerates the set of values in String for UpdateDrPlanUserDefinedStepDetailsStepTypeEnum
func GetVerifyDrPlanDetailsTypeEnumStringValues() []string
GetVerifyDrPlanDetailsTypeEnumStringValues Enumerates the set of values in String for VerifyDrPlanDetailsTypeEnum
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
AssociateDrProtectionGroupDetails The details for associating a DR protection group with a peer DR protection group.
type AssociateDrProtectionGroupDetails struct {
// The role of the DR protection group.
// Example: `STANDBY`
Role DrProtectionGroupRoleEnum `mandatory:"true" json:"role"`
// The OCID of the peer DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
PeerId *string `mandatory:"false" json:"peerId"`
// The region of the peer DR protection group.
// Example: `us-ashburn-1`
PeerRegion *string `mandatory:"false" json:"peerRegion"`
}
func (m AssociateDrProtectionGroupDetails) String() string
func (m AssociateDrProtectionGroupDetails) 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
AssociateDrProtectionGroupRequest wrapper for the AssociateDrProtectionGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/AssociateDrProtectionGroup.go.html to see an example of how to use AssociateDrProtectionGroupRequest.
type AssociateDrProtectionGroupRequest struct {
// Details for creating an association between two DR protection groups.
AssociateDrProtectionGroupDetails `contributesTo:"body"`
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"path" name:"drProtectionGroupId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 AssociateDrProtectionGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AssociateDrProtectionGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AssociateDrProtectionGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AssociateDrProtectionGroupRequest) String() string
func (request AssociateDrProtectionGroupRequest) 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
AssociateDrProtectionGroupResponse wrapper for the AssociateDrProtectionGroup operation
type AssociateDrProtectionGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 AssociateDrProtectionGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AssociateDrProtectionGroupResponse) String() string
AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum Enum with underlying type: string
type AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum string
Set of constants representing the allowable values for AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum
const (
AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeSnapshotService AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum = "SNAPSHOT_SERVICE"
AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypePrimaryService AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum = "PRIMARY_SERVICE"
)
func GetAutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnumValues() []AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum
GetAutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnumValues Enumerates the set of values for AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum
func GetMappingAutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum(val string) (AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum, bool)
GetMappingAutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AutonomousDatabaseStandbyTypeForDrDrillsEnum Enum with underlying type: string
type AutonomousDatabaseStandbyTypeForDrDrillsEnum string
Set of constants representing the allowable values for AutonomousDatabaseStandbyTypeForDrDrillsEnum
const (
AutonomousDatabaseStandbyTypeForDrDrillsFullClone AutonomousDatabaseStandbyTypeForDrDrillsEnum = "FULL_CLONE"
AutonomousDatabaseStandbyTypeForDrDrillsRefreshableClone AutonomousDatabaseStandbyTypeForDrDrillsEnum = "REFRESHABLE_CLONE"
AutonomousDatabaseStandbyTypeForDrDrillsSnapshotStandby AutonomousDatabaseStandbyTypeForDrDrillsEnum = "SNAPSHOT_STANDBY"
)
func GetAutonomousDatabaseStandbyTypeForDrDrillsEnumValues() []AutonomousDatabaseStandbyTypeForDrDrillsEnum
GetAutonomousDatabaseStandbyTypeForDrDrillsEnumValues Enumerates the set of values for AutonomousDatabaseStandbyTypeForDrDrillsEnum
func GetMappingAutonomousDatabaseStandbyTypeForDrDrillsEnum(val string) (AutonomousDatabaseStandbyTypeForDrDrillsEnum, bool)
GetMappingAutonomousDatabaseStandbyTypeForDrDrillsEnum performs case Insensitive comparison on enum value and return the desired enum
BlockVolumeAttachmentDetails The details for attaching or detaching a block volume.
type BlockVolumeAttachmentDetails struct {
// The OCID of the reference compute instance from which to obtain the attachment details for the volume.
// This reference compute instance is from the peer DR protection group.
// Example: `ocid1.instance.oc1..uniqueID`
VolumeAttachmentReferenceInstanceId *string `mandatory:"true" json:"volumeAttachmentReferenceInstanceId"`
}
func (m BlockVolumeAttachmentDetails) String() string
func (m BlockVolumeAttachmentDetails) 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
BlockVolumeMountDetails The details for mounting or unmounting the file system on a block volume.
type BlockVolumeMountDetails struct {
// The physical mount point used for mounting and unmounting the file system on a block volume.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"true" json:"mountPoint"`
}
func (m BlockVolumeMountDetails) String() string
func (m BlockVolumeMountDetails) 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
CancelDrPlanExecutionDetails The details for cancelling a DR plan execution.
type CancelDrPlanExecutionDetails struct {
}
func (m CancelDrPlanExecutionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CancelDrPlanExecutionDetails) String() string
func (m CancelDrPlanExecutionDetails) 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
CancelDrPlanExecutionRequest wrapper for the CancelDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CancelDrPlanExecution.go.html to see an example of how to use CancelDrPlanExecutionRequest.
type CancelDrPlanExecutionRequest struct {
// Details for canceling the DR plan execution.
CancelDrPlanExecutionDetails `contributesTo:"body"`
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"true" contributesTo:"path" name:"drPlanExecutionId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 CancelDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelDrPlanExecutionRequest) String() string
func (request CancelDrPlanExecutionRequest) 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
CancelDrPlanExecutionResponse wrapper for the CancelDrPlanExecution operation
type CancelDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 CancelDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelDrPlanExecutionResponse) String() string
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The ID (OCID) of the asynchronous request.
// Example: `ocid1.workrequest.oc1..uniqueID`
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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"`
// The client request ID for tracing.
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 CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) 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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse 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 CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChangeDrProtectionGroupCompartmentDetails The details for moving a DR protection group to another compartment.
type ChangeDrProtectionGroupCompartmentDetails struct {
// The OCID of the compartment to which the DR protection group should be moved.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDrProtectionGroupCompartmentDetails) String() string
func (m ChangeDrProtectionGroupCompartmentDetails) 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
ChangeDrProtectionGroupCompartmentRequest wrapper for the ChangeDrProtectionGroupCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ChangeDrProtectionGroupCompartment.go.html to see an example of how to use ChangeDrProtectionGroupCompartmentRequest.
type ChangeDrProtectionGroupCompartmentRequest struct {
// Details for changing the DR protection group compartment.
ChangeDrProtectionGroupCompartmentDetails `contributesTo:"body"`
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"path" name:"drProtectionGroupId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 ChangeDrProtectionGroupCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDrProtectionGroupCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDrProtectionGroupCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDrProtectionGroupCompartmentRequest) String() string
func (request ChangeDrProtectionGroupCompartmentRequest) 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
ChangeDrProtectionGroupCompartmentResponse wrapper for the ChangeDrProtectionGroupCompartment operation
type ChangeDrProtectionGroupCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 ChangeDrProtectionGroupCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDrProtectionGroupCompartmentResponse) String() string
ComputeInstanceMovableFileSystemOperation The details of operations performed on a file system.
type ComputeInstanceMovableFileSystemOperation struct {
// The export path of the file system.
// Example: `/fs-export-path`
ExportPath *string `mandatory:"true" json:"exportPath"`
// The physical mount point of the file system on a host.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"true" json:"mountPoint"`
MountDetails *FileSystemMountDetails `mandatory:"true" json:"mountDetails"`
UnmountDetails *FileSystemUnmountDetails `mandatory:"true" json:"unmountDetails"`
}
func (m ComputeInstanceMovableFileSystemOperation) String() string
func (m ComputeInstanceMovableFileSystemOperation) 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
ComputeInstanceMovableVnicMapping Source VNIC to destination subnet mapping for a movable compute instance.
type ComputeInstanceMovableVnicMapping struct {
// The OCID of the source VNIC.
// Example: `ocid1.vnic.oc1..uniqueID`
SourceVnicId *string `mandatory:"true" json:"sourceVnicId"`
// The OCID of the destination subnet to which the source VNIC should connect.
// Example: `ocid1.subnet.oc1..uniqueID`
DestinationSubnetId *string `mandatory:"true" json:"destinationSubnetId"`
// The private IP address to be assigned as the VNIC's primary IP address in the destination subnet.
// This must be a valid IP address in the destination subnet and the IP address must be available.
// Example: `10.0.3.3`
DestinationPrimaryPrivateIpAddress *string `mandatory:"false" json:"destinationPrimaryPrivateIpAddress"`
// The hostname label to be assigned in the destination subnet for the primary private IP of the source VNIC.
// This label is the hostname portion of the private IP's fully qualified domain name (FQDN)
// (for example, 'myhost1' in the FQDN 'myhost1.subnet123.vcn1.oraclevcn.com').
// Example: `myhost1`
DestinationPrimaryPrivateIpHostnameLabel *string `mandatory:"false" json:"destinationPrimaryPrivateIpHostnameLabel"`
// A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to
// the source VNIC.
// Example: `[ ocid1.networksecuritygroup.oc1..uniqueID, ocid1.networksecuritygroup.oc1..uniqueID ]`
DestinationNsgIdList []string `mandatory:"false" json:"destinationNsgIdList"`
}
func (m ComputeInstanceMovableVnicMapping) String() string
func (m ComputeInstanceMovableVnicMapping) 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
ComputeInstanceMovableVnicMappingDetails Source VNIC to destination subnet mapping for a movable compute instance.
type ComputeInstanceMovableVnicMappingDetails struct {
// The OCID of the source VNIC.
// Example: `ocid1.vnic.oc1..uniqueID`
SourceVnicId *string `mandatory:"true" json:"sourceVnicId"`
// The OCID of the destination subnet to which the source VNIC should connect.
// Example: `ocid1.subnet.oc1..uniqueID`
DestinationSubnetId *string `mandatory:"true" json:"destinationSubnetId"`
// The primary private IP address to be assigned to the source VNIC in the destination subnet.
// This IP address must belong to the destination subnet.
// Example: `10.0.3.3`
DestinationPrimaryPrivateIpAddress *string `mandatory:"false" json:"destinationPrimaryPrivateIpAddress"`
// The hostname label to be assigned in the destination subnet for the primary private IP of the source VNIC.
// This label is the hostname portion of the private IP's fully qualified domain name (FQDN)
// (for example, 'myhost1' in the FQDN 'myhost1.subnet123.vcn1.oraclevcn.com').
// Example: `myhost1`
DestinationPrimaryPrivateIpHostnameLabel *string `mandatory:"false" json:"destinationPrimaryPrivateIpHostnameLabel"`
// A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to
// the source VNIC.
// Example: `[ ocid1.networksecuritygroup.oc1..uniqueID, ocid1.networksecuritygroup.oc1..uniqueID ]`
DestinationNsgIdList []string `mandatory:"false" json:"destinationNsgIdList"`
}
func (m ComputeInstanceMovableVnicMappingDetails) String() string
func (m ComputeInstanceMovableVnicMappingDetails) 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
ComputeInstanceNonMovableBlockVolumeOperation The details of operations performed on a block volume.
type ComputeInstanceNonMovableBlockVolumeOperation struct {
// The OCID of the block volume.
// Example: `ocid1.volume.oc1..uniqueID`
BlockVolumeId *string `mandatory:"true" json:"blockVolumeId"`
AttachmentDetails *BlockVolumeAttachmentDetails `mandatory:"false" json:"attachmentDetails"`
MountDetails *BlockVolumeMountDetails `mandatory:"false" json:"mountDetails"`
}
func (m ComputeInstanceNonMovableBlockVolumeOperation) String() string
func (m ComputeInstanceNonMovableBlockVolumeOperation) 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
ComputeInstanceNonMovableFileSystemOperation The details of operations performed on a file system.
type ComputeInstanceNonMovableFileSystemOperation struct {
// The export path of the file system.
// Example: `/fs-export-path`
ExportPath *string `mandatory:"true" json:"exportPath"`
// The physical mount point of the file system on a host.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"true" json:"mountPoint"`
// The OCID of mount target.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"true" json:"mountTargetId"`
}
func (m ComputeInstanceNonMovableFileSystemOperation) String() string
func (m ComputeInstanceNonMovableFileSystemOperation) 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
ComputeInstanceVnicMapping Deprecated. Source VNIC to destination subnet mapping for a compute instance.
type ComputeInstanceVnicMapping struct {
// The OCID of the VNIC.
// Example: `ocid1.vnic.oc1..uniqueID`
SourceVnicId *string `mandatory:"true" json:"sourceVnicId"`
// The OCID of the destination subnet to which the source VNIC should connect.
// Example: `ocid1.subnet.oc1..uniqueID`
DestinationSubnetId *string `mandatory:"true" json:"destinationSubnetId"`
// A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to
// the source VNIC.
// Example: `[ ocid1.networksecuritygroup.oc1..uniqueID1, ocid1.networksecuritygroup.oc1..uniqueID2 ]`
DestinationNsgIdList []string `mandatory:"false" json:"destinationNsgIdList"`
}
func (m ComputeInstanceVnicMapping) String() string
func (m ComputeInstanceVnicMapping) 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
ComputeInstanceVnicMappingDetails Deprecated. Source VNIC to destination subnet mapping for a compute instance.
type ComputeInstanceVnicMappingDetails struct {
// The OCID of the VNIC.
// Example: `ocid1.vnic.oc1..uniqueID`
SourceVnicId *string `mandatory:"true" json:"sourceVnicId"`
// The OCID of the destination subnet to which this source VNIC should connect.
// Example: `ocid1.subnet.oc1..uniqueID`
DestinationSubnetId *string `mandatory:"true" json:"destinationSubnetId"`
// The primary private IP address to be assigned to the VNIC in the destination region.
// This address must belong to the destination subnet.
// Example: `10.0.3.3`
DestinationPrimaryPrivateIpAddress *string `mandatory:"false" json:"destinationPrimaryPrivateIpAddress"`
// The hostname label to be assigned in the destination subnet for the primary private IP of the source VNIC.
// This label is the hostname portion of the private IP's fully qualified domain name (FQDN)
// (for example, 'myhost1' in the FQDN 'myhost1.subnet123.vcn1.oraclevcn.com').
// Example: `myhost1`
DestinationPrimaryPrivateIpHostnameLabel *string `mandatory:"false" json:"destinationPrimaryPrivateIpHostnameLabel"`
// A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to
// the source VNIC.
// Example: `[ ocid1.networksecuritygroup.oc1..uniqueID, ocid1.networksecuritygroup.oc1..uniqueID ]`
DestinationNsgIdList []string `mandatory:"false" json:"destinationNsgIdList"`
}
func (m ComputeInstanceVnicMappingDetails) String() string
func (m ComputeInstanceVnicMappingDetails) 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
CreateBlockVolumeAttachmentDetails The details for creating a block volume attachment.
type CreateBlockVolumeAttachmentDetails struct {
// The OCID of the reference compute instance from which to obtain the attachment details for the volume.
// This reference compute instance is from the peer DR protection group.
// Example: `ocid1.instance.oc1..uniqueID`
VolumeAttachmentReferenceInstanceId *string `mandatory:"false" json:"volumeAttachmentReferenceInstanceId"`
}
func (m CreateBlockVolumeAttachmentDetails) String() string
func (m CreateBlockVolumeAttachmentDetails) 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
CreateBlockVolumeMountDetails The details for creating a mount for a file system on a block volume.
type CreateBlockVolumeMountDetails struct {
// The physical mount point used for mounting the file system on the block volume.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"false" json:"mountPoint"`
}
func (m CreateBlockVolumeMountDetails) String() string
func (m CreateBlockVolumeMountDetails) 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
CreateComputeInstanceMovableFileSystemOperationDetails The details for creating the operations performed on a file system for movable compute instance.
type CreateComputeInstanceMovableFileSystemOperationDetails struct {
// The export path of the file system.
// Example: `/fs-export-path`
ExportPath *string `mandatory:"true" json:"exportPath"`
// The physical mount point of the file system on a host.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"true" json:"mountPoint"`
MountDetails *CreateFileSystemMountDetails `mandatory:"true" json:"mountDetails"`
UnmountDetails *CreateFileSystemUnmountDetails `mandatory:"true" json:"unmountDetails"`
}
func (m CreateComputeInstanceMovableFileSystemOperationDetails) String() string
func (m CreateComputeInstanceMovableFileSystemOperationDetails) 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
CreateComputeInstanceNonMovableBlockVolumeOperationDetails The details for creating the operations performed on a block volume.
type CreateComputeInstanceNonMovableBlockVolumeOperationDetails struct {
// The OCID of the block volume.
// Example: `ocid1.volume.oc1..uniqueID`
BlockVolumeId *string `mandatory:"true" json:"blockVolumeId"`
AttachmentDetails *CreateBlockVolumeAttachmentDetails `mandatory:"false" json:"attachmentDetails"`
MountDetails *CreateBlockVolumeMountDetails `mandatory:"false" json:"mountDetails"`
}
func (m CreateComputeInstanceNonMovableBlockVolumeOperationDetails) String() string
func (m CreateComputeInstanceNonMovableBlockVolumeOperationDetails) 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
CreateComputeInstanceNonMovableFileSystemOperationDetails The details for creating the operations performed on a file system for non-movable compute instance.
type CreateComputeInstanceNonMovableFileSystemOperationDetails struct {
// The export path of the file system.
// Example: `/fs-export-path`
ExportPath *string `mandatory:"true" json:"exportPath"`
// The physical mount point of the file system on a host.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"true" json:"mountPoint"`
// The OCID of the mount target.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"true" json:"mountTargetId"`
}
func (m CreateComputeInstanceNonMovableFileSystemOperationDetails) String() string
func (m CreateComputeInstanceNonMovableFileSystemOperationDetails) 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
CreateDrPlanDetails The details for creating a DR plan.
type CreateDrPlanDetails struct {
// The display name of the DR plan being created.
// Example: `EBS Switchover PHX to IAD`
DisplayName *string `mandatory:"true" json:"displayName"`
// The type of DR plan to be created.
Type DrPlanTypeEnum `mandatory:"true" json:"type"`
// The OCID of the DR protection group to which this DR plan belongs.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" json:"drProtectionGroupId"`
// The OCID of the source DR plan that should be cloned.
// Example: `ocid1.drplan.oc1..uniqueID`
SourcePlanId *string `mandatory:"false" json:"sourcePlanId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDrPlanDetails) String() string
func (m CreateDrPlanDetails) 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
CreateDrPlanExecutionDetails The details for creating a DR plan execution.
type CreateDrPlanExecutionDetails struct {
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
PlanId *string `mandatory:"true" json:"planId"`
ExecutionOptions DrPlanExecutionOptionDetails `mandatory:"true" json:"executionOptions"`
// The display name of the DR plan execution.
// Example: `Execution - EBS Switchover PHX to IAD`
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDrPlanExecutionDetails) String() string
func (m *CreateDrPlanExecutionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateDrPlanExecutionDetails) 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
CreateDrPlanExecutionRequest wrapper for the CreateDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CreateDrPlanExecution.go.html to see an example of how to use CreateDrPlanExecutionRequest.
type CreateDrPlanExecutionRequest struct {
// Details for creating the DR plan execution.
CreateDrPlanExecutionDetails `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"`
// The client request ID for tracing.
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 CreateDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDrPlanExecutionRequest) String() string
func (request CreateDrPlanExecutionRequest) 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
CreateDrPlanExecutionResponse wrapper for the CreateDrPlanExecution operation
type CreateDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// The DrPlanExecution instance
DrPlanExecution `presentIn:"body"`
// A URI for the new resource which was created by the request.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. For more information, see ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 CreateDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDrPlanExecutionResponse) String() string
CreateDrPlanRequest wrapper for the CreateDrPlan operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CreateDrPlan.go.html to see an example of how to use CreateDrPlanRequest.
type CreateDrPlanRequest struct {
// Details for creating the new DR plan.
CreateDrPlanDetails `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"`
// The client request ID for tracing.
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 CreateDrPlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDrPlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDrPlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDrPlanRequest) String() string
func (request CreateDrPlanRequest) 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
CreateDrPlanResponse wrapper for the CreateDrPlan operation
type CreateDrPlanResponse struct {
// The underlying http response
RawResponse *http.Response
// The DrPlan instance
DrPlan `presentIn:"body"`
// A URI for the new resource which was created by the request.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. For more information, see ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 CreateDrPlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDrPlanResponse) String() string
CreateDrProtectionGroupDetails The details for creating a DR protection group.
type CreateDrProtectionGroupDetails struct {
// The OCID of the compartment in which to create the DR protection group.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the DR protection group.
// Example: `EBS PHX Group`
DisplayName *string `mandatory:"true" json:"displayName"`
LogLocation *CreateObjectStorageLogLocationDetails `mandatory:"true" json:"logLocation"`
Association *AssociateDrProtectionGroupDetails `mandatory:"false" json:"association"`
// A list of DR protection group members.
Members []CreateDrProtectionGroupMemberDetails `mandatory:"false" json:"members"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDrProtectionGroupDetails) String() string
func (m *CreateDrProtectionGroupDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateDrProtectionGroupDetails) 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
CreateDrProtectionGroupMemberAutonomousContainerDatabaseDetails Create properties for an Autonomous Container Database member.
type CreateDrProtectionGroupMemberAutonomousContainerDatabaseDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The type of connection strings used to connect to an Autonomous Container Database snapshot standby created during a DR Drill operation.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html for information about these service types.
ConnectionStringType AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum `mandatory:"false" json:"connectionStringType,omitempty"`
}
func (m CreateDrProtectionGroupMemberAutonomousContainerDatabaseDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberAutonomousContainerDatabaseDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberAutonomousContainerDatabaseDetails) String() string
func (m CreateDrProtectionGroupMemberAutonomousContainerDatabaseDetails) 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
CreateDrProtectionGroupMemberAutonomousDatabaseDetails Create properties for an Autonomous Database Serverless member.
type CreateDrProtectionGroupMemberAutonomousDatabaseDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the vault secret where the database SYSDBA password is stored.
// This password is required and used for performing database DR Drill operations when using full clone.
// Example: `ocid1.vaultsecret.oc1..uniqueID`
PasswordVaultSecretId *string `mandatory:"false" json:"passwordVaultSecretId"`
// This specifies the mechanism used to create a temporary Autonomous Database instance for DR Drills.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-clone-about.html for information about these clone types.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-data-guard-snapshot-standby.html for information about snapshot standby.
AutonomousDatabaseStandbyTypeForDrDrills AutonomousDatabaseStandbyTypeForDrDrillsEnum `mandatory:"false" json:"autonomousDatabaseStandbyTypeForDrDrills,omitempty"`
}
func (m CreateDrProtectionGroupMemberAutonomousDatabaseDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberAutonomousDatabaseDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberAutonomousDatabaseDetails) String() string
func (m CreateDrProtectionGroupMemberAutonomousDatabaseDetails) 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
CreateDrProtectionGroupMemberComputeInstanceDetails Deprecated. Create properties for a compute instance member.
type CreateDrProtectionGroupMemberComputeInstanceDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating if the compute instance should be moved during DR operations.
// Example: `false`
IsMovable *bool `mandatory:"false" json:"isMovable"`
// A list of compute instance VNIC mappings.
VnicMapping []ComputeInstanceVnicMappingDetails `mandatory:"false" json:"vnicMapping"`
// The OCID of a compartment in the destination region in which the compute instance
// should be launched.
// Example: `ocid1.compartment.oc1..uniqueID`
DestinationCompartmentId *string `mandatory:"false" json:"destinationCompartmentId"`
// The OCID of a dedicated VM host in the destination region where the compute instance
// should be launched.
// Example: `ocid1.dedicatedvmhost.oc1..uniqueID`
DestinationDedicatedVmHostId *string `mandatory:"false" json:"destinationDedicatedVmHostId"`
}
func (m CreateDrProtectionGroupMemberComputeInstanceDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberComputeInstanceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberComputeInstanceDetails) String() string
func (m CreateDrProtectionGroupMemberComputeInstanceDetails) 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
CreateDrProtectionGroupMemberComputeInstanceMovableDetails Create properties for a movable compute instance member.
type CreateDrProtectionGroupMemberComputeInstanceMovableDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating if the compute instance should be moved to the same fault domain in the destination region.
// The compute instance launch will fail if this flag is set to true and capacity is not available in the
// specified fault domain in the destination region.
// Example: `false`
IsRetainFaultDomain *bool `mandatory:"false" json:"isRetainFaultDomain"`
// The OCID of a capacity reservation in the destination region which will be used to launch
// the compute instance.
// Example: `ocid1.capacityreservation.oc1..uniqueID`
DestinationCapacityReservationId *string `mandatory:"false" json:"destinationCapacityReservationId"`
// A list of compute instance VNIC mappings.
VnicMappings []ComputeInstanceMovableVnicMappingDetails `mandatory:"false" json:"vnicMappings"`
// The OCID of a compartment in the destination region in which the compute instance
// should be launched.
// Example: `ocid1.compartment.oc1..uniqueID`
DestinationCompartmentId *string `mandatory:"false" json:"destinationCompartmentId"`
// The OCID of a dedicated VM host in the destination region where the compute instance
// should be launched.
// Example: `ocid1.dedicatedvmhost.oc1..uniqueID`
DestinationDedicatedVmHostId *string `mandatory:"false" json:"destinationDedicatedVmHostId"`
// A list of operations performed on file systems used by the compute instance.
FileSystemOperations []CreateComputeInstanceMovableFileSystemOperationDetails `mandatory:"false" json:"fileSystemOperations"`
}
func (m CreateDrProtectionGroupMemberComputeInstanceMovableDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberComputeInstanceMovableDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberComputeInstanceMovableDetails) String() string
func (m CreateDrProtectionGroupMemberComputeInstanceMovableDetails) 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
CreateDrProtectionGroupMemberComputeInstanceNonMovableDetails Create properties for a non-movable compute instance member.
type CreateDrProtectionGroupMemberComputeInstanceNonMovableDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating whether the non-movable compute instance should be started and stopped during DR operations.
// *Prechecks cannot be executed on stopped instances that are configured to be started.*
IsStartStopEnabled *bool `mandatory:"false" json:"isStartStopEnabled"`
// A list of operations performed on file systems used by the compute instance.
FileSystemOperations []CreateComputeInstanceNonMovableFileSystemOperationDetails `mandatory:"false" json:"fileSystemOperations"`
// A list of operations performed on block volumes used by the compute instance.
BlockVolumeOperations []CreateComputeInstanceNonMovableBlockVolumeOperationDetails `mandatory:"false" json:"blockVolumeOperations"`
}
func (m CreateDrProtectionGroupMemberComputeInstanceNonMovableDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberComputeInstanceNonMovableDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberComputeInstanceNonMovableDetails) String() string
func (m CreateDrProtectionGroupMemberComputeInstanceNonMovableDetails) 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
CreateDrProtectionGroupMemberDatabaseDetails Create properties for a Database (DBCS) member.
type CreateDrProtectionGroupMemberDatabaseDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the vault secret where the database SYSDBA password is stored.
// Example: `ocid1.vaultsecret.oc1..uniqueID`
PasswordVaultSecretId *string `mandatory:"false" json:"passwordVaultSecretId"`
}
func (m CreateDrProtectionGroupMemberDatabaseDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberDatabaseDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberDatabaseDetails) String() string
func (m CreateDrProtectionGroupMemberDatabaseDetails) 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
CreateDrProtectionGroupMemberDetails Create properties for a member in a DR protection group.
type CreateDrProtectionGroupMemberDetails interface {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
GetMemberId() *string
}
CreateDrProtectionGroupMemberFileSystemDetails Create properties for a file system member.
type CreateDrProtectionGroupMemberFileSystemDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The availability domain of the destination mount target.
// Example: `BBTh:region-AD`
DestinationAvailabilityDomain *string `mandatory:"false" json:"destinationAvailabilityDomain"`
// A list of mappings between file system exports in the primary region and mount targets in the standby region.
ExportMappings []FileSystemExportMappingDetails `mandatory:"false" json:"exportMappings"`
}
func (m CreateDrProtectionGroupMemberFileSystemDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberFileSystemDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberFileSystemDetails) String() string
func (m CreateDrProtectionGroupMemberFileSystemDetails) 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
CreateDrProtectionGroupMemberLoadBalancerDetails Create properties for a load balancer member.
type CreateDrProtectionGroupMemberLoadBalancerDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the destination load balancer.
// Example: `ocid1.loadbalancer.oc1..uniqueID`
DestinationLoadBalancerId *string `mandatory:"false" json:"destinationLoadBalancerId"`
// A list of backend set mappings that are used to transfer or update backends during DR.
BackendSetMappings []LoadBalancerBackendSetMappingDetails `mandatory:"false" json:"backendSetMappings"`
}
func (m CreateDrProtectionGroupMemberLoadBalancerDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberLoadBalancerDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberLoadBalancerDetails) String() string
func (m CreateDrProtectionGroupMemberLoadBalancerDetails) 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
CreateDrProtectionGroupMemberNetworkLoadBalancerDetails Create properties for a network load balancer member.
type CreateDrProtectionGroupMemberNetworkLoadBalancerDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the destination network load balancer.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
DestinationNetworkLoadBalancerId *string `mandatory:"false" json:"destinationNetworkLoadBalancerId"`
// A list of backend set mappings that are used to transfer or update backends during DR.
BackendSetMappings []NetworkLoadBalancerBackendSetMappingDetails `mandatory:"false" json:"backendSetMappings"`
}
func (m CreateDrProtectionGroupMemberNetworkLoadBalancerDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberNetworkLoadBalancerDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberNetworkLoadBalancerDetails) String() string
func (m CreateDrProtectionGroupMemberNetworkLoadBalancerDetails) 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
CreateDrProtectionGroupMemberObjectStorageBucketDetails Create properties for a object storage bucket member.
type CreateDrProtectionGroupMemberObjectStorageBucketDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The namespace in object storage (Note - this is usually the tenancy name).
// Example: `myocitenancy`
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The bucket name inside the object storage namespace.
// Example: `bucket_name`
BucketName *string `mandatory:"true" json:"bucketName"`
}
func (m CreateDrProtectionGroupMemberObjectStorageBucketDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberObjectStorageBucketDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberObjectStorageBucketDetails) String() string
func (m CreateDrProtectionGroupMemberObjectStorageBucketDetails) 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
CreateDrProtectionGroupMemberOkeClusterDetails Create properties for an OKE member.
type CreateDrProtectionGroupMemberOkeClusterDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the peer OKE cluster.
// This property applies to the OKE cluster member in both the primary and standby region.
// Example: `ocid1.cluster.oc1..uniqueID`
PeerClusterId *string `mandatory:"false" json:"peerClusterId"`
// The OCID of the compute instance member that is designated as a jump host.
// This compute instance will be used to perform DR operations on the cluster using Oracle Cloud Agent's Run Command feature.
// Example: `ocid1.instance.oc1..uniqueID`
JumpHostId *string `mandatory:"false" json:"jumpHostId"`
BackupLocation *CreateOkeBackupLocationDetails `mandatory:"false" json:"backupLocation"`
BackupConfig *CreateOkeClusterBackupConfigDetails `mandatory:"false" json:"backupConfig"`
// The list of source-to-destination load balancer mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
LoadBalancerMappings []CreateOkeClusterLoadBalancerMappingDetails `mandatory:"false" json:"loadBalancerMappings"`
// The list of source-to-destination network load balancer mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
NetworkLoadBalancerMappings []CreateOkeClusterNetworkLoadBalancerMappingDetails `mandatory:"false" json:"networkLoadBalancerMappings"`
// The list of source-to-destination vault mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
VaultMappings []CreateOkeClusterVaultMappingDetails `mandatory:"false" json:"vaultMappings"`
// The list of managed node pools with configurations for minimum and maximum node counts.
// This property applies to the OKE cluster member in both the primary and standby region.
ManagedNodePoolConfigs []CreateOkeClusterManagedNodePoolConfigurationDetails `mandatory:"false" json:"managedNodePoolConfigs"`
// The list of virtual node pools with configurations for minimum and maximum node counts.
// This property applies to the OKE cluster member in both the primary and standby region.
VirtualNodePoolConfigs []CreateOkeClusterVirtualNodePoolConfigurationDetails `mandatory:"false" json:"virtualNodePoolConfigs"`
}
func (m CreateDrProtectionGroupMemberOkeClusterDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberOkeClusterDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberOkeClusterDetails) String() string
func (m CreateDrProtectionGroupMemberOkeClusterDetails) 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
CreateDrProtectionGroupMemberVolumeGroupDetails Create properties for a volume group member.
type CreateDrProtectionGroupMemberVolumeGroupDetails struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
}
func (m CreateDrProtectionGroupMemberVolumeGroupDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m CreateDrProtectionGroupMemberVolumeGroupDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDrProtectionGroupMemberVolumeGroupDetails) String() string
func (m CreateDrProtectionGroupMemberVolumeGroupDetails) 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
CreateDrProtectionGroupRequest wrapper for the CreateDrProtectionGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CreateDrProtectionGroup.go.html to see an example of how to use CreateDrProtectionGroupRequest.
type CreateDrProtectionGroupRequest struct {
// Details for creating the DR protection group.
CreateDrProtectionGroupDetails `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"`
// The client request ID for tracing.
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 CreateDrProtectionGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDrProtectionGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDrProtectionGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDrProtectionGroupRequest) String() string
func (request CreateDrProtectionGroupRequest) 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
CreateDrProtectionGroupResponse wrapper for the CreateDrProtectionGroup operation
type CreateDrProtectionGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The DrProtectionGroup instance
DrProtectionGroup `presentIn:"body"`
// A URI for the new resource which was created by the request.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. For more information, see ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 CreateDrProtectionGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDrProtectionGroupResponse) String() string
CreateFileSystemMountDetails The details for creating a file system mount.
type CreateFileSystemMountDetails struct {
// The OCID of the mount target for this file system.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"false" json:"mountTargetId"`
}
func (m CreateFileSystemMountDetails) String() string
func (m CreateFileSystemMountDetails) 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
CreateFileSystemUnmountDetails The details for creating a file system unmount.
type CreateFileSystemUnmountDetails struct {
// The OCID of the mount target.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"false" json:"mountTargetId"`
}
func (m CreateFileSystemUnmountDetails) String() string
func (m CreateFileSystemUnmountDetails) 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
CreateObjectStorageLogLocationDetails The details for creating an object storage log location for a DR protection group.
type CreateObjectStorageLogLocationDetails struct {
// The namespace in object storage (Note - this is usually the tenancy name).
// Example: `myocitenancy`
Namespace *string `mandatory:"true" json:"namespace"`
// The bucket name inside the object storage namespace.
// Example: `operation_logs`
Bucket *string `mandatory:"true" json:"bucket"`
}
func (m CreateObjectStorageLogLocationDetails) String() string
func (m CreateObjectStorageLogLocationDetails) 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
CreateOkeBackupLocationDetails The details for creating the backup location of an OKE Cluster.
type CreateOkeBackupLocationDetails struct {
// The namespace in the object storage bucket location (Note - this is usually the tenancy name).
// Example: `myocitenancy`
Namespace *string `mandatory:"false" json:"namespace"`
// The bucket name inside the object storage namespace.
// Example: `operation_logs`
Bucket *string `mandatory:"false" json:"bucket"`
}
func (m CreateOkeBackupLocationDetails) String() string
func (m CreateOkeBackupLocationDetails) 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
CreateOkeClusterBackupConfigDetails Create backup configuration properties for an OKE member.
type CreateOkeClusterBackupConfigDetails struct {
// A list of namespaces that need to be backed up.
// The default value is null. If a list of namespaces is not provided, all namespaces will be backed up.
// This property applies to the OKE cluster member in primary region.
// Example: ["default", "pv-nginx"]
Namespaces []string `mandatory:"false" json:"namespaces"`
// The schedule for backing up namespaces to the destination region. If a backup schedule is not specified, only a single backup will be created.
// This format of the string specifying the backup schedule must conform with RFC-5545 (see examples below).
// This schedule will use the UTC timezone.
// This property applies to the OKE cluster member in primary region.
// The backup frequency can be HOURLY, DAILY, WEEKLY or MONTHLY, and the upper and lower interval bounds are as follows
// HOURLY
// - Minimum = 1
// - Maximum = 24
// DAILY
// - Minimum = 1
// - Maximum = 30
// WEEKLY
// - Minimum = 1
// - Maximum = 1
// MONTHLY
// - Minimum = 1
// - Maximum = 12
// Examples:
// FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=10;INTERVAL=1 -> Run a backup every week on monday and wednesday at 10:00 AM.
// FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=10;INTERVAL=2 -> Invalid configuration (can not specify interval of 2).
// FREQ=HOURLY;INTERVAL=25 -> Invalid configuration (can not specify interval of 25).
// FREQ=HOURLY;INTERVAL=0 -> Invalid configuration (can not specify interval of 0).
// FREQ=HOURLY;INTERVAL=24 -> Run a backup every 24 hours.
// FREQ=HOURLY;INTERVAL=1 -> Run a backup every hour.
// FREQ=HOURLY;BYMINUTE=30;INTERVAL=15 -> Run a backup every 15 hours at the 30th minute.
//
// FREQ=DAILY;INTERVAL=31 -> Invalid configuration (can not specify interval of 31).
// FREQ=DAILY;INTERVAL=0 -> Invalid configuration (can not specify interval of 0).
// FREQ=DAILY;INTERVAL=30 -> Run a backup every 30 days at 12:00 midnight.
// FREQ=DAILY;BYHOUR=17;BYMINUTE=10;INTERVAL=1 -> Run a backup every day at 05:10 PM.
BackupSchedule *string `mandatory:"false" json:"backupSchedule"`
// Controls the behaviour of image replication across regions.
// Image replication is enabled by default for DR Protection Groups with a primary role.
// This property applies to the OKE cluster member in primary region.
ReplicateImages OkeClusterImageReplicationEnum `mandatory:"false" json:"replicateImages,omitempty"`
// The maximum number of backups that should be retained.
// This property applies to the OKE cluster member in primary region.
MaxNumberOfBackupsRetained *int `mandatory:"false" json:"maxNumberOfBackupsRetained"`
// The OCID of the vault secret that stores the image credential.
// This property applies to the OKE cluster member in both the primary and standby region.
ImageReplicationVaultSecretId *string `mandatory:"false" json:"imageReplicationVaultSecretId"`
}
func (m CreateOkeClusterBackupConfigDetails) String() string
func (m CreateOkeClusterBackupConfigDetails) 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
CreateOkeClusterLoadBalancerMappingDetails Create source-to-destination mapping for a load balancer.
type CreateOkeClusterLoadBalancerMappingDetails struct {
// The OCID of the source Load Balancer.
//
// Example: `ocid1.loadbalancer.oc1..uniqueID`
SourceLoadBalancerId *string `mandatory:"true" json:"sourceLoadBalancerId"`
// The OCID of the destination Load Balancer.
// Example: `ocid1.loadbalancer.oc1..uniqueID`
DestinationLoadBalancerId *string `mandatory:"true" json:"destinationLoadBalancerId"`
}
func (m CreateOkeClusterLoadBalancerMappingDetails) String() string
func (m CreateOkeClusterLoadBalancerMappingDetails) 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
CreateOkeClusterManagedNodePoolConfigurationDetails Create managed node pool configuration properties for an OKE member.
type CreateOkeClusterManagedNodePoolConfigurationDetails struct {
// The OCID of the managed node pool in OKE cluster.
Id *string `mandatory:"true" json:"id"`
// The minimum number to which nodes in the managed node pool could be scaled down.
Minimum *int `mandatory:"false" json:"minimum"`
// The maximum number to which nodes in the managed node pool could be scaled up.
Maximum *int `mandatory:"false" json:"maximum"`
}
func (m CreateOkeClusterManagedNodePoolConfigurationDetails) String() string
func (m CreateOkeClusterManagedNodePoolConfigurationDetails) 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
CreateOkeClusterNetworkLoadBalancerMappingDetails Create source-to-destination mapping for a network load balancer.
type CreateOkeClusterNetworkLoadBalancerMappingDetails struct {
// The OCID of the source Network Load Balancer.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
SourceNetworkLoadBalancerId *string `mandatory:"true" json:"sourceNetworkLoadBalancerId"`
// The OCID of the Network Load Balancer.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
DestinationNetworkLoadBalancerId *string `mandatory:"true" json:"destinationNetworkLoadBalancerId"`
}
func (m CreateOkeClusterNetworkLoadBalancerMappingDetails) String() string
func (m CreateOkeClusterNetworkLoadBalancerMappingDetails) 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
CreateOkeClusterVaultMappingDetails Create source-to-destination mapping for a vault.
type CreateOkeClusterVaultMappingDetails struct {
// The OCID of the source Vault.
// Example: `ocid1.vault.oc1..uniqueID`
SourceVaultId *string `mandatory:"true" json:"sourceVaultId"`
// The OCID of the destination Vault.
// Example: `ocid1.vault.oc1..uniqueID`
DestinationVaultId *string `mandatory:"true" json:"destinationVaultId"`
}
func (m CreateOkeClusterVaultMappingDetails) String() string
func (m CreateOkeClusterVaultMappingDetails) 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
CreateOkeClusterVirtualNodePoolConfigurationDetails Create virtual node pool configuration properties for an OKE member.
type CreateOkeClusterVirtualNodePoolConfigurationDetails struct {
// The OCID of the virtual node pool in OKE cluster.
Id *string `mandatory:"true" json:"id"`
// The minimum number to which nodes in the virtual node pool could be scaled down.
Minimum *int `mandatory:"false" json:"minimum"`
// The maximum number to which nodes in the virtual node pool could be scaled up.
Maximum *int `mandatory:"false" json:"maximum"`
}
func (m CreateOkeClusterVirtualNodePoolConfigurationDetails) String() string
func (m CreateOkeClusterVirtualNodePoolConfigurationDetails) 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
DeleteDrPlanExecutionRequest wrapper for the DeleteDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/DeleteDrPlanExecution.go.html to see an example of how to use DeleteDrPlanExecutionRequest.
type DeleteDrPlanExecutionRequest struct {
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"true" contributesTo:"path" name:"drPlanExecutionId"`
// 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"`
// The client request ID for tracing.
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 DeleteDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDrPlanExecutionRequest) String() string
func (request DeleteDrPlanExecutionRequest) 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
DeleteDrPlanExecutionResponse wrapper for the DeleteDrPlanExecution operation
type DeleteDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 DeleteDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDrPlanExecutionResponse) String() string
DeleteDrPlanRequest wrapper for the DeleteDrPlan operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/DeleteDrPlan.go.html to see an example of how to use DeleteDrPlanRequest.
type DeleteDrPlanRequest struct {
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
DrPlanId *string `mandatory:"true" contributesTo:"path" name:"drPlanId"`
// 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"`
// The client request ID for tracing.
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 DeleteDrPlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDrPlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDrPlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDrPlanRequest) String() string
func (request DeleteDrPlanRequest) 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
DeleteDrPlanResponse wrapper for the DeleteDrPlan operation
type DeleteDrPlanResponse 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 DeleteDrPlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDrPlanResponse) String() string
DeleteDrProtectionGroupRequest wrapper for the DeleteDrProtectionGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/DeleteDrProtectionGroup.go.html to see an example of how to use DeleteDrProtectionGroupRequest.
type DeleteDrProtectionGroupRequest struct {
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"path" name:"drProtectionGroupId"`
// 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"`
// The client request ID for tracing.
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 DeleteDrProtectionGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDrProtectionGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDrProtectionGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDrProtectionGroupRequest) String() string
func (request DeleteDrProtectionGroupRequest) 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
DeleteDrProtectionGroupResponse wrapper for the DeleteDrProtectionGroup operation
type DeleteDrProtectionGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 DeleteDrProtectionGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDrProtectionGroupResponse) String() string
DisassociateDrProtectionGroupDefaultDetails The default type.
type DisassociateDrProtectionGroupDefaultDetails struct {
}
func (m DisassociateDrProtectionGroupDefaultDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DisassociateDrProtectionGroupDefaultDetails) String() string
func (m DisassociateDrProtectionGroupDefaultDetails) 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
DisassociateDrProtectionGroupDetails The details for disassociating this DR protection group from a peer DR protection group.
type DisassociateDrProtectionGroupDetails interface {
}
DisassociateDrProtectionGroupDetailsTypeEnum Enum with underlying type: string
type DisassociateDrProtectionGroupDetailsTypeEnum string
Set of constants representing the allowable values for DisassociateDrProtectionGroupDetailsTypeEnum
const (
DisassociateDrProtectionGroupDetailsTypeDefault DisassociateDrProtectionGroupDetailsTypeEnum = "DEFAULT"
)
func GetDisassociateDrProtectionGroupDetailsTypeEnumValues() []DisassociateDrProtectionGroupDetailsTypeEnum
GetDisassociateDrProtectionGroupDetailsTypeEnumValues Enumerates the set of values for DisassociateDrProtectionGroupDetailsTypeEnum
func GetMappingDisassociateDrProtectionGroupDetailsTypeEnum(val string) (DisassociateDrProtectionGroupDetailsTypeEnum, bool)
GetMappingDisassociateDrProtectionGroupDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DisassociateDrProtectionGroupRequest wrapper for the DisassociateDrProtectionGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/DisassociateDrProtectionGroup.go.html to see an example of how to use DisassociateDrProtectionGroupRequest.
type DisassociateDrProtectionGroupRequest struct {
// Details for deleting the association between two DR protection groups.
DisassociateDrProtectionGroupDetails `contributesTo:"body"`
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"path" name:"drProtectionGroupId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 DisassociateDrProtectionGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DisassociateDrProtectionGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DisassociateDrProtectionGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DisassociateDrProtectionGroupRequest) String() string
func (request DisassociateDrProtectionGroupRequest) 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
DisassociateDrProtectionGroupResponse wrapper for the DisassociateDrProtectionGroup operation
type DisassociateDrProtectionGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 DisassociateDrProtectionGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DisassociateDrProtectionGroupResponse) String() string
DisasterRecoveryClient a client for DisasterRecovery
type DisasterRecoveryClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDisasterRecoveryClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DisasterRecoveryClient, err error)
NewDisasterRecoveryClientWithConfigurationProvider Creates a new default DisasterRecovery client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDisasterRecoveryClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DisasterRecoveryClient, err error)
NewDisasterRecoveryClientWithOboToken Creates a new default DisasterRecovery 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 DisasterRecoveryClient) AssociateDrProtectionGroup(ctx context.Context, request AssociateDrProtectionGroupRequest) (response AssociateDrProtectionGroupResponse, err error)
AssociateDrProtectionGroup Create an association between the DR protection group identified by *drProtectionGroupId* and another DR protection group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/AssociateDrProtectionGroup.go.html to see an example of how to use AssociateDrProtectionGroup API. A default retry strategy applies to this operation AssociateDrProtectionGroup()
func (client DisasterRecoveryClient) CancelDrPlanExecution(ctx context.Context, request CancelDrPlanExecutionRequest) (response CancelDrPlanExecutionResponse, err error)
CancelDrPlanExecution Cancel the DR plan execution identified by *drPlanExecutionId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CancelDrPlanExecution.go.html to see an example of how to use CancelDrPlanExecution API. A default retry strategy applies to this operation CancelDrPlanExecution()
func (client DisasterRecoveryClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancel the work request identified by *workRequestId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client DisasterRecoveryClient) ChangeDrProtectionGroupCompartment(ctx context.Context, request ChangeDrProtectionGroupCompartmentRequest) (response ChangeDrProtectionGroupCompartmentResponse, err error)
ChangeDrProtectionGroupCompartment Move the DR protection group identified by *drProtectionGroupId* to a different compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ChangeDrProtectionGroupCompartment.go.html to see an example of how to use ChangeDrProtectionGroupCompartment API. A default retry strategy applies to this operation ChangeDrProtectionGroupCompartment()
func (client *DisasterRecoveryClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DisasterRecoveryClient) CreateDrPlan(ctx context.Context, request CreateDrPlanRequest) (response CreateDrPlanResponse, err error)
CreateDrPlan Create a DR plan of the specified DR plan type.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CreateDrPlan.go.html to see an example of how to use CreateDrPlan API. A default retry strategy applies to this operation CreateDrPlan()
func (client DisasterRecoveryClient) CreateDrPlanExecution(ctx context.Context, request CreateDrPlanExecutionRequest) (response CreateDrPlanExecutionResponse, err error)
CreateDrPlanExecution Execute a DR plan for a DR protection group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CreateDrPlanExecution.go.html to see an example of how to use CreateDrPlanExecution API. A default retry strategy applies to this operation CreateDrPlanExecution()
func (client DisasterRecoveryClient) CreateDrProtectionGroup(ctx context.Context, request CreateDrProtectionGroupRequest) (response CreateDrProtectionGroupResponse, err error)
CreateDrProtectionGroup Create a DR protection group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/CreateDrProtectionGroup.go.html to see an example of how to use CreateDrProtectionGroup API. A default retry strategy applies to this operation CreateDrProtectionGroup()
func (client DisasterRecoveryClient) DeleteDrPlan(ctx context.Context, request DeleteDrPlanRequest) (response DeleteDrPlanResponse, err error)
DeleteDrPlan Delete the DR plan identified by *drPlanId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/DeleteDrPlan.go.html to see an example of how to use DeleteDrPlan API. A default retry strategy applies to this operation DeleteDrPlan()
func (client DisasterRecoveryClient) DeleteDrPlanExecution(ctx context.Context, request DeleteDrPlanExecutionRequest) (response DeleteDrPlanExecutionResponse, err error)
DeleteDrPlanExecution Delete the DR plan execution identified by *drPlanExecutionId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/DeleteDrPlanExecution.go.html to see an example of how to use DeleteDrPlanExecution API. A default retry strategy applies to this operation DeleteDrPlanExecution()
func (client DisasterRecoveryClient) DeleteDrProtectionGroup(ctx context.Context, request DeleteDrProtectionGroupRequest) (response DeleteDrProtectionGroupResponse, err error)
DeleteDrProtectionGroup Delete the DR protection group identified by *drProtectionGroupId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/DeleteDrProtectionGroup.go.html to see an example of how to use DeleteDrProtectionGroup API. A default retry strategy applies to this operation DeleteDrProtectionGroup()
func (client DisasterRecoveryClient) DisassociateDrProtectionGroup(ctx context.Context, request DisassociateDrProtectionGroupRequest) (response DisassociateDrProtectionGroupResponse, err error)
DisassociateDrProtectionGroup Delete the association between the DR protection group identified by *drProtectionGroupId*. and its peer DR protection group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/DisassociateDrProtectionGroup.go.html to see an example of how to use DisassociateDrProtectionGroup API. A default retry strategy applies to this operation DisassociateDrProtectionGroup()
func (client DisasterRecoveryClient) GetDrPlan(ctx context.Context, request GetDrPlanRequest) (response GetDrPlanResponse, err error)
GetDrPlan Get details for the DR plan identified by *drPlanId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/GetDrPlan.go.html to see an example of how to use GetDrPlan API. A default retry strategy applies to this operation GetDrPlan()
func (client DisasterRecoveryClient) GetDrPlanExecution(ctx context.Context, request GetDrPlanExecutionRequest) (response GetDrPlanExecutionResponse, err error)
GetDrPlanExecution Get details for the DR plan execution identified by *drPlanExecutionId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/GetDrPlanExecution.go.html to see an example of how to use GetDrPlanExecution API. A default retry strategy applies to this operation GetDrPlanExecution()
func (client DisasterRecoveryClient) GetDrProtectionGroup(ctx context.Context, request GetDrProtectionGroupRequest) (response GetDrProtectionGroupResponse, err error)
GetDrProtectionGroup Get the DR protection group identified by *drProtectionGroupId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/GetDrProtectionGroup.go.html to see an example of how to use GetDrProtectionGroup API. A default retry strategy applies to this operation GetDrProtectionGroup()
func (client DisasterRecoveryClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Get the status of the work request identified by *workRequestId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client DisasterRecoveryClient) IgnoreDrPlanExecution(ctx context.Context, request IgnoreDrPlanExecutionRequest) (response IgnoreDrPlanExecutionResponse, err error)
IgnoreDrPlanExecution Ignore the failed group or step in DR plan execution identified by *drPlanExecutionId* and resume execution.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/IgnoreDrPlanExecution.go.html to see an example of how to use IgnoreDrPlanExecution API. A default retry strategy applies to this operation IgnoreDrPlanExecution()
func (client DisasterRecoveryClient) ListDrPlanExecutions(ctx context.Context, request ListDrPlanExecutionsRequest) (response ListDrPlanExecutionsResponse, err error)
ListDrPlanExecutions Get a summary list of all DR plan executions for a DR protection group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListDrPlanExecutions.go.html to see an example of how to use ListDrPlanExecutions API. A default retry strategy applies to this operation ListDrPlanExecutions()
func (client DisasterRecoveryClient) ListDrPlans(ctx context.Context, request ListDrPlansRequest) (response ListDrPlansResponse, err error)
ListDrPlans Get a summary list of all DR plans for a DR protection group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListDrPlans.go.html to see an example of how to use ListDrPlans API. A default retry strategy applies to this operation ListDrPlans()
func (client DisasterRecoveryClient) ListDrProtectionGroups(ctx context.Context, request ListDrProtectionGroupsRequest) (response ListDrProtectionGroupsResponse, err error)
ListDrProtectionGroups Get a summary list of all DR protection groups in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListDrProtectionGroups.go.html to see an example of how to use ListDrProtectionGroups API. A default retry strategy applies to this operation ListDrProtectionGroups()
func (client DisasterRecoveryClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Get a list of work request errors for the work request identified by *workRequestId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client DisasterRecoveryClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Get a list of logs for the work request identified by *workRequestId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client DisasterRecoveryClient) 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/disasterrecovery/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client DisasterRecoveryClient) PauseDrPlanExecution(ctx context.Context, request PauseDrPlanExecutionRequest) (response PauseDrPlanExecutionResponse, err error)
PauseDrPlanExecution Pause the DR plan execution identified by *drPlanExecutionId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/PauseDrPlanExecution.go.html to see an example of how to use PauseDrPlanExecution API. A default retry strategy applies to this operation PauseDrPlanExecution()
func (client DisasterRecoveryClient) RefreshDrPlan(ctx context.Context, request RefreshDrPlanRequest) (response RefreshDrPlanResponse, err error)
RefreshDrPlan Refresh DR Plan identified by *drPlanId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/RefreshDrPlan.go.html to see an example of how to use RefreshDrPlan API. A default retry strategy applies to this operation RefreshDrPlan()
func (client DisasterRecoveryClient) ResumeDrPlanExecution(ctx context.Context, request ResumeDrPlanExecutionRequest) (response ResumeDrPlanExecutionResponse, err error)
ResumeDrPlanExecution Resume the DR plan execution identified by *drPlanExecutionId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ResumeDrPlanExecution.go.html to see an example of how to use ResumeDrPlanExecution API. A default retry strategy applies to this operation ResumeDrPlanExecution()
func (client DisasterRecoveryClient) RetryDrPlanExecution(ctx context.Context, request RetryDrPlanExecutionRequest) (response RetryDrPlanExecutionResponse, err error)
RetryDrPlanExecution Retry the failed group or step in DR plan execution identified by *drPlanExecutionId* and resume execution.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/RetryDrPlanExecution.go.html to see an example of how to use RetryDrPlanExecution API. A default retry strategy applies to this operation RetryDrPlanExecution()
func (client *DisasterRecoveryClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DisasterRecoveryClient) UpdateDrPlan(ctx context.Context, request UpdateDrPlanRequest) (response UpdateDrPlanResponse, err error)
UpdateDrPlan Update the DR plan identified by *drPlanId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/UpdateDrPlan.go.html to see an example of how to use UpdateDrPlan API. A default retry strategy applies to this operation UpdateDrPlan()
func (client DisasterRecoveryClient) UpdateDrPlanExecution(ctx context.Context, request UpdateDrPlanExecutionRequest) (response UpdateDrPlanExecutionResponse, err error)
UpdateDrPlanExecution Update the DR plan execution identified by *drPlanExecutionId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/UpdateDrPlanExecution.go.html to see an example of how to use UpdateDrPlanExecution API. A default retry strategy applies to this operation UpdateDrPlanExecution()
func (client DisasterRecoveryClient) UpdateDrProtectionGroup(ctx context.Context, request UpdateDrProtectionGroupRequest) (response UpdateDrProtectionGroupResponse, err error)
UpdateDrProtectionGroup Update the DR protection group identified by *drProtectionGroupId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/UpdateDrProtectionGroup.go.html to see an example of how to use UpdateDrProtectionGroup API. A default retry strategy applies to this operation UpdateDrProtectionGroup()
func (client DisasterRecoveryClient) UpdateDrProtectionGroupRole(ctx context.Context, request UpdateDrProtectionGroupRoleRequest) (response UpdateDrProtectionGroupRoleResponse, err error)
UpdateDrProtectionGroupRole Update the role of the DR protection group identified by *drProtectionGroupId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/UpdateDrProtectionGroupRole.go.html to see an example of how to use UpdateDrProtectionGroupRole API. A default retry strategy applies to this operation UpdateDrProtectionGroupRole()
func (client DisasterRecoveryClient) VerifyDrPlan(ctx context.Context, request VerifyDrPlanRequest) (response VerifyDrPlanResponse, err error)
VerifyDrPlan Verify DR Plan identified by *drPlanId*.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/VerifyDrPlan.go.html to see an example of how to use VerifyDrPlan API. A default retry strategy applies to this operation VerifyDrPlan()
DrPlan The details of a DR plan.
type DrPlan struct {
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
Id *string `mandatory:"true" json:"id"`
// The display name of the DR plan.
// Example: `EBS Switchover PHX to IAD`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment containing the DR plan.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of the DR plan.
Type DrPlanTypeEnum `mandatory:"true" json:"type"`
// The date and time the DR plan was created. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the DR plan was updated. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The OCID of the DR protection group to which this DR plan belongs.
// Example: `ocid1.drplan.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" json:"drProtectionGroupId"`
// The OCID of the peer DR protection group associated with this plan's
// DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
PeerDrProtectionGroupId *string `mandatory:"true" json:"peerDrProtectionGroupId"`
// The region of the peer DR protection group associated with this plan's
// DR protection group.
// Example: `us-ashburn-1`
PeerRegion *string `mandatory:"true" json:"peerRegion"`
// The list of groups in this DR plan.
PlanGroups []DrPlanGroup `mandatory:"true" json:"planGroups"`
// The current state of the DR plan.
LifecycleState DrPlanLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan.
// If this DR plan was not cloned, then the value for this will be `null`.
// Example: `ocid1.drplan.oc1..uniqueID`
SourcePlanId *string `mandatory:"false" json:"sourcePlanId"`
// The current state of the DR plan.
LifecycleSubState DrPlanLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// A message describing the DR plan's current state in more detail.
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: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
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"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DrPlan) String() string
func (m DrPlan) 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
DrPlanCollection A list of DR plan summaries.
type DrPlanCollection struct {
// A list of DR plan summaries.
Items []DrPlanSummary `mandatory:"true" json:"items"`
}
func (m DrPlanCollection) String() string
func (m DrPlanCollection) 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
DrPlanExecution The details of a DR plan execution.
type DrPlanExecution struct {
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing this DR plan execution.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the DR plan execution.
// Example: `Execution - EBS Switchover PHX to IAD`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
PlanId *string `mandatory:"true" json:"planId"`
// The type of the DR plan executed.
PlanExecutionType DrPlanExecutionTypeEnum `mandatory:"true" json:"planExecutionType"`
ExecutionOptions DrPlanExecutionOptions `mandatory:"true" json:"executionOptions"`
// The OCID of the DR protection group to which this DR plan execution belongs.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" json:"drProtectionGroupId"`
// The OCID of peer DR protection group associated with this plan's
// DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
PeerDrProtectionGroupId *string `mandatory:"true" json:"peerDrProtectionGroupId"`
// The region of the peer DR protection group associated with this plan's
// DR protection group.
// Example: `us-ashburn-1`
PeerRegion *string `mandatory:"true" json:"peerRegion"`
LogLocation *ObjectStorageLogLocation `mandatory:"true" json:"logLocation"`
// The date and time at which DR plan execution was created. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when DR plan execution was last updated. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// A list of groups executed in this DR plan execution.
GroupExecutions []DrPlanGroupExecution `mandatory:"true" json:"groupExecutions"`
// The current state of the DR plan execution.
LifecycleState DrPlanExecutionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time at which DR plan execution began. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time at which DR plan execution succeeded, failed, was paused, or was canceled.
// An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The total duration in seconds taken to complete the DR plan execution.
// Example: `750`
ExecutionDurationInSec *int `mandatory:"false" json:"executionDurationInSec"`
// A message describing the DR plan execution's current state in more detail.
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: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
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"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DrPlanExecution) String() string
func (m *DrPlanExecution) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DrPlanExecution) 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
DrPlanExecutionCollection A list of DR plan execution summaries.
type DrPlanExecutionCollection struct {
// A list of DR plan execution summaries.
Items []DrPlanExecutionSummary `mandatory:"true" json:"items"`
}
func (m DrPlanExecutionCollection) String() string
func (m DrPlanExecutionCollection) 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
DrPlanExecutionControlDetails The details for controlling plan execution.
type DrPlanExecutionControlDetails interface {
}
DrPlanExecutionControlDetailsActionTypeEnum Enum with underlying type: string
type DrPlanExecutionControlDetailsActionTypeEnum string
Set of constants representing the allowable values for DrPlanExecutionControlDetailsActionTypeEnum
const (
DrPlanExecutionControlDetailsActionTypeCancel DrPlanExecutionControlDetailsActionTypeEnum = "CANCEL"
DrPlanExecutionControlDetailsActionTypePause DrPlanExecutionControlDetailsActionTypeEnum = "PAUSE"
DrPlanExecutionControlDetailsActionTypeResume DrPlanExecutionControlDetailsActionTypeEnum = "RESUME"
)
func GetDrPlanExecutionControlDetailsActionTypeEnumValues() []DrPlanExecutionControlDetailsActionTypeEnum
GetDrPlanExecutionControlDetailsActionTypeEnumValues Enumerates the set of values for DrPlanExecutionControlDetailsActionTypeEnum
func GetMappingDrPlanExecutionControlDetailsActionTypeEnum(val string) (DrPlanExecutionControlDetailsActionTypeEnum, bool)
GetMappingDrPlanExecutionControlDetailsActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanExecutionLifecycleStateEnum Enum with underlying type: string
type DrPlanExecutionLifecycleStateEnum string
Set of constants representing the allowable values for DrPlanExecutionLifecycleStateEnum
const (
DrPlanExecutionLifecycleStateAccepted DrPlanExecutionLifecycleStateEnum = "ACCEPTED"
DrPlanExecutionLifecycleStateInProgress DrPlanExecutionLifecycleStateEnum = "IN_PROGRESS"
DrPlanExecutionLifecycleStateWaiting DrPlanExecutionLifecycleStateEnum = "WAITING"
DrPlanExecutionLifecycleStateCanceling DrPlanExecutionLifecycleStateEnum = "CANCELING"
DrPlanExecutionLifecycleStateCanceled DrPlanExecutionLifecycleStateEnum = "CANCELED"
DrPlanExecutionLifecycleStateSucceeded DrPlanExecutionLifecycleStateEnum = "SUCCEEDED"
DrPlanExecutionLifecycleStateFailed DrPlanExecutionLifecycleStateEnum = "FAILED"
DrPlanExecutionLifecycleStateDeleting DrPlanExecutionLifecycleStateEnum = "DELETING"
DrPlanExecutionLifecycleStateDeleted DrPlanExecutionLifecycleStateEnum = "DELETED"
DrPlanExecutionLifecycleStatePausing DrPlanExecutionLifecycleStateEnum = "PAUSING"
DrPlanExecutionLifecycleStatePaused DrPlanExecutionLifecycleStateEnum = "PAUSED"
DrPlanExecutionLifecycleStateResuming DrPlanExecutionLifecycleStateEnum = "RESUMING"
)
func GetDrPlanExecutionLifecycleStateEnumValues() []DrPlanExecutionLifecycleStateEnum
GetDrPlanExecutionLifecycleStateEnumValues Enumerates the set of values for DrPlanExecutionLifecycleStateEnum
func GetMappingDrPlanExecutionLifecycleStateEnum(val string) (DrPlanExecutionLifecycleStateEnum, bool)
GetMappingDrPlanExecutionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanExecutionOptionDetails The options for a plan execution.
type DrPlanExecutionOptionDetails interface {
}
DrPlanExecutionOptionDetailsPlanExecutionTypeEnum Enum with underlying type: string
type DrPlanExecutionOptionDetailsPlanExecutionTypeEnum string
Set of constants representing the allowable values for DrPlanExecutionOptionDetailsPlanExecutionTypeEnum
const (
DrPlanExecutionOptionDetailsPlanExecutionTypeSwitchover DrPlanExecutionOptionDetailsPlanExecutionTypeEnum = "SWITCHOVER"
DrPlanExecutionOptionDetailsPlanExecutionTypeSwitchoverPrecheck DrPlanExecutionOptionDetailsPlanExecutionTypeEnum = "SWITCHOVER_PRECHECK"
DrPlanExecutionOptionDetailsPlanExecutionTypeFailover DrPlanExecutionOptionDetailsPlanExecutionTypeEnum = "FAILOVER"
DrPlanExecutionOptionDetailsPlanExecutionTypeFailoverPrecheck DrPlanExecutionOptionDetailsPlanExecutionTypeEnum = "FAILOVER_PRECHECK"
DrPlanExecutionOptionDetailsPlanExecutionTypeStartDrill DrPlanExecutionOptionDetailsPlanExecutionTypeEnum = "START_DRILL"
DrPlanExecutionOptionDetailsPlanExecutionTypeStartDrillPrecheck DrPlanExecutionOptionDetailsPlanExecutionTypeEnum = "START_DRILL_PRECHECK"
DrPlanExecutionOptionDetailsPlanExecutionTypeStopDrill DrPlanExecutionOptionDetailsPlanExecutionTypeEnum = "STOP_DRILL"
DrPlanExecutionOptionDetailsPlanExecutionTypeStopDrillPrecheck DrPlanExecutionOptionDetailsPlanExecutionTypeEnum = "STOP_DRILL_PRECHECK"
)
func GetDrPlanExecutionOptionDetailsPlanExecutionTypeEnumValues() []DrPlanExecutionOptionDetailsPlanExecutionTypeEnum
GetDrPlanExecutionOptionDetailsPlanExecutionTypeEnumValues Enumerates the set of values for DrPlanExecutionOptionDetailsPlanExecutionTypeEnum
func GetMappingDrPlanExecutionOptionDetailsPlanExecutionTypeEnum(val string) (DrPlanExecutionOptionDetailsPlanExecutionTypeEnum, bool)
GetMappingDrPlanExecutionOptionDetailsPlanExecutionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanExecutionOptions The options for a plan execution.
type DrPlanExecutionOptions interface {
}
DrPlanExecutionOptionsPlanExecutionTypeEnum Enum with underlying type: string
type DrPlanExecutionOptionsPlanExecutionTypeEnum string
Set of constants representing the allowable values for DrPlanExecutionOptionsPlanExecutionTypeEnum
const (
DrPlanExecutionOptionsPlanExecutionTypeSwitchover DrPlanExecutionOptionsPlanExecutionTypeEnum = "SWITCHOVER"
DrPlanExecutionOptionsPlanExecutionTypeSwitchoverPrecheck DrPlanExecutionOptionsPlanExecutionTypeEnum = "SWITCHOVER_PRECHECK"
DrPlanExecutionOptionsPlanExecutionTypeFailover DrPlanExecutionOptionsPlanExecutionTypeEnum = "FAILOVER"
DrPlanExecutionOptionsPlanExecutionTypeFailoverPrecheck DrPlanExecutionOptionsPlanExecutionTypeEnum = "FAILOVER_PRECHECK"
DrPlanExecutionOptionsPlanExecutionTypeStartDrillPrecheck DrPlanExecutionOptionsPlanExecutionTypeEnum = "START_DRILL_PRECHECK"
DrPlanExecutionOptionsPlanExecutionTypeStartDrill DrPlanExecutionOptionsPlanExecutionTypeEnum = "START_DRILL"
DrPlanExecutionOptionsPlanExecutionTypeStopDrillPrecheck DrPlanExecutionOptionsPlanExecutionTypeEnum = "STOP_DRILL_PRECHECK"
DrPlanExecutionOptionsPlanExecutionTypeStopDrill DrPlanExecutionOptionsPlanExecutionTypeEnum = "STOP_DRILL"
)
func GetDrPlanExecutionOptionsPlanExecutionTypeEnumValues() []DrPlanExecutionOptionsPlanExecutionTypeEnum
GetDrPlanExecutionOptionsPlanExecutionTypeEnumValues Enumerates the set of values for DrPlanExecutionOptionsPlanExecutionTypeEnum
func GetMappingDrPlanExecutionOptionsPlanExecutionTypeEnum(val string) (DrPlanExecutionOptionsPlanExecutionTypeEnum, bool)
GetMappingDrPlanExecutionOptionsPlanExecutionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanExecutionSummary The summary of a DR plan execution.
type DrPlanExecutionSummary struct {
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing this plan execution.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the DR plan execution.
// Example: `Execution - EBS Switchover PHX to IAD`
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the DR plan for this DR plan execution.
// Example: `ocid1.drplan.oc1..uniqueID`
PlanId *string `mandatory:"true" json:"planId"`
// The type of the DR plan execution.
PlanExecutionType DrPlanExecutionTypeEnum `mandatory:"true" json:"planExecutionType"`
// The OCID of the DR protection group to which this DR plan execution belongs.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" json:"drProtectionGroupId"`
// The OCID of peer DR protection group associated with this DR plan execution's
// DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
PeerDrProtectionGroupId *string `mandatory:"true" json:"peerDrProtectionGroupId"`
// The region of the peer DR protection group associated with this DR plan execution's
// DR protection group.
// Example: `us-ashburn-1`
PeerRegion *string `mandatory:"true" json:"peerRegion"`
LogLocation *ObjectStorageLogLocation `mandatory:"true" json:"logLocation"`
// The date and time at which DR plan execution was created. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when this DR plan execution was last updated.
// Example: `2019-03-29T09:36:42Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the DR plan execution.
LifecycleState DrPlanExecutionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time at which DR plan execution began. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time at which DR plan execution succeeded, failed, was paused, or canceled.
// An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The total duration in seconds taken to complete the DR plan execution.
// Example: `750`
ExecutionDurationInSec *int `mandatory:"false" json:"executionDurationInSec"`
// A message describing the DR plan execution's current state in more detail.
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: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
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"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DrPlanExecutionSummary) String() string
func (m DrPlanExecutionSummary) 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
DrPlanExecutionTypeEnum Enum with underlying type: string
type DrPlanExecutionTypeEnum string
Set of constants representing the allowable values for DrPlanExecutionTypeEnum
const (
DrPlanExecutionTypeSwitchover DrPlanExecutionTypeEnum = "SWITCHOVER"
DrPlanExecutionTypeSwitchoverPrecheck DrPlanExecutionTypeEnum = "SWITCHOVER_PRECHECK"
DrPlanExecutionTypeFailover DrPlanExecutionTypeEnum = "FAILOVER"
DrPlanExecutionTypeFailoverPrecheck DrPlanExecutionTypeEnum = "FAILOVER_PRECHECK"
DrPlanExecutionTypeStartDrill DrPlanExecutionTypeEnum = "START_DRILL"
DrPlanExecutionTypeStartDrillPrecheck DrPlanExecutionTypeEnum = "START_DRILL_PRECHECK"
DrPlanExecutionTypeStopDrill DrPlanExecutionTypeEnum = "STOP_DRILL"
DrPlanExecutionTypeStopDrillPrecheck DrPlanExecutionTypeEnum = "STOP_DRILL_PRECHECK"
)
func GetDrPlanExecutionTypeEnumValues() []DrPlanExecutionTypeEnum
GetDrPlanExecutionTypeEnumValues Enumerates the set of values for DrPlanExecutionTypeEnum
func GetMappingDrPlanExecutionTypeEnum(val string) (DrPlanExecutionTypeEnum, bool)
GetMappingDrPlanExecutionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanGroup Details of a group in a DR plan.
type DrPlanGroup struct {
// The unique id of the group. Must not be modified by user.
// Example: `sgid1.group..uniqueID`
Id *string `mandatory:"true" json:"id"`
// The group type.
// Example: `BUILT_IN`
Type DrPlanGroupTypeEnum `mandatory:"true" json:"type"`
// The display name of the group.
// Example: `DATABASE_SWITCHOVER`
DisplayName *string `mandatory:"true" json:"displayName"`
// The list of steps in the group.
Steps []DrPlanStep `mandatory:"true" json:"steps"`
// The DR plan group refresh status.
// Example: `GROUP_MODIFIED`
RefreshStatus DrPlanGroupRefreshStatusEnum `mandatory:"false" json:"refreshStatus,omitempty"`
// A flag indicating whether this group should be enabled for execution.
// This flag is only applicable to the `USER_DEFINED_PAUSE` group. The flag should be null for the remaining group types.
// Example: `true`
IsPauseEnabled *bool `mandatory:"false" json:"isPauseEnabled"`
}
func (m DrPlanGroup) String() string
func (m DrPlanGroup) 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
DrPlanGroupExecution The details of a group execution in a DR plan execution.
type DrPlanGroupExecution struct {
// The unique id of the group. Must not be modified by user.
// Example: `sgid1.group..uniqueID`
GroupId *string `mandatory:"true" json:"groupId"`
// The group type.
// Example: `BUILT_IN`
Type DrPlanGroupTypeEnum `mandatory:"true" json:"type"`
// The display name of the group execution.
// Example: `DATABASE_SWITCHOVER`
DisplayName *string `mandatory:"true" json:"displayName"`
// The status of the group execution.
Status DrPlanGroupExecutionStatusEnum `mandatory:"true" json:"status"`
// A list of step executions in the group.
StepExecutions []DrPlanStepExecution `mandatory:"true" json:"stepExecutions"`
// Additional details on the group execution status.
// Example: `A total of [3] steps failed in the group`
StatusDetails *string `mandatory:"false" json:"statusDetails"`
// The time when group execution began. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The time when group execution ended. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The total duration in seconds taken to complete group execution.
// Example: `120`
ExecutionDurationInSec *int `mandatory:"false" json:"executionDurationInSec"`
}
func (m DrPlanGroupExecution) String() string
func (m DrPlanGroupExecution) 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
DrPlanGroupExecutionStatusEnum Enum with underlying type: string
type DrPlanGroupExecutionStatusEnum string
Set of constants representing the allowable values for DrPlanGroupExecutionStatusEnum
const (
DrPlanGroupExecutionStatusQueued DrPlanGroupExecutionStatusEnum = "QUEUED"
DrPlanGroupExecutionStatusDisabled DrPlanGroupExecutionStatusEnum = "DISABLED"
DrPlanGroupExecutionStatusInProgress DrPlanGroupExecutionStatusEnum = "IN_PROGRESS"
DrPlanGroupExecutionStatusSucceeded DrPlanGroupExecutionStatusEnum = "SUCCEEDED"
DrPlanGroupExecutionStatusSucceededWithWarning DrPlanGroupExecutionStatusEnum = "SUCCEEDED_WITH_WARNING"
DrPlanGroupExecutionStatusFailed DrPlanGroupExecutionStatusEnum = "FAILED"
DrPlanGroupExecutionStatusFailedIgnored DrPlanGroupExecutionStatusEnum = "FAILED_IGNORED"
DrPlanGroupExecutionStatusTimedOut DrPlanGroupExecutionStatusEnum = "TIMED_OUT"
DrPlanGroupExecutionStatusTimedOutIgnored DrPlanGroupExecutionStatusEnum = "TIMED_OUT_IGNORED"
DrPlanGroupExecutionStatusPaused DrPlanGroupExecutionStatusEnum = "PAUSED"
DrPlanGroupExecutionStatusCanceled DrPlanGroupExecutionStatusEnum = "CANCELED"
)
func GetDrPlanGroupExecutionStatusEnumValues() []DrPlanGroupExecutionStatusEnum
GetDrPlanGroupExecutionStatusEnumValues Enumerates the set of values for DrPlanGroupExecutionStatusEnum
func GetMappingDrPlanGroupExecutionStatusEnum(val string) (DrPlanGroupExecutionStatusEnum, bool)
GetMappingDrPlanGroupExecutionStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanGroupRefreshStatusEnum Enum with underlying type: string
type DrPlanGroupRefreshStatusEnum string
Set of constants representing the allowable values for DrPlanGroupRefreshStatusEnum
const (
DrPlanGroupRefreshStatusGroupAdded DrPlanGroupRefreshStatusEnum = "GROUP_ADDED"
DrPlanGroupRefreshStatusGroupDeleted DrPlanGroupRefreshStatusEnum = "GROUP_DELETED"
DrPlanGroupRefreshStatusGroupModified DrPlanGroupRefreshStatusEnum = "GROUP_MODIFIED"
)
func GetDrPlanGroupRefreshStatusEnumValues() []DrPlanGroupRefreshStatusEnum
GetDrPlanGroupRefreshStatusEnumValues Enumerates the set of values for DrPlanGroupRefreshStatusEnum
func GetMappingDrPlanGroupRefreshStatusEnum(val string) (DrPlanGroupRefreshStatusEnum, bool)
GetMappingDrPlanGroupRefreshStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanGroupTypeEnum Enum with underlying type: string
type DrPlanGroupTypeEnum string
Set of constants representing the allowable values for DrPlanGroupTypeEnum
const (
DrPlanGroupTypeUserDefined DrPlanGroupTypeEnum = "USER_DEFINED"
DrPlanGroupTypeBuiltIn DrPlanGroupTypeEnum = "BUILT_IN"
DrPlanGroupTypeBuiltInPrecheck DrPlanGroupTypeEnum = "BUILT_IN_PRECHECK"
DrPlanGroupTypeUserDefinedPause DrPlanGroupTypeEnum = "USER_DEFINED_PAUSE"
)
func GetDrPlanGroupTypeEnumValues() []DrPlanGroupTypeEnum
GetDrPlanGroupTypeEnumValues Enumerates the set of values for DrPlanGroupTypeEnum
func GetMappingDrPlanGroupTypeEnum(val string) (DrPlanGroupTypeEnum, bool)
GetMappingDrPlanGroupTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanLifecycleStateEnum Enum with underlying type: string
type DrPlanLifecycleStateEnum string
Set of constants representing the allowable values for DrPlanLifecycleStateEnum
const (
DrPlanLifecycleStateCreating DrPlanLifecycleStateEnum = "CREATING"
DrPlanLifecycleStateUpdating DrPlanLifecycleStateEnum = "UPDATING"
DrPlanLifecycleStateActive DrPlanLifecycleStateEnum = "ACTIVE"
DrPlanLifecycleStateInactive DrPlanLifecycleStateEnum = "INACTIVE"
DrPlanLifecycleStateDeleting DrPlanLifecycleStateEnum = "DELETING"
DrPlanLifecycleStateDeleted DrPlanLifecycleStateEnum = "DELETED"
DrPlanLifecycleStateFailed DrPlanLifecycleStateEnum = "FAILED"
DrPlanLifecycleStateNeedsAttention DrPlanLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetDrPlanLifecycleStateEnumValues() []DrPlanLifecycleStateEnum
GetDrPlanLifecycleStateEnumValues Enumerates the set of values for DrPlanLifecycleStateEnum
func GetMappingDrPlanLifecycleStateEnum(val string) (DrPlanLifecycleStateEnum, bool)
GetMappingDrPlanLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanLifecycleSubStateEnum Enum with underlying type: string
type DrPlanLifecycleSubStateEnum string
Set of constants representing the allowable values for DrPlanLifecycleSubStateEnum
const (
DrPlanLifecycleSubStateNeedsRefresh DrPlanLifecycleSubStateEnum = "NEEDS_REFRESH"
DrPlanLifecycleSubStateNeedsVerification DrPlanLifecycleSubStateEnum = "NEEDS_VERIFICATION"
DrPlanLifecycleSubStateRefreshing DrPlanLifecycleSubStateEnum = "REFRESHING"
DrPlanLifecycleSubStateVerifying DrPlanLifecycleSubStateEnum = "VERIFYING"
)
func GetDrPlanLifecycleSubStateEnumValues() []DrPlanLifecycleSubStateEnum
GetDrPlanLifecycleSubStateEnumValues Enumerates the set of values for DrPlanLifecycleSubStateEnum
func GetMappingDrPlanLifecycleSubStateEnum(val string) (DrPlanLifecycleSubStateEnum, bool)
GetMappingDrPlanLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanStep Details of a step in a DR plan.
type DrPlanStep struct {
// The unique id of the step. Must not be modified by the user.
// Example: `sgid1.step..uniqueID`
Id *string `mandatory:"true" json:"id"`
// The unique id of the group to which this step belongs. Must not be modified by user.
// Example: `sgid1.group..uniqueID`
GroupId *string `mandatory:"true" json:"groupId"`
// The plan step type.
Type DrPlanStepTypeEnum `mandatory:"true" json:"type"`
// The display name of the group.
// Example: `DATABASE_SWITCHOVER`
DisplayName *string `mandatory:"true" json:"displayName"`
// The error mode for this step.
ErrorMode DrPlanStepErrorModeEnum `mandatory:"true" json:"errorMode"`
// The timeout in seconds for executing this step.
// Example: `600`
Timeout *int `mandatory:"true" json:"timeout"`
// A flag indicating whether this step should be enabled for execution.
// Example: `true`
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The OCID of the member associated with this step.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"false" json:"memberId"`
// The DR plan step refresh status.
// Example: `STEP_ADDED`
RefreshStatus DrPlanStepRefreshStatusEnum `mandatory:"false" json:"refreshStatus,omitempty"`
UserDefinedStep DrPlanUserDefinedStep `mandatory:"false" json:"userDefinedStep"`
}
func (m DrPlanStep) String() string
func (m *DrPlanStep) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DrPlanStep) 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
DrPlanStepErrorModeEnum Enum with underlying type: string
type DrPlanStepErrorModeEnum string
Set of constants representing the allowable values for DrPlanStepErrorModeEnum
const (
DrPlanStepErrorModeStopOnError DrPlanStepErrorModeEnum = "STOP_ON_ERROR"
DrPlanStepErrorModeContinueOnError DrPlanStepErrorModeEnum = "CONTINUE_ON_ERROR"
)
func GetDrPlanStepErrorModeEnumValues() []DrPlanStepErrorModeEnum
GetDrPlanStepErrorModeEnumValues Enumerates the set of values for DrPlanStepErrorModeEnum
func GetMappingDrPlanStepErrorModeEnum(val string) (DrPlanStepErrorModeEnum, bool)
GetMappingDrPlanStepErrorModeEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanStepExecution The details of a step execution in a DR plan execution.
type DrPlanStepExecution struct {
// The unique id of the step. Must not be modified by user.
// Example: `sgid1.step..uniqueID`
StepId *string `mandatory:"true" json:"stepId"`
// The step type.
Type DrPlanStepTypeEnum `mandatory:"true" json:"type"`
// The unique id of the group to which this step belongs. Must not be modified by user.
// Example: `sgid1.group..uniqueID`
GroupId *string `mandatory:"true" json:"groupId"`
// The display name of the step execution.
// Example: `DATABASE_SWITCHOVER`
DisplayName *string `mandatory:"true" json:"displayName"`
LogLocation *ObjectStorageLogLocation `mandatory:"true" json:"logLocation"`
// The status of the step execution.
Status DrPlanStepExecutionStatusEnum `mandatory:"true" json:"status"`
// Additional details on the step execution status.
// Example: `This step failed to complete due to a timeout`
StatusDetails *string `mandatory:"false" json:"statusDetails"`
// The time when step execution began. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The time when execution ended. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// The total duration in seconds taken to complete the step execution.
// Example: `35`
ExecutionDurationInSec *int `mandatory:"false" json:"executionDurationInSec"`
}
func (m DrPlanStepExecution) String() string
func (m DrPlanStepExecution) 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
DrPlanStepExecutionStatusEnum Enum with underlying type: string
type DrPlanStepExecutionStatusEnum string
Set of constants representing the allowable values for DrPlanStepExecutionStatusEnum
const (
DrPlanStepExecutionStatusQueued DrPlanStepExecutionStatusEnum = "QUEUED"
DrPlanStepExecutionStatusDisabled DrPlanStepExecutionStatusEnum = "DISABLED"
DrPlanStepExecutionStatusInProgress DrPlanStepExecutionStatusEnum = "IN_PROGRESS"
DrPlanStepExecutionStatusSucceeded DrPlanStepExecutionStatusEnum = "SUCCEEDED"
DrPlanStepExecutionStatusFailed DrPlanStepExecutionStatusEnum = "FAILED"
DrPlanStepExecutionStatusFailedIgnored DrPlanStepExecutionStatusEnum = "FAILED_IGNORED"
DrPlanStepExecutionStatusTimedOut DrPlanStepExecutionStatusEnum = "TIMED_OUT"
DrPlanStepExecutionStatusTimedOutIgnored DrPlanStepExecutionStatusEnum = "TIMED_OUT_IGNORED"
DrPlanStepExecutionStatusPaused DrPlanStepExecutionStatusEnum = "PAUSED"
DrPlanStepExecutionStatusCanceled DrPlanStepExecutionStatusEnum = "CANCELED"
)
func GetDrPlanStepExecutionStatusEnumValues() []DrPlanStepExecutionStatusEnum
GetDrPlanStepExecutionStatusEnumValues Enumerates the set of values for DrPlanStepExecutionStatusEnum
func GetMappingDrPlanStepExecutionStatusEnum(val string) (DrPlanStepExecutionStatusEnum, bool)
GetMappingDrPlanStepExecutionStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanStepRefreshStatusEnum Enum with underlying type: string
type DrPlanStepRefreshStatusEnum string
Set of constants representing the allowable values for DrPlanStepRefreshStatusEnum
const (
DrPlanStepRefreshStatusStepAdded DrPlanStepRefreshStatusEnum = "STEP_ADDED"
DrPlanStepRefreshStatusStepDeleted DrPlanStepRefreshStatusEnum = "STEP_DELETED"
)
func GetDrPlanStepRefreshStatusEnumValues() []DrPlanStepRefreshStatusEnum
GetDrPlanStepRefreshStatusEnumValues Enumerates the set of values for DrPlanStepRefreshStatusEnum
func GetMappingDrPlanStepRefreshStatusEnum(val string) (DrPlanStepRefreshStatusEnum, bool)
GetMappingDrPlanStepRefreshStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanStepTypeEnum Enum with underlying type: string
type DrPlanStepTypeEnum string
Set of constants representing the allowable values for DrPlanStepTypeEnum
const (
DrPlanStepTypeComputeInstanceStopPrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_STOP_PRECHECK"
DrPlanStepTypeComputeInstanceLaunchPrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_LAUNCH_PRECHECK"
DrPlanStepTypeComputeInstanceTerminatePrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_TERMINATE_PRECHECK"
DrPlanStepTypeComputeInstanceRemovePrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_REMOVE_PRECHECK"
DrPlanStepTypeVolumeGroupRestoreSwitchoverPrecheck DrPlanStepTypeEnum = "VOLUME_GROUP_RESTORE_SWITCHOVER_PRECHECK"
DrPlanStepTypeVolumeGroupRestoreFailoverPrecheck DrPlanStepTypeEnum = "VOLUME_GROUP_RESTORE_FAILOVER_PRECHECK"
DrPlanStepTypeDatabaseSwitchoverPrecheck DrPlanStepTypeEnum = "DATABASE_SWITCHOVER_PRECHECK"
DrPlanStepTypeDatabaseFailoverPrecheck DrPlanStepTypeEnum = "DATABASE_FAILOVER_PRECHECK"
DrPlanStepTypeAutonomousDatabaseSwitchoverPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_SWITCHOVER_PRECHECK"
DrPlanStepTypeAutonomousDatabaseFailoverPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_FAILOVER_PRECHECK"
DrPlanStepTypeAutonomousContainerDatabaseSwitchoverPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE_SWITCHOVER_PRECHECK"
DrPlanStepTypeAutonomousContainerDatabaseFailoverPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE_FAILOVER_PRECHECK"
DrPlanStepTypeAutonomousContainerDatabaseStartDrillConvertToSnapshotStandbyPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY_PRECHECK"
DrPlanStepTypeAutonomousContainerDatabaseStopDrillConvertToPhysicalStandbyPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY_PRECHECK"
DrPlanStepTypeAutonomousContainerDatabaseSwitchover DrPlanStepTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE_SWITCHOVER"
DrPlanStepTypeAutonomousContainerDatabaseFailover DrPlanStepTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE_FAILOVER"
DrPlanStepTypeAutonomousContainerDatabaseStartDrillConvertToSnapshotStandby DrPlanStepTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY"
DrPlanStepTypeAutonomousContainerDatabaseStopDrillConvertToPhysicalStandby DrPlanStepTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY"
DrPlanStepTypeAutonomousDatabaseStartDrillCreateCloneStandbyPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_START_DRILL_CREATE_CLONE_STANDBY_PRECHECK"
DrPlanStepTypeAutonomousDatabaseStopDrillDeleteCloneStandbyPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_STOP_DRILL_DELETE_CLONE_STANDBY_PRECHECK"
DrPlanStepTypeAutonomousDatabaseStartDrillConvertToSnapshotStandbyPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY_PRECHECK"
DrPlanStepTypeAutonomousDatabaseStopDrillConvertToPhysicalStandbyPrecheck DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY_PRECHECK"
DrPlanStepTypeAutonomousDatabaseStartDrillCreateCloneStandby DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_START_DRILL_CREATE_CLONE_STANDBY"
DrPlanStepTypeAutonomousDatabaseStopDrillDeleteCloneStandby DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_STOP_DRILL_DELETE_CLONE_STANDBY"
DrPlanStepTypeAutonomousDatabaseStartDrillConvertToSnapshotStandby DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_START_DRILL_CONVERT_TO_SNAPSHOT_STANDBY"
DrPlanStepTypeAutonomousDatabaseStopDrillConvertToPhysicalStandby DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_STOP_DRILL_CONVERT_TO_PHYSICAL_STANDBY"
DrPlanStepTypeUserDefinedPrecheck DrPlanStepTypeEnum = "USER_DEFINED_PRECHECK"
DrPlanStepTypeComputeInstanceLaunch DrPlanStepTypeEnum = "COMPUTE_INSTANCE_LAUNCH"
DrPlanStepTypeComputeInstanceStop DrPlanStepTypeEnum = "COMPUTE_INSTANCE_STOP"
DrPlanStepTypeComputeInstanceTerminate DrPlanStepTypeEnum = "COMPUTE_INSTANCE_TERMINATE"
DrPlanStepTypeComputeInstanceRemove DrPlanStepTypeEnum = "COMPUTE_INSTANCE_REMOVE"
DrPlanStepTypeDatabaseSwitchover DrPlanStepTypeEnum = "DATABASE_SWITCHOVER"
DrPlanStepTypeDatabaseFailover DrPlanStepTypeEnum = "DATABASE_FAILOVER"
DrPlanStepTypeAutonomousDatabaseSwitchover DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_SWITCHOVER"
DrPlanStepTypeAutonomousDatabaseFailover DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_FAILOVER"
DrPlanStepTypeVolumeGroupRestoreSwitchover DrPlanStepTypeEnum = "VOLUME_GROUP_RESTORE_SWITCHOVER"
DrPlanStepTypeVolumeGroupRestoreFailover DrPlanStepTypeEnum = "VOLUME_GROUP_RESTORE_FAILOVER"
DrPlanStepTypeVolumeGroupReverse DrPlanStepTypeEnum = "VOLUME_GROUP_REVERSE"
DrPlanStepTypeVolumeGroupDelete DrPlanStepTypeEnum = "VOLUME_GROUP_DELETE"
DrPlanStepTypeVolumeGroupRemove DrPlanStepTypeEnum = "VOLUME_GROUP_REMOVE"
DrPlanStepTypeVolumeGroupTerminate DrPlanStepTypeEnum = "VOLUME_GROUP_TERMINATE"
DrPlanStepTypeUserDefined DrPlanStepTypeEnum = "USER_DEFINED"
DrPlanStepTypeVolumeGroupRestoreStartDrillPrecheck DrPlanStepTypeEnum = "VOLUME_GROUP_RESTORE_START_DRILL_PRECHECK"
DrPlanStepTypeVolumeGroupRemovePrecheck DrPlanStepTypeEnum = "VOLUME_GROUP_REMOVE_PRECHECK"
DrPlanStepTypeVolumeGroupTerminatePrecheck DrPlanStepTypeEnum = "VOLUME_GROUP_TERMINATE_PRECHECK"
DrPlanStepTypeVolumeGroupRestoreStartDrill DrPlanStepTypeEnum = "VOLUME_GROUP_RESTORE_START_DRILL"
DrPlanStepTypeAutonomousDatabaseCreateClonePrecheck DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_CREATE_CLONE_PRECHECK"
DrPlanStepTypeAutonomousDatabaseDeleteClonePrecheck DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_DELETE_CLONE_PRECHECK"
DrPlanStepTypeLoadBalancerUpdatePrimaryBackendSetPrecheck DrPlanStepTypeEnum = "LOAD_BALANCER_UPDATE_PRIMARY_BACKEND_SET_PRECHECK"
DrPlanStepTypeLoadBalancerUpdateStandbyBackendSetPrecheck DrPlanStepTypeEnum = "LOAD_BALANCER_UPDATE_STANDBY_BACKEND_SET_PRECHECK"
DrPlanStepTypeFileSystemSwitchoverPrecheck DrPlanStepTypeEnum = "FILE_SYSTEM_SWITCHOVER_PRECHECK"
DrPlanStepTypeFileSystemFailoverPrecheck DrPlanStepTypeEnum = "FILE_SYSTEM_FAILOVER_PRECHECK"
DrPlanStepTypeFileSystemStartDrillPrecheck DrPlanStepTypeEnum = "FILE_SYSTEM_START_DRILL_PRECHECK"
DrPlanStepTypeFileSystemStopDrillPrecheck DrPlanStepTypeEnum = "FILE_SYSTEM_STOP_DRILL_PRECHECK"
DrPlanStepTypeFileSystemRemovePrecheck DrPlanStepTypeEnum = "FILE_SYSTEM_REMOVE_PRECHECK"
DrPlanStepTypeFileSystemTerminatePrecheck DrPlanStepTypeEnum = "FILE_SYSTEM_TERMINATE_PRECHECK"
DrPlanStepTypeFileSystemMountPrecheck DrPlanStepTypeEnum = "FILE_SYSTEM_MOUNT_PRECHECK"
DrPlanStepTypeFileSystemUnmountPrecheck DrPlanStepTypeEnum = "FILE_SYSTEM_UNMOUNT_PRECHECK"
DrPlanStepTypeComputeInstanceStartPrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_START_PRECHECK"
DrPlanStepTypeComputeInstanceAttachBlockVolumesPrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_ATTACH_BLOCK_VOLUMES_PRECHECK"
DrPlanStepTypeComputeInstanceDetachBlockVolumesPrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_DETACH_BLOCK_VOLUMES_PRECHECK"
DrPlanStepTypeComputeInstanceMountBlockVolumesPrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_MOUNT_BLOCK_VOLUMES_PRECHECK"
DrPlanStepTypeComputeInstanceUnmountBlockVolumesPrecheck DrPlanStepTypeEnum = "COMPUTE_INSTANCE_UNMOUNT_BLOCK_VOLUMES_PRECHECK"
DrPlanStepTypeComputeCapacityReservationStartDrillPrecheck DrPlanStepTypeEnum = "COMPUTE_CAPACITY_RESERVATION_START_DRILL_PRECHECK"
DrPlanStepTypeComputeCapacityAvailabilityStartDrillPrecheck DrPlanStepTypeEnum = "COMPUTE_CAPACITY_AVAILABILITY_START_DRILL_PRECHECK"
DrPlanStepTypeAutonomousDatabaseCreateClone DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_CREATE_CLONE"
DrPlanStepTypeAutonomousDatabaseDeleteClone DrPlanStepTypeEnum = "AUTONOMOUS_DATABASE_DELETE_CLONE"
DrPlanStepTypeLoadBalancerUpdatePrimaryBackendSet DrPlanStepTypeEnum = "LOAD_BALANCER_UPDATE_PRIMARY_BACKEND_SET"
DrPlanStepTypeLoadBalancerUpdateStandbyBackendSet DrPlanStepTypeEnum = "LOAD_BALANCER_UPDATE_STANDBY_BACKEND_SET"
DrPlanStepTypeFileSystemSwitchover DrPlanStepTypeEnum = "FILE_SYSTEM_SWITCHOVER"
DrPlanStepTypeFileSystemFailover DrPlanStepTypeEnum = "FILE_SYSTEM_FAILOVER"
DrPlanStepTypeFileSystemRemove DrPlanStepTypeEnum = "FILE_SYSTEM_REMOVE"
DrPlanStepTypeFileSystemReverse DrPlanStepTypeEnum = "FILE_SYSTEM_REVERSE"
DrPlanStepTypeFileSystemTerminate DrPlanStepTypeEnum = "FILE_SYSTEM_TERMINATE"
DrPlanStepTypeFileSystemStartDrill DrPlanStepTypeEnum = "FILE_SYSTEM_START_DRILL"
DrPlanStepTypeFileSystemStopDrill DrPlanStepTypeEnum = "FILE_SYSTEM_STOP_DRILL"
DrPlanStepTypeComputeInstanceStart DrPlanStepTypeEnum = "COMPUTE_INSTANCE_START"
DrPlanStepTypeComputeInstanceAttachBlockVolumes DrPlanStepTypeEnum = "COMPUTE_INSTANCE_ATTACH_BLOCK_VOLUMES"
DrPlanStepTypeComputeInstanceDetachBlockVolumes DrPlanStepTypeEnum = "COMPUTE_INSTANCE_DETACH_BLOCK_VOLUMES"
DrPlanStepTypeFileSystemMount DrPlanStepTypeEnum = "FILE_SYSTEM_MOUNT"
DrPlanStepTypeFileSystemUnmount DrPlanStepTypeEnum = "FILE_SYSTEM_UNMOUNT"
DrPlanStepTypeComputeCapacityReservationSwitchoverPrecheck DrPlanStepTypeEnum = "COMPUTE_CAPACITY_RESERVATION_SWITCHOVER_PRECHECK"
DrPlanStepTypeComputeCapacityReservationFailoverPrecheck DrPlanStepTypeEnum = "COMPUTE_CAPACITY_RESERVATION_FAILOVER_PRECHECK"
DrPlanStepTypeComputeCapacityAvailabilitySwitchoverPrecheck DrPlanStepTypeEnum = "COMPUTE_CAPACITY_AVAILABILITY_SWITCHOVER_PRECHECK"
DrPlanStepTypeComputeCapacityAvailabilityFailoverPrecheck DrPlanStepTypeEnum = "COMPUTE_CAPACITY_AVAILABILITY_FAILOVER_PRECHECK"
DrPlanStepTypeOkeClusterSwitchoverCleanupPrimaryPrecheck DrPlanStepTypeEnum = "OKE_CLUSTER_SWITCHOVER_CLEANUP_PRIMARY_PRECHECK"
DrPlanStepTypeOkeClusterSwitchoverRestoreStandbyPrecheck DrPlanStepTypeEnum = "OKE_CLUSTER_SWITCHOVER_RESTORE_STANDBY_PRECHECK"
DrPlanStepTypeOkeClusterFailoverRestoreStandbyPrecheck DrPlanStepTypeEnum = "OKE_CLUSTER_FAILOVER_RESTORE_STANDBY_PRECHECK"
DrPlanStepTypeOkeClusterStopDrillCleanupStandbyPrecheck DrPlanStepTypeEnum = "OKE_CLUSTER_STOP_DRILL_CLEANUP_STANDBY_PRECHECK"
DrPlanStepTypeOkeClusterStartDrillRestoreStandbyPrecheck DrPlanStepTypeEnum = "OKE_CLUSTER_START_DRILL_RESTORE_STANDBY_PRECHECK"
DrPlanStepTypeOkeClusterSwitchoverCleanupPrimary DrPlanStepTypeEnum = "OKE_CLUSTER_SWITCHOVER_CLEANUP_PRIMARY"
DrPlanStepTypeOkeClusterSwitchoverScaleUpStandby DrPlanStepTypeEnum = "OKE_CLUSTER_SWITCHOVER_SCALE_UP_STANDBY"
DrPlanStepTypeOkeClusterSwitchoverRestoreStandby DrPlanStepTypeEnum = "OKE_CLUSTER_SWITCHOVER_RESTORE_STANDBY"
DrPlanStepTypeOkeClusterSwitchoverReverseBackupStandby DrPlanStepTypeEnum = "OKE_CLUSTER_SWITCHOVER_REVERSE_BACKUP_STANDBY"
DrPlanStepTypeOkeClusterSwitchoverScaleDownPrimary DrPlanStepTypeEnum = "OKE_CLUSTER_SWITCHOVER_SCALE_DOWN_PRIMARY"
DrPlanStepTypeOkeClusterFailoverRestoreStandby DrPlanStepTypeEnum = "OKE_CLUSTER_FAILOVER_RESTORE_STANDBY"
DrPlanStepTypeOkeClusterFailoverScaleUpStandby DrPlanStepTypeEnum = "OKE_CLUSTER_FAILOVER_SCALE_UP_STANDBY"
DrPlanStepTypeOkeClusterStartDrillRestoreStandby DrPlanStepTypeEnum = "OKE_CLUSTER_START_DRILL_RESTORE_STANDBY"
DrPlanStepTypeOkeClusterStartDrillScaleUpStandby DrPlanStepTypeEnum = "OKE_CLUSTER_START_DRILL_SCALE_UP_STANDBY"
DrPlanStepTypeOkeClusterStopDrillCleanupStandby DrPlanStepTypeEnum = "OKE_CLUSTER_STOP_DRILL_CLEANUP_STANDBY"
DrPlanStepTypeOkeClusterStopDrillScaleDownStandby DrPlanStepTypeEnum = "OKE_CLUSTER_STOP_DRILL_SCALE_DOWN_STANDBY"
DrPlanStepTypeObjectStorageBucketSwitchoverDeleteReplicationPrimaryPrecheck DrPlanStepTypeEnum = "OBJECT_STORAGE_BUCKET_SWITCHOVER_DELETE_REPLICATION_PRIMARY_PRECHECK"
DrPlanStepTypeObjectStorageBucketSwitchoverSetupReverseReplicationStandbyPrecheck DrPlanStepTypeEnum = "OBJECT_STORAGE_BUCKET_SWITCHOVER_SETUP_REVERSE_REPLICATION_STANDBY_PRECHECK"
DrPlanStepTypeObjectStorageBucketFailoverDeleteReplicationStandbyPrecheck DrPlanStepTypeEnum = "OBJECT_STORAGE_BUCKET_FAILOVER_DELETE_REPLICATION_STANDBY_PRECHECK"
DrPlanStepTypeObjectStorageBucketFailoverSetupReverseReplicationStandbyPrecheck DrPlanStepTypeEnum = "OBJECT_STORAGE_BUCKET_FAILOVER_SETUP_REVERSE_REPLICATION_STANDBY_PRECHECK"
DrPlanStepTypeObjectStorageBucketSwitchoverDeleteReplicationPrimary DrPlanStepTypeEnum = "OBJECT_STORAGE_BUCKET_SWITCHOVER_DELETE_REPLICATION_PRIMARY"
DrPlanStepTypeObjectStorageBucketSwitchoverSetupReverseReplicationStandby DrPlanStepTypeEnum = "OBJECT_STORAGE_BUCKET_SWITCHOVER_SETUP_REVERSE_REPLICATION_STANDBY"
DrPlanStepTypeObjectStorageBucketFailoverDeleteReplicationStandby DrPlanStepTypeEnum = "OBJECT_STORAGE_BUCKET_FAILOVER_DELETE_REPLICATION_STANDBY"
DrPlanStepTypeObjectStorageBucketFailoverSetupReverseReplicationStandby DrPlanStepTypeEnum = "OBJECT_STORAGE_BUCKET_FAILOVER_SETUP_REVERSE_REPLICATION_STANDBY"
)
func GetDrPlanStepTypeEnumValues() []DrPlanStepTypeEnum
GetDrPlanStepTypeEnumValues Enumerates the set of values for DrPlanStepTypeEnum
func GetMappingDrPlanStepTypeEnum(val string) (DrPlanStepTypeEnum, bool)
GetMappingDrPlanStepTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanSummary The summary of a DR plan.
type DrPlanSummary struct {
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing the DR plan.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the DR plan.
// Example: `EBS Switchover PHX to IAD`
DisplayName *string `mandatory:"true" json:"displayName"`
// The type of the DR plan.
// Example: `SWITCHOVER`
Type DrPlanTypeEnum `mandatory:"true" json:"type"`
// The OCID of the DR protection group to which this DR plan belongs.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" json:"drProtectionGroupId"`
// The OCID of the peer DR protection group associated with this plan's
// DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
PeerDrProtectionGroupId *string `mandatory:"true" json:"peerDrProtectionGroupId"`
// The region of the peer DR protection group associated with this plan's
// DR protection group.
// Example: `us-ashburn-1`
PeerRegion *string `mandatory:"true" json:"peerRegion"`
// The date and time the DR plan was created. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the DR plan was updated. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the DR plan.
// Example: `ACTIVE`
LifecycleState DrPlanLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The current sub state of the DR plan.
// Example: `NEEDS_REFRESH`
LifecycleSubState DrPlanLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// A message describing the DR plan's current state in more detail.
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: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
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"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DrPlanSummary) String() string
func (m DrPlanSummary) 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
DrPlanTypeEnum Enum with underlying type: string
type DrPlanTypeEnum string
Set of constants representing the allowable values for DrPlanTypeEnum
const (
DrPlanTypeSwitchover DrPlanTypeEnum = "SWITCHOVER"
DrPlanTypeFailover DrPlanTypeEnum = "FAILOVER"
DrPlanTypeStartDrill DrPlanTypeEnum = "START_DRILL"
DrPlanTypeStopDrill DrPlanTypeEnum = "STOP_DRILL"
)
func GetDrPlanTypeEnumValues() []DrPlanTypeEnum
GetDrPlanTypeEnumValues Enumerates the set of values for DrPlanTypeEnum
func GetMappingDrPlanTypeEnum(val string) (DrPlanTypeEnum, bool)
GetMappingDrPlanTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrPlanUserDefinedStep The details for a user-defined step in a DR plan.
type DrPlanUserDefinedStep interface {
}
DrPlanUserDefinedStepStepTypeEnum Enum with underlying type: string
type DrPlanUserDefinedStepStepTypeEnum string
Set of constants representing the allowable values for DrPlanUserDefinedStepStepTypeEnum
const (
DrPlanUserDefinedStepStepTypeRunObjectstoreScriptPrecheck DrPlanUserDefinedStepStepTypeEnum = "RUN_OBJECTSTORE_SCRIPT_PRECHECK"
DrPlanUserDefinedStepStepTypeRunLocalScriptPrecheck DrPlanUserDefinedStepStepTypeEnum = "RUN_LOCAL_SCRIPT_PRECHECK"
DrPlanUserDefinedStepStepTypeInvokeFunctionPrecheck DrPlanUserDefinedStepStepTypeEnum = "INVOKE_FUNCTION_PRECHECK"
DrPlanUserDefinedStepStepTypeRunObjectstoreScript DrPlanUserDefinedStepStepTypeEnum = "RUN_OBJECTSTORE_SCRIPT"
DrPlanUserDefinedStepStepTypeRunLocalScript DrPlanUserDefinedStepStepTypeEnum = "RUN_LOCAL_SCRIPT"
DrPlanUserDefinedStepStepTypeInvokeFunction DrPlanUserDefinedStepStepTypeEnum = "INVOKE_FUNCTION"
)
func GetDrPlanUserDefinedStepStepTypeEnumValues() []DrPlanUserDefinedStepStepTypeEnum
GetDrPlanUserDefinedStepStepTypeEnumValues Enumerates the set of values for DrPlanUserDefinedStepStepTypeEnum
func GetMappingDrPlanUserDefinedStepStepTypeEnum(val string) (DrPlanUserDefinedStepStepTypeEnum, bool)
GetMappingDrPlanUserDefinedStepStepTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrProtectionGroup The details of a DR protection group.
type DrProtectionGroup struct {
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing the DR protection group.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the DR protection group.
// Example: `EBS PHX Group`
DisplayName *string `mandatory:"true" json:"displayName"`
// The role of the DR protection group.
Role DrProtectionGroupRoleEnum `mandatory:"true" json:"role"`
// The date and time the DR protection group was created. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the DR protection group was updated. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the DR protection group.
LifecycleState DrProtectionGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the peer DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
PeerId *string `mandatory:"false" json:"peerId"`
// The region of the peer DR protection group.
// Example: `us-ashburn-1`
PeerRegion *string `mandatory:"false" json:"peerRegion"`
LogLocation *ObjectStorageLogLocation `mandatory:"false" json:"logLocation"`
// A list of DR protection group members.
Members []DrProtectionGroupMember `mandatory:"false" json:"members"`
// A message describing the DR protection group's current state in more detail.
LifeCycleDetails *string `mandatory:"false" json:"lifeCycleDetails"`
// The current sub-state of the DR protection group.
LifecycleSubState DrProtectionGroupLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
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"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DrProtectionGroup) String() string
func (m *DrProtectionGroup) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DrProtectionGroup) 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
DrProtectionGroupCollection A list of DR protection group summaries.
type DrProtectionGroupCollection struct {
// A list of DR protection group summaries.
Items []DrProtectionGroupSummary `mandatory:"true" json:"items"`
}
func (m DrProtectionGroupCollection) String() string
func (m DrProtectionGroupCollection) 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
DrProtectionGroupLifecycleStateEnum Enum with underlying type: string
type DrProtectionGroupLifecycleStateEnum string
Set of constants representing the allowable values for DrProtectionGroupLifecycleStateEnum
const (
DrProtectionGroupLifecycleStateCreating DrProtectionGroupLifecycleStateEnum = "CREATING"
DrProtectionGroupLifecycleStateActive DrProtectionGroupLifecycleStateEnum = "ACTIVE"
DrProtectionGroupLifecycleStateUpdating DrProtectionGroupLifecycleStateEnum = "UPDATING"
DrProtectionGroupLifecycleStateInactive DrProtectionGroupLifecycleStateEnum = "INACTIVE"
DrProtectionGroupLifecycleStateNeedsAttention DrProtectionGroupLifecycleStateEnum = "NEEDS_ATTENTION"
DrProtectionGroupLifecycleStateDeleting DrProtectionGroupLifecycleStateEnum = "DELETING"
DrProtectionGroupLifecycleStateDeleted DrProtectionGroupLifecycleStateEnum = "DELETED"
DrProtectionGroupLifecycleStateFailed DrProtectionGroupLifecycleStateEnum = "FAILED"
)
func GetDrProtectionGroupLifecycleStateEnumValues() []DrProtectionGroupLifecycleStateEnum
GetDrProtectionGroupLifecycleStateEnumValues Enumerates the set of values for DrProtectionGroupLifecycleStateEnum
func GetMappingDrProtectionGroupLifecycleStateEnum(val string) (DrProtectionGroupLifecycleStateEnum, bool)
GetMappingDrProtectionGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrProtectionGroupLifecycleSubStateEnum Enum with underlying type: string
type DrProtectionGroupLifecycleSubStateEnum string
Set of constants representing the allowable values for DrProtectionGroupLifecycleSubStateEnum
const (
DrProtectionGroupLifecycleSubStateDrDrillInProgress DrProtectionGroupLifecycleSubStateEnum = "DR_DRILL_IN_PROGRESS"
)
func GetDrProtectionGroupLifecycleSubStateEnumValues() []DrProtectionGroupLifecycleSubStateEnum
GetDrProtectionGroupLifecycleSubStateEnumValues Enumerates the set of values for DrProtectionGroupLifecycleSubStateEnum
func GetMappingDrProtectionGroupLifecycleSubStateEnum(val string) (DrProtectionGroupLifecycleSubStateEnum, bool)
GetMappingDrProtectionGroupLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrProtectionGroupMember The properties of a member in a DR protection group.
type DrProtectionGroupMember interface {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
GetMemberId() *string
}
DrProtectionGroupMemberAutonomousContainerDatabase The properties for an Autonomous Container Database member of a DR protection group.
type DrProtectionGroupMemberAutonomousContainerDatabase struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The type of connection strings used to connect to an Autonomous Container Database snapshot standby created during a DR Drill operation.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html for information about these service types.
ConnectionStringType AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum `mandatory:"false" json:"connectionStringType,omitempty"`
}
func (m DrProtectionGroupMemberAutonomousContainerDatabase) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberAutonomousContainerDatabase) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberAutonomousContainerDatabase) String() string
func (m DrProtectionGroupMemberAutonomousContainerDatabase) 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
DrProtectionGroupMemberAutonomousDatabase The properties for an Autonomous Database Serverless member of a DR protection group.
type DrProtectionGroupMemberAutonomousDatabase struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the vault secret where the database SYSDBA password is stored.
// This password is required and used for performing database DR Drill operations when using full clone.
// Example: `ocid1.vaultsecret.oc1..uniqueID`
PasswordVaultSecretId *string `mandatory:"false" json:"passwordVaultSecretId"`
// This specifies the mechanism used to create a temporary Autonomous Database instance for DR Drills.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-clone-about.html for information about these clone types.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-data-guard-snapshot-standby.html for information about snapshot standby.
AutonomousDatabaseStandbyTypeForDrDrills AutonomousDatabaseStandbyTypeForDrDrillsEnum `mandatory:"false" json:"autonomousDatabaseStandbyTypeForDrDrills,omitempty"`
}
func (m DrProtectionGroupMemberAutonomousDatabase) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberAutonomousDatabase) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberAutonomousDatabase) String() string
func (m DrProtectionGroupMemberAutonomousDatabase) 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
DrProtectionGroupMemberComputeInstance Deprecated. Properties for a compute instance member of a DR protection group.
type DrProtectionGroupMemberComputeInstance struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating if the compute instance should be moved during DR operations.
// Example: `false`
IsMovable *bool `mandatory:"false" json:"isMovable"`
// A list of compute instance VNIC mappings.
VnicMapping []ComputeInstanceVnicMapping `mandatory:"false" json:"vnicMapping"`
// The OCID of a compartment in the destination region in which the compute instance
// should be launched.
// Example: `ocid1.compartment.oc1..uniqueID`
DestinationCompartmentId *string `mandatory:"false" json:"destinationCompartmentId"`
// The OCID of a dedicated VM host in the destination region where the compute instance
// should be launched.
// Example: `ocid1.dedicatedvmhost.oc1..uniqueID`
DestinationDedicatedVmHostId *string `mandatory:"false" json:"destinationDedicatedVmHostId"`
}
func (m DrProtectionGroupMemberComputeInstance) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberComputeInstance) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberComputeInstance) String() string
func (m DrProtectionGroupMemberComputeInstance) 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
DrProtectionGroupMemberComputeInstanceMovable Properties for a movable compute instance member of a DR protection group.
type DrProtectionGroupMemberComputeInstanceMovable struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating if the compute instance should be moved to the same fault domain in the destination region.
// The compute instance launch will fail if this flag is set to true and capacity is not available in the
// specified fault domain in the destination region.
// Example: `false`
IsRetainFaultDomain *bool `mandatory:"false" json:"isRetainFaultDomain"`
// The OCID of a capacity reservation in the destination region which will be used to launch
// the compute instance.
// Example: `ocid1.capacityreservation.oc1..uniqueID`
DestinationCapacityReservationId *string `mandatory:"false" json:"destinationCapacityReservationId"`
// A list of compute instance VNIC mappings.
VnicMappings []ComputeInstanceMovableVnicMapping `mandatory:"false" json:"vnicMappings"`
// The OCID of a compartment in the destination region in which the compute instance
// should be launched.
// Example: `ocid1.compartment.oc1..uniqueID`
DestinationCompartmentId *string `mandatory:"false" json:"destinationCompartmentId"`
// The OCID of a dedicated VM host in the destination region where the compute instance
// should be launched.
// Example: `ocid1.dedicatedvmhost.oc1..uniqueID`
DestinationDedicatedVmHostId *string `mandatory:"false" json:"destinationDedicatedVmHostId"`
// A list of details of operations performed on file systems.
FileSystemOperations []ComputeInstanceMovableFileSystemOperation `mandatory:"false" json:"fileSystemOperations"`
}
func (m DrProtectionGroupMemberComputeInstanceMovable) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberComputeInstanceMovable) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberComputeInstanceMovable) String() string
func (m DrProtectionGroupMemberComputeInstanceMovable) 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
DrProtectionGroupMemberComputeInstanceNonMovable Properties for a non-movable compute instance member of a DR protection group.
type DrProtectionGroupMemberComputeInstanceNonMovable struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating whether the non-movable compute instance needs to be started and stopped during DR operations.
IsStartStopEnabled *bool `mandatory:"false" json:"isStartStopEnabled"`
// Operations performed on a list of file systems used on the non-movable compute instance.
FileSystemOperations []ComputeInstanceNonMovableFileSystemOperation `mandatory:"false" json:"fileSystemOperations"`
// Operations performed on a list of block volumes used on the non-movable compute instance.
BlockVolumeOperations []ComputeInstanceNonMovableBlockVolumeOperation `mandatory:"false" json:"blockVolumeOperations"`
}
func (m DrProtectionGroupMemberComputeInstanceNonMovable) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberComputeInstanceNonMovable) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberComputeInstanceNonMovable) String() string
func (m DrProtectionGroupMemberComputeInstanceNonMovable) 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
DrProtectionGroupMemberDatabase The properties for a Base Database or Exadata Database member of a DR protection group.
type DrProtectionGroupMemberDatabase struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the vault secret where the database SYSDBA password is stored.
// This password is used for performing database DR operations.
// Example: `ocid1.vaultsecret.oc1..uniqueID`
PasswordVaultSecretId *string `mandatory:"false" json:"passwordVaultSecretId"`
}
func (m DrProtectionGroupMemberDatabase) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberDatabase) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberDatabase) String() string
func (m DrProtectionGroupMemberDatabase) 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
DrProtectionGroupMemberFileSystem The properties for a file system member of a DR protection group.
type DrProtectionGroupMemberFileSystem struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The availability domain of the destination mount target.
//
// Example: `BBTh:region-AD`
DestinationAvailabilityDomain *string `mandatory:"false" json:"destinationAvailabilityDomain"`
// A list of mappings between the primary region file system export and destination region mount target.
ExportMappings []FileSystemExportMapping `mandatory:"false" json:"exportMappings"`
}
func (m DrProtectionGroupMemberFileSystem) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberFileSystem) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberFileSystem) String() string
func (m DrProtectionGroupMemberFileSystem) 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
DrProtectionGroupMemberLoadBalancer The properties for a load balancer member of a DR protection group.
type DrProtectionGroupMemberLoadBalancer struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the destination load balancer.
// The backend sets in this destination load balancer are updated during DR.
// Example: `ocid1.loadbalancer.oc1..uniqueID`
DestinationLoadBalancerId *string `mandatory:"false" json:"destinationLoadBalancerId"`
// A list of backend set mappings that are used to transfer or update backends during DR.
BackendSetMappings []LoadBalancerBackendSetMapping `mandatory:"false" json:"backendSetMappings"`
}
func (m DrProtectionGroupMemberLoadBalancer) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberLoadBalancer) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberLoadBalancer) String() string
func (m DrProtectionGroupMemberLoadBalancer) 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
DrProtectionGroupMemberNetworkLoadBalancer The properties for a network load balancer member of a DR protection group.
type DrProtectionGroupMemberNetworkLoadBalancer struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the destination network load balancer.
// The backend sets in this destination network load balancer are updated during DR.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
DestinationNetworkLoadBalancerId *string `mandatory:"false" json:"destinationNetworkLoadBalancerId"`
// A list of backend set mappings that are used to transfer or update backends during DR.
BackendSetMappings []NetworkLoadBalancerBackendSetMapping `mandatory:"false" json:"backendSetMappings"`
}
func (m DrProtectionGroupMemberNetworkLoadBalancer) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberNetworkLoadBalancer) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberNetworkLoadBalancer) String() string
func (m DrProtectionGroupMemberNetworkLoadBalancer) 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
DrProtectionGroupMemberObjectStorageBucket The properties for a object storage bucket member of a DR protection group.
type DrProtectionGroupMemberObjectStorageBucket struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The namespace in object storage (Note - this is usually the tenancy name).
// Example: `myocitenancy`
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The bucket name inside the object storage namespace.
// Example: `bucket_name`
BucketName *string `mandatory:"true" json:"bucketName"`
}
func (m DrProtectionGroupMemberObjectStorageBucket) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberObjectStorageBucket) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberObjectStorageBucket) String() string
func (m DrProtectionGroupMemberObjectStorageBucket) 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
DrProtectionGroupMemberOkeCluster Properties for a OKE Cluster member of a DR Protection Group.
type DrProtectionGroupMemberOkeCluster struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the peer OKE cluster.
// This property applies to the OKE cluster member in both the primary and standby region.
// Example: `ocid1.cluster.oc1.uniqueID`
PeerClusterId *string `mandatory:"false" json:"peerClusterId"`
// The OCID of the compute instance member that is designated as a jump host.
// This compute instance will be used to perform DR operations on the cluster using Oracle Cloud Agent's Run Command feature.
// Example: `ocid1.instance.oc1..uniqueID`
JumpHostId *string `mandatory:"false" json:"jumpHostId"`
BackupLocation *OkeBackupLocation `mandatory:"false" json:"backupLocation"`
BackupConfig *OkeClusterBackupConfig `mandatory:"false" json:"backupConfig"`
// The list of source-to-destination load balancer mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
LoadBalancerMappings []OkeClusterLoadBalancerMapping `mandatory:"false" json:"loadBalancerMappings"`
// The list of source-to-destination network load balancer mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
NetworkLoadBalancerMappings []OkeClusterNetworkLoadBalancerMapping `mandatory:"false" json:"networkLoadBalancerMappings"`
// The list of source-to-destination vault mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
VaultMappings []OkeClusterVaultMapping `mandatory:"false" json:"vaultMappings"`
// The list of node pools with configurations for minimum and maximum node counts.
// This property applies to the OKE cluster member in both the primary and standby region.
ManagedNodePoolConfigs []OkeClusterManagedNodePoolConfiguration `mandatory:"false" json:"managedNodePoolConfigs"`
// The list of node pools with configurations for minimum and maximum node counts.
// This property applies to the OKE cluster member in both the primary and standby region.
VirtualNodePoolConfigs []OkeClusterVirtualNodePoolConfiguration `mandatory:"false" json:"virtualNodePoolConfigs"`
}
func (m DrProtectionGroupMemberOkeCluster) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberOkeCluster) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberOkeCluster) String() string
func (m DrProtectionGroupMemberOkeCluster) 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
DrProtectionGroupMemberTypeEnum Enum with underlying type: string
type DrProtectionGroupMemberTypeEnum string
Set of constants representing the allowable values for DrProtectionGroupMemberTypeEnum
const (
DrProtectionGroupMemberTypeComputeInstance DrProtectionGroupMemberTypeEnum = "COMPUTE_INSTANCE"
DrProtectionGroupMemberTypeComputeInstanceMovable DrProtectionGroupMemberTypeEnum = "COMPUTE_INSTANCE_MOVABLE"
DrProtectionGroupMemberTypeComputeInstanceNonMovable DrProtectionGroupMemberTypeEnum = "COMPUTE_INSTANCE_NON_MOVABLE"
DrProtectionGroupMemberTypeVolumeGroup DrProtectionGroupMemberTypeEnum = "VOLUME_GROUP"
DrProtectionGroupMemberTypeDatabase DrProtectionGroupMemberTypeEnum = "DATABASE"
DrProtectionGroupMemberTypeAutonomousDatabase DrProtectionGroupMemberTypeEnum = "AUTONOMOUS_DATABASE"
DrProtectionGroupMemberTypeAutonomousContainerDatabase DrProtectionGroupMemberTypeEnum = "AUTONOMOUS_CONTAINER_DATABASE"
DrProtectionGroupMemberTypeLoadBalancer DrProtectionGroupMemberTypeEnum = "LOAD_BALANCER"
DrProtectionGroupMemberTypeNetworkLoadBalancer DrProtectionGroupMemberTypeEnum = "NETWORK_LOAD_BALANCER"
DrProtectionGroupMemberTypeFileSystem DrProtectionGroupMemberTypeEnum = "FILE_SYSTEM"
DrProtectionGroupMemberTypeOkeCluster DrProtectionGroupMemberTypeEnum = "OKE_CLUSTER"
DrProtectionGroupMemberTypeObjectStorageBucket DrProtectionGroupMemberTypeEnum = "OBJECT_STORAGE_BUCKET"
)
func GetDrProtectionGroupMemberTypeEnumValues() []DrProtectionGroupMemberTypeEnum
GetDrProtectionGroupMemberTypeEnumValues Enumerates the set of values for DrProtectionGroupMemberTypeEnum
func GetMappingDrProtectionGroupMemberTypeEnum(val string) (DrProtectionGroupMemberTypeEnum, bool)
GetMappingDrProtectionGroupMemberTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrProtectionGroupMemberVolumeGroup The properties for a volume group member of a DR protection group.
type DrProtectionGroupMemberVolumeGroup struct {
// The OCID of the member.
// Example: `ocid1.instance.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
}
func (m DrProtectionGroupMemberVolumeGroup) GetMemberId() *string
GetMemberId returns MemberId
func (m DrProtectionGroupMemberVolumeGroup) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrProtectionGroupMemberVolumeGroup) String() string
func (m DrProtectionGroupMemberVolumeGroup) 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
DrProtectionGroupRoleEnum Enum with underlying type: string
type DrProtectionGroupRoleEnum string
Set of constants representing the allowable values for DrProtectionGroupRoleEnum
const (
DrProtectionGroupRolePrimary DrProtectionGroupRoleEnum = "PRIMARY"
DrProtectionGroupRoleStandby DrProtectionGroupRoleEnum = "STANDBY"
DrProtectionGroupRoleUnconfigured DrProtectionGroupRoleEnum = "UNCONFIGURED"
)
func GetDrProtectionGroupRoleEnumValues() []DrProtectionGroupRoleEnum
GetDrProtectionGroupRoleEnumValues Enumerates the set of values for DrProtectionGroupRoleEnum
func GetMappingDrProtectionGroupRoleEnum(val string) (DrProtectionGroupRoleEnum, bool)
GetMappingDrProtectionGroupRoleEnum performs case Insensitive comparison on enum value and return the desired enum
DrProtectionGroupSummary The summary of a DR protection group.
type DrProtectionGroupSummary struct {
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment containing the DR protection group.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the DR protection group.
// Example: `EBS PHX Group`
DisplayName *string `mandatory:"true" json:"displayName"`
// The role of the DR protection group.
Role DrProtectionGroupRoleEnum `mandatory:"true" json:"role"`
// The date and time the DR protection group was created. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the DR protection group was updated. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the DR protection group.
LifecycleState DrProtectionGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the peer DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
PeerId *string `mandatory:"false" json:"peerId"`
// The region of the peer DR protection group.
// Example: `us-ashburn-1`
PeerRegion *string `mandatory:"false" json:"peerRegion"`
// A message describing the DR protection group's current state in more detail.
LifeCycleDetails *string `mandatory:"false" json:"lifeCycleDetails"`
// The current sub-state of the DR protection group.
LifecycleSubState DrProtectionGroupLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
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"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DrProtectionGroupSummary) String() string
func (m DrProtectionGroupSummary) 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
FailoverExecutionOptionDetails Options for failover execution.
type FailoverExecutionOptionDetails struct {
// A flag indicating whether prechecks should be executed before the plan execution.
// Example: `true`
ArePrechecksEnabled *bool `mandatory:"false" json:"arePrechecksEnabled"`
// A flag indicating whether warnings should be ignored during the failover.
// Example: `false`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m FailoverExecutionOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FailoverExecutionOptionDetails) String() string
func (m FailoverExecutionOptionDetails) 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
FailoverExecutionOptions Options for failover execution.
type FailoverExecutionOptions struct {
// A flag indicating whether prechecks should be executed before the plan execution.
// Example: `true`
ArePrechecksEnabled *bool `mandatory:"false" json:"arePrechecksEnabled"`
// A flag indicating whether warnings should be ignored during the plan execution.
// Example: `false`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m FailoverExecutionOptions) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FailoverExecutionOptions) String() string
func (m FailoverExecutionOptions) 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
FailoverPrecheckExecutionOptionDetails Options for a failover precheck execution.
type FailoverPrecheckExecutionOptionDetails struct {
// A flag indicating whether warnings should be ignored during the failover precheck.
// Example: `false`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m FailoverPrecheckExecutionOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FailoverPrecheckExecutionOptionDetails) String() string
func (m FailoverPrecheckExecutionOptionDetails) 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
FailoverPrecheckExecutionOptions Options for failover precheck execution.
type FailoverPrecheckExecutionOptions struct {
// A flag indicating whether warnings should be ignored during the precheck.
// Example: `false`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m FailoverPrecheckExecutionOptions) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FailoverPrecheckExecutionOptions) String() string
func (m FailoverPrecheckExecutionOptions) 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
FileSystemExportMapping The mapping between a primary region file system export path and destination region mount target.
type FileSystemExportMapping struct {
// The OCID of the export path.
// Example: `ocid1.export.oc1..uniqueID`
ExportId *string `mandatory:"true" json:"exportId"`
// The OCID of the destination mount target on which this file system export should be created.
// Example: `ocid1.mounttarget.oc1..uniqueID`
DestinationMountTargetId *string `mandatory:"true" json:"destinationMountTargetId"`
}
func (m FileSystemExportMapping) String() string
func (m FileSystemExportMapping) 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
FileSystemExportMappingDetails The mapping between a file system export in the primary region and a mount target in the standby region.
type FileSystemExportMappingDetails struct {
// The OCID of the export path in the primary region used to mount or unmount the file system.
// Example: `ocid1.export.oc1..uniqueID`
ExportId *string `mandatory:"true" json:"exportId"`
// The OCID of the destination mount target in the destination region which is used to export the file system.
// Example: `ocid1.mounttarget.oc1..uniqueID`
DestinationMountTargetId *string `mandatory:"true" json:"destinationMountTargetId"`
}
func (m FileSystemExportMappingDetails) String() string
func (m FileSystemExportMappingDetails) 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
FileSystemMountDetails Mount details of a file system.
type FileSystemMountDetails struct {
// The OCID of the mount target for this file system.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"true" json:"mountTargetId"`
}
func (m FileSystemMountDetails) String() string
func (m FileSystemMountDetails) 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
FileSystemUnmountDetails Unmount details for a file system.
type FileSystemUnmountDetails struct {
// The OCID of the mount target for this file system.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"true" json:"mountTargetId"`
}
func (m FileSystemUnmountDetails) String() string
func (m FileSystemUnmountDetails) 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
GetDrPlanExecutionRequest wrapper for the GetDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/GetDrPlanExecution.go.html to see an example of how to use GetDrPlanExecutionRequest.
type GetDrPlanExecutionRequest struct {
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"true" contributesTo:"path" name:"drPlanExecutionId"`
// The client request ID for tracing.
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 GetDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDrPlanExecutionRequest) String() string
func (request GetDrPlanExecutionRequest) 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
GetDrPlanExecutionResponse wrapper for the GetDrPlanExecution operation
type GetDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// The DrPlanExecution instance
DrPlanExecution `presentIn:"body"`
// For optimistic concurrency control. For more information, see ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
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 GetDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDrPlanExecutionResponse) String() string
GetDrPlanRequest wrapper for the GetDrPlan operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/GetDrPlan.go.html to see an example of how to use GetDrPlanRequest.
type GetDrPlanRequest struct {
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
DrPlanId *string `mandatory:"true" contributesTo:"path" name:"drPlanId"`
// The client request ID for tracing.
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 GetDrPlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDrPlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDrPlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDrPlanRequest) String() string
func (request GetDrPlanRequest) 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
GetDrPlanResponse wrapper for the GetDrPlan operation
type GetDrPlanResponse struct {
// The underlying http response
RawResponse *http.Response
// The DrPlan instance
DrPlan `presentIn:"body"`
// For optimistic concurrency control. For more information, see ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
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 GetDrPlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDrPlanResponse) String() string
GetDrProtectionGroupRequest wrapper for the GetDrProtectionGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/GetDrProtectionGroup.go.html to see an example of how to use GetDrProtectionGroupRequest.
type GetDrProtectionGroupRequest struct {
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"path" name:"drProtectionGroupId"`
// The client request ID for tracing.
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 GetDrProtectionGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDrProtectionGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDrProtectionGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDrProtectionGroupRequest) String() string
func (request GetDrProtectionGroupRequest) 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
GetDrProtectionGroupResponse wrapper for the GetDrProtectionGroup operation
type GetDrProtectionGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The DrProtectionGroup instance
DrProtectionGroup `presentIn:"body"`
// For optimistic concurrency control. For more information, see ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
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 GetDrProtectionGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDrProtectionGroupResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID (OCID) of the asynchronous request.
// Example: `ocid1.workrequest.oc1..uniqueID`
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
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"`
// For optimistic concurrency control. For more information, see ETags for Optimistic Concurrency Control (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
IgnoreDrPlanExecutionDetails The details for ignoring a failed group or step.
type IgnoreDrPlanExecutionDetails struct {
// The unique id of the group to ignore as a whole, or the group containing the step to ignore.
// Example: `sgid1.group..uniqueID`
GroupId *string `mandatory:"true" json:"groupId"`
// The unique id of the step to ignore (optional). Only needed when ignoring a step.
// Example: `sgid1.step..uniqueID`
StepId *string `mandatory:"false" json:"stepId"`
}
func (m IgnoreDrPlanExecutionDetails) String() string
func (m IgnoreDrPlanExecutionDetails) 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
IgnoreDrPlanExecutionRequest wrapper for the IgnoreDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/IgnoreDrPlanExecution.go.html to see an example of how to use IgnoreDrPlanExecutionRequest.
type IgnoreDrPlanExecutionRequest struct {
// Details for ignoring the failed group or step and resuming execution.
IgnoreDrPlanExecutionDetails `contributesTo:"body"`
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"true" contributesTo:"path" name:"drPlanExecutionId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 IgnoreDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request IgnoreDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request IgnoreDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request IgnoreDrPlanExecutionRequest) String() string
func (request IgnoreDrPlanExecutionRequest) 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
IgnoreDrPlanExecutionResponse wrapper for the IgnoreDrPlanExecution operation
type IgnoreDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 IgnoreDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response IgnoreDrPlanExecutionResponse) String() string
InvokeFunctionPrecheckStep Invoke Oracle function precheck step details.
type InvokeFunctionPrecheckStep struct {
}
func (m InvokeFunctionPrecheckStep) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InvokeFunctionPrecheckStep) String() string
func (m InvokeFunctionPrecheckStep) 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
InvokeFunctionStep Invoke Oracle function step details.
type InvokeFunctionStep struct {
// The OCID of function to be invoked.
// Example: `ocid1.fnfunc.oc1..uniqueID`
FunctionId *string `mandatory:"true" json:"functionId"`
// The region in which the function is deployed.
// Example: `us-ashburn-1`
FunctionRegion *string `mandatory:"true" json:"functionRegion"`
// The request body for the function.
// Example: `{ "FnParam1", "FnParam2" }`
RequestBody *string `mandatory:"false" json:"requestBody"`
}
func (m InvokeFunctionStep) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InvokeFunctionStep) String() string
func (m InvokeFunctionStep) 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
ListDrPlanExecutionsLifecycleStateEnum Enum with underlying type: string
type ListDrPlanExecutionsLifecycleStateEnum string
Set of constants representing the allowable values for ListDrPlanExecutionsLifecycleStateEnum
const (
ListDrPlanExecutionsLifecycleStateAccepted ListDrPlanExecutionsLifecycleStateEnum = "ACCEPTED"
ListDrPlanExecutionsLifecycleStateInProgress ListDrPlanExecutionsLifecycleStateEnum = "IN_PROGRESS"
ListDrPlanExecutionsLifecycleStateWaiting ListDrPlanExecutionsLifecycleStateEnum = "WAITING"
ListDrPlanExecutionsLifecycleStateCanceling ListDrPlanExecutionsLifecycleStateEnum = "CANCELING"
ListDrPlanExecutionsLifecycleStateCanceled ListDrPlanExecutionsLifecycleStateEnum = "CANCELED"
ListDrPlanExecutionsLifecycleStateSucceeded ListDrPlanExecutionsLifecycleStateEnum = "SUCCEEDED"
ListDrPlanExecutionsLifecycleStateFailed ListDrPlanExecutionsLifecycleStateEnum = "FAILED"
ListDrPlanExecutionsLifecycleStateDeleting ListDrPlanExecutionsLifecycleStateEnum = "DELETING"
ListDrPlanExecutionsLifecycleStateDeleted ListDrPlanExecutionsLifecycleStateEnum = "DELETED"
ListDrPlanExecutionsLifecycleStatePausing ListDrPlanExecutionsLifecycleStateEnum = "PAUSING"
ListDrPlanExecutionsLifecycleStatePaused ListDrPlanExecutionsLifecycleStateEnum = "PAUSED"
ListDrPlanExecutionsLifecycleStateResuming ListDrPlanExecutionsLifecycleStateEnum = "RESUMING"
)
func GetListDrPlanExecutionsLifecycleStateEnumValues() []ListDrPlanExecutionsLifecycleStateEnum
GetListDrPlanExecutionsLifecycleStateEnumValues Enumerates the set of values for ListDrPlanExecutionsLifecycleStateEnum
func GetMappingListDrPlanExecutionsLifecycleStateEnum(val string) (ListDrPlanExecutionsLifecycleStateEnum, bool)
GetMappingListDrPlanExecutionsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrPlanExecutionsRequest wrapper for the ListDrPlanExecutions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListDrPlanExecutions.go.html to see an example of how to use ListDrPlanExecutionsRequest.
type ListDrPlanExecutionsRequest struct {
// The OCID of the DR protection group. Mandatory query param.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"query" name:"drProtectionGroupId"`
// A filter to return only DR plan executions that match the given lifecycle state.
LifecycleState ListDrPlanExecutionsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"false" contributesTo:"query" name:"drPlanExecutionId"`
// A filter to return only resources that match the given display name.
// Example: `MyResourceDisplayName`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `100`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDrPlanExecutionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.
// Default order for displayName is ascending. If no value is specified timeCreated is default.
// Example: `MyResourceDisplayName`
SortBy ListDrPlanExecutionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
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 ListDrPlanExecutionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDrPlanExecutionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDrPlanExecutionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDrPlanExecutionsRequest) String() string
func (request ListDrPlanExecutionsRequest) 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
ListDrPlanExecutionsResponse wrapper for the ListDrPlanExecutions operation
type ListDrPlanExecutionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DrPlanExecutionCollection instances
DrPlanExecutionCollection `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 ListDrPlanExecutionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDrPlanExecutionsResponse) String() string
ListDrPlanExecutionsSortByEnum Enum with underlying type: string
type ListDrPlanExecutionsSortByEnum string
Set of constants representing the allowable values for ListDrPlanExecutionsSortByEnum
const (
ListDrPlanExecutionsSortByTimecreated ListDrPlanExecutionsSortByEnum = "timeCreated"
ListDrPlanExecutionsSortByDisplayname ListDrPlanExecutionsSortByEnum = "displayName"
)
func GetListDrPlanExecutionsSortByEnumValues() []ListDrPlanExecutionsSortByEnum
GetListDrPlanExecutionsSortByEnumValues Enumerates the set of values for ListDrPlanExecutionsSortByEnum
func GetMappingListDrPlanExecutionsSortByEnum(val string) (ListDrPlanExecutionsSortByEnum, bool)
GetMappingListDrPlanExecutionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrPlanExecutionsSortOrderEnum Enum with underlying type: string
type ListDrPlanExecutionsSortOrderEnum string
Set of constants representing the allowable values for ListDrPlanExecutionsSortOrderEnum
const (
ListDrPlanExecutionsSortOrderAsc ListDrPlanExecutionsSortOrderEnum = "ASC"
ListDrPlanExecutionsSortOrderDesc ListDrPlanExecutionsSortOrderEnum = "DESC"
)
func GetListDrPlanExecutionsSortOrderEnumValues() []ListDrPlanExecutionsSortOrderEnum
GetListDrPlanExecutionsSortOrderEnumValues Enumerates the set of values for ListDrPlanExecutionsSortOrderEnum
func GetMappingListDrPlanExecutionsSortOrderEnum(val string) (ListDrPlanExecutionsSortOrderEnum, bool)
GetMappingListDrPlanExecutionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrPlansDrPlanTypeEnum Enum with underlying type: string
type ListDrPlansDrPlanTypeEnum string
Set of constants representing the allowable values for ListDrPlansDrPlanTypeEnum
const (
ListDrPlansDrPlanTypeSwitchover ListDrPlansDrPlanTypeEnum = "SWITCHOVER"
ListDrPlansDrPlanTypeFailover ListDrPlansDrPlanTypeEnum = "FAILOVER"
ListDrPlansDrPlanTypeStartDrill ListDrPlansDrPlanTypeEnum = "START_DRILL"
ListDrPlansDrPlanTypeStopDrill ListDrPlansDrPlanTypeEnum = "STOP_DRILL"
)
func GetListDrPlansDrPlanTypeEnumValues() []ListDrPlansDrPlanTypeEnum
GetListDrPlansDrPlanTypeEnumValues Enumerates the set of values for ListDrPlansDrPlanTypeEnum
func GetMappingListDrPlansDrPlanTypeEnum(val string) (ListDrPlansDrPlanTypeEnum, bool)
GetMappingListDrPlansDrPlanTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrPlansLifecycleStateEnum Enum with underlying type: string
type ListDrPlansLifecycleStateEnum string
Set of constants representing the allowable values for ListDrPlansLifecycleStateEnum
const (
ListDrPlansLifecycleStateCreating ListDrPlansLifecycleStateEnum = "CREATING"
ListDrPlansLifecycleStateUpdating ListDrPlansLifecycleStateEnum = "UPDATING"
ListDrPlansLifecycleStateActive ListDrPlansLifecycleStateEnum = "ACTIVE"
ListDrPlansLifecycleStateInactive ListDrPlansLifecycleStateEnum = "INACTIVE"
ListDrPlansLifecycleStateDeleting ListDrPlansLifecycleStateEnum = "DELETING"
ListDrPlansLifecycleStateDeleted ListDrPlansLifecycleStateEnum = "DELETED"
ListDrPlansLifecycleStateFailed ListDrPlansLifecycleStateEnum = "FAILED"
ListDrPlansLifecycleStateNeedsAttention ListDrPlansLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetListDrPlansLifecycleStateEnumValues() []ListDrPlansLifecycleStateEnum
GetListDrPlansLifecycleStateEnumValues Enumerates the set of values for ListDrPlansLifecycleStateEnum
func GetMappingListDrPlansLifecycleStateEnum(val string) (ListDrPlansLifecycleStateEnum, bool)
GetMappingListDrPlansLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrPlansLifecycleSubStateEnum Enum with underlying type: string
type ListDrPlansLifecycleSubStateEnum string
Set of constants representing the allowable values for ListDrPlansLifecycleSubStateEnum
const (
ListDrPlansLifecycleSubStateNeedsRefresh ListDrPlansLifecycleSubStateEnum = "NEEDS_REFRESH"
ListDrPlansLifecycleSubStateNeedsVerification ListDrPlansLifecycleSubStateEnum = "NEEDS_VERIFICATION"
ListDrPlansLifecycleSubStateRefreshing ListDrPlansLifecycleSubStateEnum = "REFRESHING"
ListDrPlansLifecycleSubStateVerifying ListDrPlansLifecycleSubStateEnum = "VERIFYING"
)
func GetListDrPlansLifecycleSubStateEnumValues() []ListDrPlansLifecycleSubStateEnum
GetListDrPlansLifecycleSubStateEnumValues Enumerates the set of values for ListDrPlansLifecycleSubStateEnum
func GetMappingListDrPlansLifecycleSubStateEnum(val string) (ListDrPlansLifecycleSubStateEnum, bool)
GetMappingListDrPlansLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrPlansRequest wrapper for the ListDrPlans operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListDrPlans.go.html to see an example of how to use ListDrPlansRequest.
type ListDrPlansRequest struct {
// The OCID of the DR protection group. Mandatory query param.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"query" name:"drProtectionGroupId"`
// A filter to return only DR plans that match the given lifecycle state.
LifecycleState ListDrPlansLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
DrPlanId *string `mandatory:"false" contributesTo:"query" name:"drPlanId"`
// The DR plan type.
DrPlanType ListDrPlansDrPlanTypeEnum `mandatory:"false" contributesTo:"query" name:"drPlanType" omitEmpty:"true"`
// A filter to return only resources that match the given display name.
// Example: `MyResourceDisplayName`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `100`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDrPlansSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.
// Default order for displayName is ascending. If no value is specified timeCreated is default.
// Example: `MyResourceDisplayName`
SortBy ListDrPlansSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only DR plans that match the given lifecycle sub-state.
LifecycleSubState ListDrPlansLifecycleSubStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleSubState" 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 ListDrPlansRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDrPlansRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDrPlansRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDrPlansRequest) String() string
func (request ListDrPlansRequest) 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
ListDrPlansResponse wrapper for the ListDrPlans operation
type ListDrPlansResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DrPlanCollection instances
DrPlanCollection `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 ListDrPlansResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDrPlansResponse) String() string
ListDrPlansSortByEnum Enum with underlying type: string
type ListDrPlansSortByEnum string
Set of constants representing the allowable values for ListDrPlansSortByEnum
const (
ListDrPlansSortByTimecreated ListDrPlansSortByEnum = "timeCreated"
ListDrPlansSortByDisplayname ListDrPlansSortByEnum = "displayName"
)
func GetListDrPlansSortByEnumValues() []ListDrPlansSortByEnum
GetListDrPlansSortByEnumValues Enumerates the set of values for ListDrPlansSortByEnum
func GetMappingListDrPlansSortByEnum(val string) (ListDrPlansSortByEnum, bool)
GetMappingListDrPlansSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrPlansSortOrderEnum Enum with underlying type: string
type ListDrPlansSortOrderEnum string
Set of constants representing the allowable values for ListDrPlansSortOrderEnum
const (
ListDrPlansSortOrderAsc ListDrPlansSortOrderEnum = "ASC"
ListDrPlansSortOrderDesc ListDrPlansSortOrderEnum = "DESC"
)
func GetListDrPlansSortOrderEnumValues() []ListDrPlansSortOrderEnum
GetListDrPlansSortOrderEnumValues Enumerates the set of values for ListDrPlansSortOrderEnum
func GetMappingListDrPlansSortOrderEnum(val string) (ListDrPlansSortOrderEnum, bool)
GetMappingListDrPlansSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrProtectionGroupsLifecycleStateEnum Enum with underlying type: string
type ListDrProtectionGroupsLifecycleStateEnum string
Set of constants representing the allowable values for ListDrProtectionGroupsLifecycleStateEnum
const (
ListDrProtectionGroupsLifecycleStateCreating ListDrProtectionGroupsLifecycleStateEnum = "CREATING"
ListDrProtectionGroupsLifecycleStateActive ListDrProtectionGroupsLifecycleStateEnum = "ACTIVE"
ListDrProtectionGroupsLifecycleStateUpdating ListDrProtectionGroupsLifecycleStateEnum = "UPDATING"
ListDrProtectionGroupsLifecycleStateInactive ListDrProtectionGroupsLifecycleStateEnum = "INACTIVE"
ListDrProtectionGroupsLifecycleStateNeedsAttention ListDrProtectionGroupsLifecycleStateEnum = "NEEDS_ATTENTION"
ListDrProtectionGroupsLifecycleStateDeleting ListDrProtectionGroupsLifecycleStateEnum = "DELETING"
ListDrProtectionGroupsLifecycleStateDeleted ListDrProtectionGroupsLifecycleStateEnum = "DELETED"
ListDrProtectionGroupsLifecycleStateFailed ListDrProtectionGroupsLifecycleStateEnum = "FAILED"
)
func GetListDrProtectionGroupsLifecycleStateEnumValues() []ListDrProtectionGroupsLifecycleStateEnum
GetListDrProtectionGroupsLifecycleStateEnumValues Enumerates the set of values for ListDrProtectionGroupsLifecycleStateEnum
func GetMappingListDrProtectionGroupsLifecycleStateEnum(val string) (ListDrProtectionGroupsLifecycleStateEnum, bool)
GetMappingListDrProtectionGroupsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrProtectionGroupsLifecycleSubStateEnum Enum with underlying type: string
type ListDrProtectionGroupsLifecycleSubStateEnum string
Set of constants representing the allowable values for ListDrProtectionGroupsLifecycleSubStateEnum
const (
ListDrProtectionGroupsLifecycleSubStateDrDrillInProgress ListDrProtectionGroupsLifecycleSubStateEnum = "DR_DRILL_IN_PROGRESS"
)
func GetListDrProtectionGroupsLifecycleSubStateEnumValues() []ListDrProtectionGroupsLifecycleSubStateEnum
GetListDrProtectionGroupsLifecycleSubStateEnumValues Enumerates the set of values for ListDrProtectionGroupsLifecycleSubStateEnum
func GetMappingListDrProtectionGroupsLifecycleSubStateEnum(val string) (ListDrProtectionGroupsLifecycleSubStateEnum, bool)
GetMappingListDrProtectionGroupsLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrProtectionGroupsRequest wrapper for the ListDrProtectionGroups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ListDrProtectionGroups.go.html to see an example of how to use ListDrProtectionGroupsRequest.
type ListDrProtectionGroupsRequest struct {
// The ID (OCID) of the compartment in which to list resources.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only DR protection groups that match the given lifecycle state.
LifecycleState ListDrProtectionGroupsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The OCID of the DR protection group. Optional query param.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"false" contributesTo:"query" name:"drProtectionGroupId"`
// A filter to return only resources that match the given display name.
// Example: `MyResourceDisplayName`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `100`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDrProtectionGroupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.
// Default order for displayName is ascending. If no value is specified timeCreated is default.
// Example: `MyResourceDisplayName`
SortBy ListDrProtectionGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The DR protection group Role.
Role ListDrProtectionGroupsRoleEnum `mandatory:"false" contributesTo:"query" name:"role" omitEmpty:"true"`
// A filter to return only DR protection groups that match the given lifecycle sub-state.
LifecycleSubState ListDrProtectionGroupsLifecycleSubStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleSubState" 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 ListDrProtectionGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDrProtectionGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDrProtectionGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDrProtectionGroupsRequest) String() string
func (request ListDrProtectionGroupsRequest) 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
ListDrProtectionGroupsResponse wrapper for the ListDrProtectionGroups operation
type ListDrProtectionGroupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DrProtectionGroupCollection instances
DrProtectionGroupCollection `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 ListDrProtectionGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDrProtectionGroupsResponse) String() string
ListDrProtectionGroupsRoleEnum Enum with underlying type: string
type ListDrProtectionGroupsRoleEnum string
Set of constants representing the allowable values for ListDrProtectionGroupsRoleEnum
const (
ListDrProtectionGroupsRolePrimary ListDrProtectionGroupsRoleEnum = "PRIMARY"
ListDrProtectionGroupsRoleStandby ListDrProtectionGroupsRoleEnum = "STANDBY"
ListDrProtectionGroupsRoleUnconfigured ListDrProtectionGroupsRoleEnum = "UNCONFIGURED"
)
func GetListDrProtectionGroupsRoleEnumValues() []ListDrProtectionGroupsRoleEnum
GetListDrProtectionGroupsRoleEnumValues Enumerates the set of values for ListDrProtectionGroupsRoleEnum
func GetMappingListDrProtectionGroupsRoleEnum(val string) (ListDrProtectionGroupsRoleEnum, bool)
GetMappingListDrProtectionGroupsRoleEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrProtectionGroupsSortByEnum Enum with underlying type: string
type ListDrProtectionGroupsSortByEnum string
Set of constants representing the allowable values for ListDrProtectionGroupsSortByEnum
const (
ListDrProtectionGroupsSortByTimecreated ListDrProtectionGroupsSortByEnum = "timeCreated"
ListDrProtectionGroupsSortByDisplayname ListDrProtectionGroupsSortByEnum = "displayName"
)
func GetListDrProtectionGroupsSortByEnumValues() []ListDrProtectionGroupsSortByEnum
GetListDrProtectionGroupsSortByEnumValues Enumerates the set of values for ListDrProtectionGroupsSortByEnum
func GetMappingListDrProtectionGroupsSortByEnum(val string) (ListDrProtectionGroupsSortByEnum, bool)
GetMappingListDrProtectionGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDrProtectionGroupsSortOrderEnum Enum with underlying type: string
type ListDrProtectionGroupsSortOrderEnum string
Set of constants representing the allowable values for ListDrProtectionGroupsSortOrderEnum
const (
ListDrProtectionGroupsSortOrderAsc ListDrProtectionGroupsSortOrderEnum = "ASC"
ListDrProtectionGroupsSortOrderDesc ListDrProtectionGroupsSortOrderEnum = "DESC"
)
func GetListDrProtectionGroupsSortOrderEnumValues() []ListDrProtectionGroupsSortOrderEnum
GetListDrProtectionGroupsSortOrderEnumValues Enumerates the set of values for ListDrProtectionGroupsSortOrderEnum
func GetMappingListDrProtectionGroupsSortOrderEnum(val string) (ListDrProtectionGroupsSortOrderEnum, bool)
GetMappingListDrProtectionGroupsSortOrderEnum 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/disasterrecovery/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID (OCID) of the asynchronous request.
// Example: `ocid1.workrequest.oc1..uniqueID`
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `100`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided.
// Default order for timeAccepted is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or '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 (
ListWorkRequestErrorsSortByTimeaccepted ListWorkRequestErrorsSortByEnum = "timeAccepted"
)
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/disasterrecovery/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID (OCID) of the asynchronous request.
// Example: `ocid1.workrequest.oc1..uniqueID`
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `100`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided.
// Default order for timeAccepted is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or '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 (
ListWorkRequestLogsSortByTimeaccepted ListWorkRequestLogsSortByEnum = "timeAccepted"
)
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/disasterrecovery/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID (OCID) of the compartment in which to list resources.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The ID (OCID) of the asynchronous work request.
// Example: `ocid1.workrequest.oc1..uniqueID`
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only resources whose lifecycleState matches the given OperationStatus.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID (OCID) of the resource affected by the work request.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response
// header from the previous "List" call.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page,
// or items to return in a paginated "List" call.
// 1 is the minimum, 1000 is the maximum.
// For important details about how pagination works,
// see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `100`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or '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"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
)
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
LoadBalancerBackendSetMapping A backend set mapping between source and destination load balancer.
type LoadBalancerBackendSetMapping struct {
// This flag specifies if this backend set is used for traffic for non-movable compute instances.
// Backend sets that point to non-movable instances are only enabled or disabled during DR. For non-movable instances this flag should be set to 'true'.
// Backend sets that point to movable instances are emptied and their contents are transferred to the destination region load balancer. For movable instances this flag should be set to 'false'.
// Example: `true`
IsBackendSetForNonMovable *bool `mandatory:"true" json:"isBackendSetForNonMovable"`
// The name of the source backend set.
// Example: `My_Source_Backend_Set`
SourceBackendSetName *string `mandatory:"true" json:"sourceBackendSetName"`
// The name of the destination backend set.
// Example: `My_Destination_Backend_Set`
DestinationBackendSetName *string `mandatory:"true" json:"destinationBackendSetName"`
}
func (m LoadBalancerBackendSetMapping) String() string
func (m LoadBalancerBackendSetMapping) 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
LoadBalancerBackendSetMappingDetails Create backend set mapping properties for a load balancer member.
type LoadBalancerBackendSetMappingDetails struct {
// This flag specifies if this backend set is used for traffic for non-movable compute instances.
// Backend sets that point to non-movable instances are only enabled or disabled during DR, their contents
// are not altered. For non-movable instances this flag should be set to 'true'.
// Backend sets that point to movable instances are emptied and their contents are transferred to the
// destination region load balancer. For movable instances this flag should be set to 'false'.
// Example: `true`
IsBackendSetForNonMovable *bool `mandatory:"true" json:"isBackendSetForNonMovable"`
// The name of the source backend set.
// Example: `Source-BackendSet-1`
SourceBackendSetName *string `mandatory:"true" json:"sourceBackendSetName"`
// The name of the destination backend set.
// Example: `Destination-BackendSet-1`
DestinationBackendSetName *string `mandatory:"true" json:"destinationBackendSetName"`
}
func (m LoadBalancerBackendSetMappingDetails) String() string
func (m LoadBalancerBackendSetMappingDetails) 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
LocalScriptPrecheckStep Run local script precheck step details.
type LocalScriptPrecheckStep struct {
}
func (m LocalScriptPrecheckStep) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LocalScriptPrecheckStep) String() string
func (m LocalScriptPrecheckStep) 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
NetworkLoadBalancerBackendSetMapping A backend set mapping between source and destination network load balancer.
type NetworkLoadBalancerBackendSetMapping struct {
// This flag specifies if this backend set is used for traffic for non-movable compute instances.
// Backend sets that point to non-movable instances are only enabled or disabled during DR. For non-movable instances this flag should be set to 'true'.
// Backend sets that point to movable instances are emptied and their contents are transferred to the destination region network load balancer. For movable instances this flag should be set to 'false'.
// Example: `true`
IsBackendSetForNonMovable *bool `mandatory:"true" json:"isBackendSetForNonMovable"`
// The name of the source backend set.
// Example: `example_backend_set`
SourceBackendSetName *string `mandatory:"true" json:"sourceBackendSetName"`
// The name of the destination backend set.
// Example: `example_backend_set`
DestinationBackendSetName *string `mandatory:"true" json:"destinationBackendSetName"`
}
func (m NetworkLoadBalancerBackendSetMapping) String() string
func (m NetworkLoadBalancerBackendSetMapping) 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
NetworkLoadBalancerBackendSetMappingDetails Create backend set mapping properties for a network load balancer member.
type NetworkLoadBalancerBackendSetMappingDetails struct {
// This flag specifies if this backend set is used for traffic for non-movable compute instances.
// Backend sets that point to non-movable instances are only enabled or disabled during DR, their contents
// are not altered. For non-movable instances this flag should be set to 'true'.
// Backend sets that point to movable instances are emptied and their contents are transferred to the
// destination region load balancer. For movable instances this flag should be set to 'false'.
// Example: `true`
IsBackendSetForNonMovable *bool `mandatory:"true" json:"isBackendSetForNonMovable"`
// The name of the source backend set.
// Example: `Source-BackendSet-1`
SourceBackendSetName *string `mandatory:"true" json:"sourceBackendSetName"`
// The name of the destination backend set.
// Example: `Destination-BackendSet-1`
DestinationBackendSetName *string `mandatory:"true" json:"destinationBackendSetName"`
}
func (m NetworkLoadBalancerBackendSetMappingDetails) String() string
func (m NetworkLoadBalancerBackendSetMappingDetails) 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
ObjectStorageLogLocation The details of an object storage log location for a DR protection group.
type ObjectStorageLogLocation struct {
// The namespace in object storage (Note - this is usually the tenancy name).
// Example: `myocitenancy`
Namespace *string `mandatory:"true" json:"namespace"`
// The bucket name inside the object storage namespace.
// Example: `operation_logs`
Bucket *string `mandatory:"true" json:"bucket"`
// The object name inside the object storage bucket.
// Example: `switchover_plan_executions`
Object *string `mandatory:"false" json:"object"`
}
func (m ObjectStorageLogLocation) String() string
func (m ObjectStorageLogLocation) 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
ObjectStorageScriptLocation The details of an object storage script location for a user-defined step in a DR plan.
type ObjectStorageScriptLocation struct {
// The namespace in object storage (Note - this is usually the tenancy name).
// Example: `myocitenancy`
Namespace *string `mandatory:"true" json:"namespace"`
// The bucket name inside the object storage namespace.
// Example: `custom_dr_scripts`
Bucket *string `mandatory:"true" json:"bucket"`
// The object name inside the object storage bucket.
// Example: `validate_app_start.sh`
Object *string `mandatory:"true" json:"object"`
}
func (m ObjectStorageScriptLocation) String() string
func (m ObjectStorageScriptLocation) 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
ObjectStoreScriptPrecheckStep Run object store script precheck step details.
type ObjectStoreScriptPrecheckStep struct {
}
func (m ObjectStoreScriptPrecheckStep) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStoreScriptPrecheckStep) String() string
func (m ObjectStoreScriptPrecheckStep) 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
OkeBackupLocation The details for object storage backup location of an OKE Cluster
type OkeBackupLocation struct {
// The namespace in object storage backup location(Note - this is usually the tenancy name).
// Example: `myocitenancy`
Namespace *string `mandatory:"true" json:"namespace"`
// The bucket name inside the object storage namespace.
// Example: `operation_logs`
Bucket *string `mandatory:"true" json:"bucket"`
// The object name inside the object storage bucket.
// Example: `switchover_plan_executions`
Object *string `mandatory:"false" json:"object"`
}
func (m OkeBackupLocation) String() string
func (m OkeBackupLocation) 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
OkeClusterBackupConfig The details of backup performed on OKE Cluster.
type OkeClusterBackupConfig struct {
// A list of namespaces that need to be backed up.
// The default value is null. If a list of namespaces is not provided, all namespaces will be backed up.
// This property applies to the OKE cluster member in primary region.
// Example: ["default", "pv-nginx"]
Namespaces []string `mandatory:"false" json:"namespaces"`
// The schedule for backing up namespaces to the destination region. If a backup schedule is not specified, only a single backup will be created. This format of the string specifying the backup schedule must conform with RFC-5545.
// This schedule will use the UTC timezone.
// This property applies to the OKE cluster member in primary region.
// Example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
BackupSchedule *string `mandatory:"false" json:"backupSchedule"`
// Controls the behaviour of image replication across regions.
// This property applies to the OKE cluster member in primary region.
ReplicateImages OkeClusterImageReplicationEnum `mandatory:"false" json:"replicateImages,omitempty"`
// The maximum number of backups that should be retained.
// This property applies to the OKE cluster member in primary region.
MaxNumberOfBackupsRetained *int `mandatory:"false" json:"maxNumberOfBackupsRetained"`
// The OCID of the vault secret that stores the image credential.
// This property applies to the OKE cluster member in both the primary and standby region.
ImageReplicationVaultSecretId *string `mandatory:"false" json:"imageReplicationVaultSecretId"`
}
func (m OkeClusterBackupConfig) String() string
func (m OkeClusterBackupConfig) 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
OkeClusterImageReplicationEnum Enum with underlying type: string
type OkeClusterImageReplicationEnum string
Set of constants representing the allowable values for OkeClusterImageReplicationEnum
const (
OkeClusterImageReplicationEnable OkeClusterImageReplicationEnum = "ENABLE"
OkeClusterImageReplicationDisable OkeClusterImageReplicationEnum = "DISABLE"
)
func GetMappingOkeClusterImageReplicationEnum(val string) (OkeClusterImageReplicationEnum, bool)
GetMappingOkeClusterImageReplicationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOkeClusterImageReplicationEnumValues() []OkeClusterImageReplicationEnum
GetOkeClusterImageReplicationEnumValues Enumerates the set of values for OkeClusterImageReplicationEnum
OkeClusterLoadBalancerMapping Source-to-destination mapping for a load balancer.
type OkeClusterLoadBalancerMapping struct {
// The OCID of the source Load Balancer.
// Example: `ocid1.loadbalancer.oc1..uniqueID`
SourceLoadBalancerId *string `mandatory:"true" json:"sourceLoadBalancerId"`
// The OCID of the destination Load Balancer.
// Example: `ocid1.loadbalancer.oc1..uniqueID`
DestinationLoadBalancerId *string `mandatory:"true" json:"destinationLoadBalancerId"`
}
func (m OkeClusterLoadBalancerMapping) String() string
func (m OkeClusterLoadBalancerMapping) 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
OkeClusterManagedNodePoolConfiguration The managed node pool configuration properties for an OKE member.
type OkeClusterManagedNodePoolConfiguration struct {
// The OCID of the managed node pool in OKE cluster.
Id *string `mandatory:"true" json:"id"`
// The minimum number to which nodes in the managed node pool could be scaled down.
Minimum *int `mandatory:"false" json:"minimum"`
// The maximum number to which nodes in the managed node pool could be scaled up.
Maximum *int `mandatory:"false" json:"maximum"`
}
func (m OkeClusterManagedNodePoolConfiguration) String() string
func (m OkeClusterManagedNodePoolConfiguration) 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
OkeClusterNetworkLoadBalancerMapping Source-to-destination mapping for a network load balancer.
type OkeClusterNetworkLoadBalancerMapping struct {
// The OCID of the source Network Load Balancer.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
SourceNetworkLoadBalancerId *string `mandatory:"true" json:"sourceNetworkLoadBalancerId"`
// The OCID of the destination Network Load Balancer.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
DestinationNetworkLoadBalancerId *string `mandatory:"true" json:"destinationNetworkLoadBalancerId"`
}
func (m OkeClusterNetworkLoadBalancerMapping) String() string
func (m OkeClusterNetworkLoadBalancerMapping) 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
OkeClusterVaultMapping Source-to-destination mapping for a vault.
type OkeClusterVaultMapping struct {
// The OCID of the source Vault.
// Example: `ocid1.vault.oc1..uniqueID`
SourceVaultId *string `mandatory:"true" json:"sourceVaultId"`
// The OCID of the destination Vault.
// Example: `ocid1.vault.oc1..uniqueID`
DestinationVaultId *string `mandatory:"true" json:"destinationVaultId"`
}
func (m OkeClusterVaultMapping) String() string
func (m OkeClusterVaultMapping) 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
OkeClusterVirtualNodePoolConfiguration The virtual node pool configuration properties for an OKE member.
type OkeClusterVirtualNodePoolConfiguration struct {
// The OCID of the virtual node pool in OKE cluster.
Id *string `mandatory:"true" json:"id"`
// The minimum number to which nodes in the virtual node pool could be scaled down.
Minimum *int `mandatory:"false" json:"minimum"`
// The maximum number to which nodes in the virtual node pool could be scaled up.
Maximum *int `mandatory:"false" json:"maximum"`
}
func (m OkeClusterVirtualNodePoolConfiguration) String() string
func (m OkeClusterVirtualNodePoolConfiguration) 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"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
)
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 (
OperationTypeCreateDrProtectionGroup OperationTypeEnum = "CREATE_DR_PROTECTION_GROUP"
OperationTypeUpdateDrProtectionGroup OperationTypeEnum = "UPDATE_DR_PROTECTION_GROUP"
OperationTypeDeleteDrProtectionGroup OperationTypeEnum = "DELETE_DR_PROTECTION_GROUP"
OperationTypeMoveDrProtectionGroup OperationTypeEnum = "MOVE_DR_PROTECTION_GROUP"
OperationTypeAssociateDrProtectionGroup OperationTypeEnum = "ASSOCIATE_DR_PROTECTION_GROUP"
OperationTypeDisassociateDrProtectionGroup OperationTypeEnum = "DISASSOCIATE_DR_PROTECTION_GROUP"
OperationTypeUpdateRoleDrProtectionGroup OperationTypeEnum = "UPDATE_ROLE_DR_PROTECTION_GROUP"
OperationTypeCreateDrPlan OperationTypeEnum = "CREATE_DR_PLAN"
OperationTypeUpdateDrPlan OperationTypeEnum = "UPDATE_DR_PLAN"
OperationTypeDeleteDrPlan OperationTypeEnum = "DELETE_DR_PLAN"
OperationTypeRefreshDrPlan OperationTypeEnum = "REFRESH_DR_PLAN"
OperationTypeVerifyDrPlan OperationTypeEnum = "VERIFY_DR_PLAN"
OperationTypeCreateDrPlanExecution OperationTypeEnum = "CREATE_DR_PLAN_EXECUTION"
OperationTypeUpdateDrPlanExecution OperationTypeEnum = "UPDATE_DR_PLAN_EXECUTION"
OperationTypeDeleteDrPlanExecution OperationTypeEnum = "DELETE_DR_PLAN_EXECUTION"
OperationTypeRetryDrPlanExecution OperationTypeEnum = "RETRY_DR_PLAN_EXECUTION"
OperationTypeIgnoreDrPlanExecution OperationTypeEnum = "IGNORE_DR_PLAN_EXECUTION"
OperationTypeCancelDrPlanExecution OperationTypeEnum = "CANCEL_DR_PLAN_EXECUTION"
OperationTypePauseDrPlanExecution OperationTypeEnum = "PAUSE_DR_PLAN_EXECUTION"
OperationTypeResumeDrPlanExecution OperationTypeEnum = "RESUME_DR_PLAN_EXECUTION"
)
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
PauseDrPlanExecutionDetails The details for pausing a DR plan execution.
type PauseDrPlanExecutionDetails struct {
}
func (m PauseDrPlanExecutionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PauseDrPlanExecutionDetails) String() string
func (m PauseDrPlanExecutionDetails) 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
PauseDrPlanExecutionRequest wrapper for the PauseDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/PauseDrPlanExecution.go.html to see an example of how to use PauseDrPlanExecutionRequest.
type PauseDrPlanExecutionRequest struct {
// Details for pausing the DR plan execution.
PauseDrPlanExecutionDetails `contributesTo:"body"`
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"true" contributesTo:"path" name:"drPlanExecutionId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 PauseDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PauseDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PauseDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PauseDrPlanExecutionRequest) String() string
func (request PauseDrPlanExecutionRequest) 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
PauseDrPlanExecutionResponse wrapper for the PauseDrPlanExecution operation
type PauseDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 PauseDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PauseDrPlanExecutionResponse) String() string
RefreshDrPlanDefaultDetails The default type.
type RefreshDrPlanDefaultDetails struct {
}
func (m RefreshDrPlanDefaultDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RefreshDrPlanDefaultDetails) String() string
func (m RefreshDrPlanDefaultDetails) 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
RefreshDrPlanDetails The details for refreshing a DR plan.
type RefreshDrPlanDetails interface {
}
RefreshDrPlanDetailsTypeEnum Enum with underlying type: string
type RefreshDrPlanDetailsTypeEnum string
Set of constants representing the allowable values for RefreshDrPlanDetailsTypeEnum
const (
RefreshDrPlanDetailsTypeDefault RefreshDrPlanDetailsTypeEnum = "DEFAULT"
)
func GetMappingRefreshDrPlanDetailsTypeEnum(val string) (RefreshDrPlanDetailsTypeEnum, bool)
GetMappingRefreshDrPlanDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRefreshDrPlanDetailsTypeEnumValues() []RefreshDrPlanDetailsTypeEnum
GetRefreshDrPlanDetailsTypeEnumValues Enumerates the set of values for RefreshDrPlanDetailsTypeEnum
RefreshDrPlanRequest wrapper for the RefreshDrPlan operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/RefreshDrPlan.go.html to see an example of how to use RefreshDrPlanRequest.
type RefreshDrPlanRequest struct {
// Details for refreshing a DR plan.
RefreshDrPlanDetails `contributesTo:"body"`
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
DrPlanId *string `mandatory:"true" contributesTo:"path" name:"drPlanId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 RefreshDrPlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RefreshDrPlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RefreshDrPlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RefreshDrPlanRequest) String() string
func (request RefreshDrPlanRequest) 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
RefreshDrPlanResponse wrapper for the RefreshDrPlan operation
type RefreshDrPlanResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 RefreshDrPlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RefreshDrPlanResponse) String() string
ResumeDrPlanExecutionDetails The details for resuming a DR plan execution.
type ResumeDrPlanExecutionDetails struct {
}
func (m ResumeDrPlanExecutionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ResumeDrPlanExecutionDetails) String() string
func (m ResumeDrPlanExecutionDetails) 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
ResumeDrPlanExecutionRequest wrapper for the ResumeDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/ResumeDrPlanExecution.go.html to see an example of how to use ResumeDrPlanExecutionRequest.
type ResumeDrPlanExecutionRequest struct {
// Details for resuming the DR plan execution.
ResumeDrPlanExecutionDetails `contributesTo:"body"`
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"true" contributesTo:"path" name:"drPlanExecutionId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 ResumeDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ResumeDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResumeDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResumeDrPlanExecutionRequest) String() string
func (request ResumeDrPlanExecutionRequest) 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
ResumeDrPlanExecutionResponse wrapper for the ResumeDrPlanExecution operation
type ResumeDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 ResumeDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResumeDrPlanExecutionResponse) String() string
RetryDrPlanExecutionDetails The details for retrying a failed group or step.
type RetryDrPlanExecutionDetails struct {
// The unique id of the group to retry as a whole, or the group containing the step being retried.
// Example: `sgid1.group..uniqueID`
GroupId *string `mandatory:"true" json:"groupId"`
// The unique id of the step to retry (optional). Only needed when retrying a step.
// Example: `sgid1.step..uniqueID`
StepId *string `mandatory:"false" json:"stepId"`
}
func (m RetryDrPlanExecutionDetails) String() string
func (m RetryDrPlanExecutionDetails) 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
RetryDrPlanExecutionRequest wrapper for the RetryDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/RetryDrPlanExecution.go.html to see an example of how to use RetryDrPlanExecutionRequest.
type RetryDrPlanExecutionRequest struct {
// Details for retrying execution of the failed group or step.
RetryDrPlanExecutionDetails `contributesTo:"body"`
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"true" contributesTo:"path" name:"drPlanExecutionId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 RetryDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetryDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetryDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetryDrPlanExecutionRequest) String() string
func (request RetryDrPlanExecutionRequest) 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
RetryDrPlanExecutionResponse wrapper for the RetryDrPlanExecution operation
type RetryDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 RetryDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetryDrPlanExecutionResponse) String() string
RunLocalScriptUserDefinedStep Run Local Script step details.
type RunLocalScriptUserDefinedStep struct {
// The OCID of the instance on which this script or command should be executed.
// **For moving instances:** *runOnInstanceId* must be the OCID of the instance in the region where the
// instance is currently present.
// **For non-moving instances:** *runOnInstanceId* must be the OCID of the non-moving instance.
// Example: `ocid1.instance.oc1..uniqueID`
RunOnInstanceId *string `mandatory:"true" json:"runOnInstanceId"`
// The region in which the instance is present.
// Example: `us-ashburn-1`
RunOnInstanceRegion *string `mandatory:"true" json:"runOnInstanceRegion"`
// The script name and arguments.
// Example: `/usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3`
ScriptCommand *string `mandatory:"true" json:"scriptCommand"`
// The userid on the instance to be used for executing the script or command.
// Example: `opc`
RunAsUser *string `mandatory:"false" json:"runAsUser"`
}
func (m RunLocalScriptUserDefinedStep) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RunLocalScriptUserDefinedStep) String() string
func (m RunLocalScriptUserDefinedStep) 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
RunObjectStoreScriptUserDefinedStep Run Object Store Script step details.
type RunObjectStoreScriptUserDefinedStep struct {
// The OCID of the instance on which this script or command should be executed.
// **For moving instances:** *runOnInstanceId* must be the OCID of the instance in the region where the
// instance is currently present.
// **For non-moving instances:** *runOnInstanceId* must be the OCID of the non-moving instance.
// Example: `ocid1.instance.oc1..uniqueID`
RunOnInstanceId *string `mandatory:"true" json:"runOnInstanceId"`
// The region of the instance where this script or command should be executed.
// Example: `us-ashburn-1`
RunOnInstanceRegion *string `mandatory:"true" json:"runOnInstanceRegion"`
ObjectStorageScriptLocation *ObjectStorageScriptLocation `mandatory:"true" json:"objectStorageScriptLocation"`
}
func (m RunObjectStoreScriptUserDefinedStep) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RunObjectStoreScriptUserDefinedStep) String() string
func (m RunObjectStoreScriptUserDefinedStep) 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
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
StartDrillExecutionOptionDetails Options for start drill execution.
type StartDrillExecutionOptionDetails struct {
// A flag indicating whether prechecks should be executed before the plan execution.
// Example: `false`
ArePrechecksEnabled *bool `mandatory:"false" json:"arePrechecksEnabled"`
// A flag indicating whether warnings should be ignored during the plan execution.
// Example: `true`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m StartDrillExecutionOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StartDrillExecutionOptionDetails) String() string
func (m StartDrillExecutionOptionDetails) 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
StartDrillExecutionOptions Options for start drill execution.
type StartDrillExecutionOptions struct {
// A flag indicating whether prechecks should be executed before the plan execution.
// Example: `true`
ArePrechecksEnabled *bool `mandatory:"false" json:"arePrechecksEnabled"`
// A flag indicating whether warnings should be ignored during the plan execution.
// Example: `false`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m StartDrillExecutionOptions) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StartDrillExecutionOptions) String() string
func (m StartDrillExecutionOptions) 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
StartDrillPrecheckExecutionOptionDetails Options for start drill precheck execution.
type StartDrillPrecheckExecutionOptionDetails struct {
// A flag indicating whether warnings should be ignored during the precheck.
// Example: `true`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m StartDrillPrecheckExecutionOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StartDrillPrecheckExecutionOptionDetails) String() string
func (m StartDrillPrecheckExecutionOptionDetails) 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
StartDrillPrecheckExecutionOptions Options for start drill precheck execution.
type StartDrillPrecheckExecutionOptions struct {
// A flag indicating whether warnings should be ignored during the precheck.
// Example: `false`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m StartDrillPrecheckExecutionOptions) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StartDrillPrecheckExecutionOptions) String() string
func (m StartDrillPrecheckExecutionOptions) 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
StopDrillExecutionOptionDetails Options for stop drill execution.
type StopDrillExecutionOptionDetails struct {
// A flag indicating whether prechecks should be executed before the plan execution.
// Example: `false`
ArePrechecksEnabled *bool `mandatory:"false" json:"arePrechecksEnabled"`
// A flag indicating whether warnings should be ignored during the plan execution.
// Example: `true`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m StopDrillExecutionOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StopDrillExecutionOptionDetails) String() string
func (m StopDrillExecutionOptionDetails) 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
StopDrillExecutionOptions Options for stop drill execution.
type StopDrillExecutionOptions struct {
// A flag indicating whether a precheck should be executed before the plan execution.
// Example: `true`
ArePrechecksEnabled *bool `mandatory:"false" json:"arePrechecksEnabled"`
// A flag indicating whether warnings should be ignored during the plan execution.
// Example: `false`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m StopDrillExecutionOptions) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StopDrillExecutionOptions) String() string
func (m StopDrillExecutionOptions) 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
StopDrillPrecheckExecutionOptionDetails Options for stop drill precheck execution.
type StopDrillPrecheckExecutionOptionDetails struct {
// A flag indicating whether warnings should be ignored during the precheck.
// Example: `true`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m StopDrillPrecheckExecutionOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StopDrillPrecheckExecutionOptionDetails) String() string
func (m StopDrillPrecheckExecutionOptionDetails) 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
StopDrillPrecheckExecutionOptions Options for stop drill precheck execution.
type StopDrillPrecheckExecutionOptions struct {
// A flag indicating whether warnings should be ignored during the precheck.
// Example: `false`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m StopDrillPrecheckExecutionOptions) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StopDrillPrecheckExecutionOptions) String() string
func (m StopDrillPrecheckExecutionOptions) 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
SwitchoverExecutionOptionDetails Options for switchover execution.
type SwitchoverExecutionOptionDetails struct {
// A flag indicating whether prechecks should be executed before the plan execution.
// Example: `false`
ArePrechecksEnabled *bool `mandatory:"false" json:"arePrechecksEnabled"`
// A flag indicating whether warnings should be ignored during the switchover.
// Example: `true`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m SwitchoverExecutionOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SwitchoverExecutionOptionDetails) String() string
func (m SwitchoverExecutionOptionDetails) 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
SwitchoverExecutionOptions Options for switchover execution.
type SwitchoverExecutionOptions struct {
// A flag indicating whether prechecks should be executed before the plan execution.
// Example: `false`
ArePrechecksEnabled *bool `mandatory:"false" json:"arePrechecksEnabled"`
// A flag indicating whether warnings should be ignored during the plan execution.
// Example: `true`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m SwitchoverExecutionOptions) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SwitchoverExecutionOptions) String() string
func (m SwitchoverExecutionOptions) 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
SwitchoverPrecheckExecutionOptionDetails Options for switchover precheck execution.
type SwitchoverPrecheckExecutionOptionDetails struct {
// A flag indicating whether warnings should be ignored during the switchover precheck.
// Example: `true`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m SwitchoverPrecheckExecutionOptionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SwitchoverPrecheckExecutionOptionDetails) String() string
func (m SwitchoverPrecheckExecutionOptionDetails) 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
SwitchoverPrecheckExecutionOptions Options for switchover precheck execution.
type SwitchoverPrecheckExecutionOptions struct {
// A flag indicating whether warnings should be ignored during the precheck.
// Example: `true`
AreWarningsIgnored *bool `mandatory:"false" json:"areWarningsIgnored"`
}
func (m SwitchoverPrecheckExecutionOptions) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SwitchoverPrecheckExecutionOptions) String() string
func (m SwitchoverPrecheckExecutionOptions) 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
UpdateBlockVolumeAttachmentDetails The details for attaching or detaching a block volume.
type UpdateBlockVolumeAttachmentDetails struct {
// The OCID of the reference compute instance from which to obtain the attachment details for the volume.
// This reference compute instance is from the peer DR protection group.
// Example: `ocid1.instance.oc1..uniqueID`
VolumeAttachmentReferenceInstanceId *string `mandatory:"false" json:"volumeAttachmentReferenceInstanceId"`
}
func (m UpdateBlockVolumeAttachmentDetails) String() string
func (m UpdateBlockVolumeAttachmentDetails) 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
UpdateBlockVolumeMountDetails The details for updating the file system mount on a block volume.
type UpdateBlockVolumeMountDetails struct {
// The physical mount point used for mounting the file system on a block volume.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"false" json:"mountPoint"`
}
func (m UpdateBlockVolumeMountDetails) String() string
func (m UpdateBlockVolumeMountDetails) 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
UpdateComputeInstanceMovableFileSystemOperationDetails The details for updating the operations performed on a file systems for movable compute instance.
type UpdateComputeInstanceMovableFileSystemOperationDetails struct {
// The export path of the file system.
// Example: `/fs-export-path`
ExportPath *string `mandatory:"true" json:"exportPath"`
// The physical mount point of the file system on a host.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"true" json:"mountPoint"`
MountDetails *UpdateFileSystemMountDetails `mandatory:"true" json:"mountDetails"`
UnmountDetails *UpdateFileSystemUnmountDetails `mandatory:"true" json:"unmountDetails"`
}
func (m UpdateComputeInstanceMovableFileSystemOperationDetails) String() string
func (m UpdateComputeInstanceMovableFileSystemOperationDetails) 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
UpdateComputeInstanceNonMovableBlockVolumeOperationDetails The details for updating the operations performed on a block volume.
type UpdateComputeInstanceNonMovableBlockVolumeOperationDetails struct {
// The OCID of the block volume.
// Example: `ocid1.volume.oc1..uniqueID`
BlockVolumeId *string `mandatory:"true" json:"blockVolumeId"`
AttachmentDetails *UpdateBlockVolumeAttachmentDetails `mandatory:"false" json:"attachmentDetails"`
MountDetails *UpdateBlockVolumeMountDetails `mandatory:"false" json:"mountDetails"`
}
func (m UpdateComputeInstanceNonMovableBlockVolumeOperationDetails) String() string
func (m UpdateComputeInstanceNonMovableBlockVolumeOperationDetails) 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
UpdateComputeInstanceNonMovableFileSystemOperationDetails The details for updating the operations performed on a file systems for non-movable compute instance.
type UpdateComputeInstanceNonMovableFileSystemOperationDetails struct {
// The export path of the file system.
// Example: `/fs-export-path`
ExportPath *string `mandatory:"true" json:"exportPath"`
// The physical mount point of the file system on a host.
// Example: `/mnt/yourmountpoint`
MountPoint *string `mandatory:"true" json:"mountPoint"`
// The OCID of mount target.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"true" json:"mountTargetId"`
}
func (m UpdateComputeInstanceNonMovableFileSystemOperationDetails) String() string
func (m UpdateComputeInstanceNonMovableFileSystemOperationDetails) 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
UpdateDrPlanDetails The details for updating a DR plan.
type UpdateDrPlanDetails struct {
// The display name of the DR plan being updated.
// Example: `EBS Switchover PHX to IAD`
DisplayName *string `mandatory:"false" json:"displayName"`
// An ordered list of groups in a DR plan.
PlanGroups []UpdateDrPlanGroupDetails `mandatory:"false" json:"planGroups"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDrPlanDetails) String() string
func (m UpdateDrPlanDetails) 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
UpdateDrPlanExecutionDetails The details for updating a DR plan exection.
type UpdateDrPlanExecutionDetails struct {
// The display name of the DR protection group to update.
// Example: `EBS IAD Group`
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDrPlanExecutionDetails) String() string
func (m UpdateDrPlanExecutionDetails) 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
UpdateDrPlanExecutionRequest wrapper for the UpdateDrPlanExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/UpdateDrPlanExecution.go.html to see an example of how to use UpdateDrPlanExecutionRequest.
type UpdateDrPlanExecutionRequest struct {
// Details for updating the DR plan execution.
UpdateDrPlanExecutionDetails `contributesTo:"body"`
// The OCID of the DR plan execution.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
DrPlanExecutionId *string `mandatory:"true" contributesTo:"path" name:"drPlanExecutionId"`
// 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"`
// The client request ID for tracing.
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 UpdateDrPlanExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDrPlanExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDrPlanExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDrPlanExecutionRequest) String() string
func (request UpdateDrPlanExecutionRequest) 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
UpdateDrPlanExecutionResponse wrapper for the UpdateDrPlanExecution operation
type UpdateDrPlanExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 UpdateDrPlanExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDrPlanExecutionResponse) String() string
UpdateDrPlanGroupDetails The details for updating a group in a DR plan.
type UpdateDrPlanGroupDetails struct {
// The unique id of the group. Must not be modified by user.
// Example: `sgid1.group..uniqueID`
Id *string `mandatory:"false" json:"id"`
// The display name of the group.
// Example: `My_GROUP_3 - EBS Start`
DisplayName *string `mandatory:"false" json:"displayName"`
// The group type.
// Example: `BUILT_IN`
Type DrPlanGroupTypeEnum `mandatory:"false" json:"type,omitempty"`
// A flag indicating whether this group should be enabled for execution.
// This flag is only applicable to the `USER_DEFINED_PAUSE` group. The flag should be null for the remaining group types.
// Example: `true`
IsPauseEnabled *bool `mandatory:"false" json:"isPauseEnabled"`
// The list of steps in this group.
Steps []UpdateDrPlanStepDetails `mandatory:"false" json:"steps"`
}
func (m UpdateDrPlanGroupDetails) String() string
func (m UpdateDrPlanGroupDetails) 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
UpdateDrPlanRequest wrapper for the UpdateDrPlan operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/UpdateDrPlan.go.html to see an example of how to use UpdateDrPlanRequest.
type UpdateDrPlanRequest struct {
// Details for updating the DR plan.
UpdateDrPlanDetails `contributesTo:"body"`
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
DrPlanId *string `mandatory:"true" contributesTo:"path" name:"drPlanId"`
// 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"`
// The client request ID for tracing.
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 UpdateDrPlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDrPlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDrPlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDrPlanRequest) String() string
func (request UpdateDrPlanRequest) 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
UpdateDrPlanResponse wrapper for the UpdateDrPlan operation
type UpdateDrPlanResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 UpdateDrPlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDrPlanResponse) String() string
UpdateDrPlanStepDetails The details for updating a DR plan step.
type UpdateDrPlanStepDetails struct {
// The unique id of the step.
// Example: `sgid1.step..uniqueID`
Id *string `mandatory:"false" json:"id"`
// The display name of the step in a group.
// Example: `My_STEP_3A - EBS Start - STAGE A`
DisplayName *string `mandatory:"false" json:"displayName"`
// The error mode for this step.
// The default error mode for the step is `STOP_ON_ERROR`.
ErrorMode DrPlanStepErrorModeEnum `mandatory:"false" json:"errorMode,omitempty"`
// The timeout in seconds for executing this step.
// When creating a new step, if no timeout is specified, the default timeout is set to `3600` seconds.
// Example: `600`
Timeout *int `mandatory:"false" json:"timeout"`
// A flag indicating whether this step should be enabled for execution.
// The default value for the isEnabled flag is `true`.
// Example: `true`
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
UserDefinedStep UpdateDrPlanUserDefinedStepDetails `mandatory:"false" json:"userDefinedStep"`
}
func (m UpdateDrPlanStepDetails) String() string
func (m *UpdateDrPlanStepDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateDrPlanStepDetails) 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
UpdateDrPlanUserDefinedStepDetails The details for updating a user-defined step in a DR plan.
type UpdateDrPlanUserDefinedStepDetails interface {
}
UpdateDrPlanUserDefinedStepDetailsStepTypeEnum Enum with underlying type: string
type UpdateDrPlanUserDefinedStepDetailsStepTypeEnum string
Set of constants representing the allowable values for UpdateDrPlanUserDefinedStepDetailsStepTypeEnum
const (
UpdateDrPlanUserDefinedStepDetailsStepTypeRunObjectstoreScriptPrecheck UpdateDrPlanUserDefinedStepDetailsStepTypeEnum = "RUN_OBJECTSTORE_SCRIPT_PRECHECK"
UpdateDrPlanUserDefinedStepDetailsStepTypeRunLocalScriptPrecheck UpdateDrPlanUserDefinedStepDetailsStepTypeEnum = "RUN_LOCAL_SCRIPT_PRECHECK"
UpdateDrPlanUserDefinedStepDetailsStepTypeInvokeFunctionPrecheck UpdateDrPlanUserDefinedStepDetailsStepTypeEnum = "INVOKE_FUNCTION_PRECHECK"
UpdateDrPlanUserDefinedStepDetailsStepTypeRunObjectstoreScript UpdateDrPlanUserDefinedStepDetailsStepTypeEnum = "RUN_OBJECTSTORE_SCRIPT"
UpdateDrPlanUserDefinedStepDetailsStepTypeRunLocalScript UpdateDrPlanUserDefinedStepDetailsStepTypeEnum = "RUN_LOCAL_SCRIPT"
UpdateDrPlanUserDefinedStepDetailsStepTypeInvokeFunction UpdateDrPlanUserDefinedStepDetailsStepTypeEnum = "INVOKE_FUNCTION"
)
func GetMappingUpdateDrPlanUserDefinedStepDetailsStepTypeEnum(val string) (UpdateDrPlanUserDefinedStepDetailsStepTypeEnum, bool)
GetMappingUpdateDrPlanUserDefinedStepDetailsStepTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateDrPlanUserDefinedStepDetailsStepTypeEnumValues() []UpdateDrPlanUserDefinedStepDetailsStepTypeEnum
GetUpdateDrPlanUserDefinedStepDetailsStepTypeEnumValues Enumerates the set of values for UpdateDrPlanUserDefinedStepDetailsStepTypeEnum
UpdateDrProtectionGroupDetails The details for updating a DR protection group.
type UpdateDrProtectionGroupDetails struct {
// The display name of the DR protection group.
// Example: `EBS PHX Group`
DisplayName *string `mandatory:"false" json:"displayName"`
LogLocation *UpdateObjectStorageLogLocationDetails `mandatory:"false" json:"logLocation"`
// A list of DR protection group members. When updating members, this list must contain all members being retained,
// including added and updated members. The list must not contain deleted members.
Members []UpdateDrProtectionGroupMemberDetails `mandatory:"false" json:"members"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDrProtectionGroupDetails) String() string
func (m *UpdateDrProtectionGroupDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateDrProtectionGroupDetails) 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
UpdateDrProtectionGroupMemberAutonomousContainerDatabaseDetails Update properties for an Autonomous Container Database member.
type UpdateDrProtectionGroupMemberAutonomousContainerDatabaseDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The type of connection strings used to connect to an Autonomous Container Database snapshot standby created during a DR Drill operation.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html for information about these service types.
ConnectionStringType AutonomousContainerDatabaseSnapshotStandbyConnectionStringTypeEnum `mandatory:"false" json:"connectionStringType,omitempty"`
}
func (m UpdateDrProtectionGroupMemberAutonomousContainerDatabaseDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberAutonomousContainerDatabaseDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberAutonomousContainerDatabaseDetails) String() string
func (m UpdateDrProtectionGroupMemberAutonomousContainerDatabaseDetails) 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
UpdateDrProtectionGroupMemberAutonomousDatabaseDetails Update properties for an Autonomous Database Serverless member.
type UpdateDrProtectionGroupMemberAutonomousDatabaseDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the vault secret where the database SYSDBA password is stored.
// This password is required and used for performing database DR Drill operations when using full clone.
// Example: `ocid1.vaultsecret.oc1..uniqueID`
PasswordVaultSecretId *string `mandatory:"false" json:"passwordVaultSecretId"`
// This specifies the mechanism used to create a temporary Autonomous Database instance for DR Drills.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-clone-about.html for information about these clone types.
// See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-data-guard-snapshot-standby.html for information about snapshot standby.
AutonomousDatabaseStandbyTypeForDrDrills AutonomousDatabaseStandbyTypeForDrDrillsEnum `mandatory:"false" json:"autonomousDatabaseStandbyTypeForDrDrills,omitempty"`
}
func (m UpdateDrProtectionGroupMemberAutonomousDatabaseDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberAutonomousDatabaseDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberAutonomousDatabaseDetails) String() string
func (m UpdateDrProtectionGroupMemberAutonomousDatabaseDetails) 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
UpdateDrProtectionGroupMemberComputeInstanceDetails Deprecated. Update properties for a compute instance member.
type UpdateDrProtectionGroupMemberComputeInstanceDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating if the compute instance should be moved during DR operations.
// Example: `false`
IsMovable *bool `mandatory:"false" json:"isMovable"`
// A list of compute instance VNIC mappings.
VnicMapping []ComputeInstanceVnicMappingDetails `mandatory:"false" json:"vnicMapping"`
// The OCID of a compartment in the destination region in which the compute instance
// should be launched.
// Example: `ocid1.compartment.oc1..uniqueID`
DestinationCompartmentId *string `mandatory:"false" json:"destinationCompartmentId"`
// The OCID of a dedicated VM host in the destination region on which the compute instance
// should be launched.
// Example: `ocid1.dedicatedvmhost.oc1..uniqueID`
DestinationDedicatedVmHostId *string `mandatory:"false" json:"destinationDedicatedVmHostId"`
}
func (m UpdateDrProtectionGroupMemberComputeInstanceDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberComputeInstanceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberComputeInstanceDetails) String() string
func (m UpdateDrProtectionGroupMemberComputeInstanceDetails) 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
UpdateDrProtectionGroupMemberComputeInstanceMovableDetails Update properties for a movable compute instance member.
type UpdateDrProtectionGroupMemberComputeInstanceMovableDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating if the compute instance should be moved to the same fault domain in the destination region.
// The compute instance launch will fail if this flag is set to true and capacity is not available in the
// specified fault domain in the destination region.
// Example: `false`
IsRetainFaultDomain *bool `mandatory:"false" json:"isRetainFaultDomain"`
// The OCID of a capacity reservation in the destination region which will be used to launch
// the compute instance.
// Example: `ocid1.capacityreservation.oc1..uniqueID`
DestinationCapacityReservationId *string `mandatory:"false" json:"destinationCapacityReservationId"`
// A list of compute instance VNIC mappings.
VnicMappings []ComputeInstanceMovableVnicMappingDetails `mandatory:"false" json:"vnicMappings"`
// The OCID of a compartment in the destination region in which the compute instance
// should be launched.
// Example: `ocid1.compartment.oc1..uniqueID`
DestinationCompartmentId *string `mandatory:"false" json:"destinationCompartmentId"`
// The OCID of a dedicated VM host in the destination region where the compute instance
// should be launched.
// Example: `ocid1.dedicatedvmhost.oc1..uniqueID`
DestinationDedicatedVmHostId *string `mandatory:"false" json:"destinationDedicatedVmHostId"`
// A list of operations performed on file systems used by the compute instance.
FileSystemOperations []UpdateComputeInstanceMovableFileSystemOperationDetails `mandatory:"false" json:"fileSystemOperations"`
}
func (m UpdateDrProtectionGroupMemberComputeInstanceMovableDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberComputeInstanceMovableDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberComputeInstanceMovableDetails) String() string
func (m UpdateDrProtectionGroupMemberComputeInstanceMovableDetails) 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
UpdateDrProtectionGroupMemberComputeInstanceNonMovableDetails Update properties for a non-movable compute instance member.
type UpdateDrProtectionGroupMemberComputeInstanceNonMovableDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// A flag indicating whether the non-movable compute instance should be started and stopped during DR operations.
// *Prechecks cannot be executed on stopped instances that are configured to be started.*
IsStartStopEnabled *bool `mandatory:"false" json:"isStartStopEnabled"`
// A list of operations performed on file systems used by the compute instance.
FileSystemOperations []UpdateComputeInstanceNonMovableFileSystemOperationDetails `mandatory:"false" json:"fileSystemOperations"`
// A list of operations performed on block volumes used by the compute instance.
BlockVolumeOperations []UpdateComputeInstanceNonMovableBlockVolumeOperationDetails `mandatory:"false" json:"blockVolumeOperations"`
}
func (m UpdateDrProtectionGroupMemberComputeInstanceNonMovableDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberComputeInstanceNonMovableDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberComputeInstanceNonMovableDetails) String() string
func (m UpdateDrProtectionGroupMemberComputeInstanceNonMovableDetails) 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
UpdateDrProtectionGroupMemberDatabaseDetails Update properties for a Database (DBCS) member.
type UpdateDrProtectionGroupMemberDatabaseDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the vault secret where the database SYSDBA password is stored.
// Example: `ocid1.vaultsecret.oc1..uniqueID`
PasswordVaultSecretId *string `mandatory:"false" json:"passwordVaultSecretId"`
}
func (m UpdateDrProtectionGroupMemberDatabaseDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberDatabaseDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberDatabaseDetails) String() string
func (m UpdateDrProtectionGroupMemberDatabaseDetails) 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
UpdateDrProtectionGroupMemberDetails Update properties for a member in a DR protection group.
type UpdateDrProtectionGroupMemberDetails interface {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
GetMemberId() *string
}
UpdateDrProtectionGroupMemberFileSystemDetails Update properties for a file system member.
type UpdateDrProtectionGroupMemberFileSystemDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The availability domain of the destination mount target.
// Example: `BBTh:region-AD`
DestinationAvailabilityDomain *string `mandatory:"false" json:"destinationAvailabilityDomain"`
// A list of mappings between file system exports in the primary region and mount targets in the standby region.
ExportMappings []FileSystemExportMappingDetails `mandatory:"false" json:"exportMappings"`
}
func (m UpdateDrProtectionGroupMemberFileSystemDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberFileSystemDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberFileSystemDetails) String() string
func (m UpdateDrProtectionGroupMemberFileSystemDetails) 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
UpdateDrProtectionGroupMemberLoadBalancerDetails Update properties for a load balancer member.
type UpdateDrProtectionGroupMemberLoadBalancerDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the destination load balancer.
// Example: `ocid1.loadbalancer.oc1..uniqueID`
DestinationLoadBalancerId *string `mandatory:"false" json:"destinationLoadBalancerId"`
// A list of backend set mappings that are used to transfer or update backends during DR.
BackendSetMappings []LoadBalancerBackendSetMappingDetails `mandatory:"false" json:"backendSetMappings"`
}
func (m UpdateDrProtectionGroupMemberLoadBalancerDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberLoadBalancerDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberLoadBalancerDetails) String() string
func (m UpdateDrProtectionGroupMemberLoadBalancerDetails) 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
UpdateDrProtectionGroupMemberNetworkLoadBalancerDetails Update properties for a network load balancer member.
type UpdateDrProtectionGroupMemberNetworkLoadBalancerDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the destination network load balancer.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
DestinationNetworkLoadBalancerId *string `mandatory:"false" json:"destinationNetworkLoadBalancerId"`
// A list of backend set mappings that are used to transfer or update backends during DR.
BackendSetMappings []NetworkLoadBalancerBackendSetMappingDetails `mandatory:"false" json:"backendSetMappings"`
}
func (m UpdateDrProtectionGroupMemberNetworkLoadBalancerDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberNetworkLoadBalancerDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberNetworkLoadBalancerDetails) String() string
func (m UpdateDrProtectionGroupMemberNetworkLoadBalancerDetails) 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
UpdateDrProtectionGroupMemberObjectStorageBucketDetails Update properties for a object storage bucket member.
type UpdateDrProtectionGroupMemberObjectStorageBucketDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The namespace in object storage (Note - this is usually the tenancy name).
// Example: `myocitenancy`
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The bucket name inside the object storage namespace.
// Example: `bucket_name`
BucketName *string `mandatory:"true" json:"bucketName"`
}
func (m UpdateDrProtectionGroupMemberObjectStorageBucketDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberObjectStorageBucketDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberObjectStorageBucketDetails) String() string
func (m UpdateDrProtectionGroupMemberObjectStorageBucketDetails) 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
UpdateDrProtectionGroupMemberOkeClusterDetails Update properties for an OKE member.
type UpdateDrProtectionGroupMemberOkeClusterDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
// The OCID of the peer OKE cluster.
// This property applies to the OKE cluster member in both the primary and standby region.
// Example: `ocid1.cluster.oc1..uniqueID`
PeerClusterId *string `mandatory:"false" json:"peerClusterId"`
// The OCID of the compute instance member that is designated as a jump host.
// This compute instance will be used to perform DR operations on the cluster using Oracle Cloud Agent's Run Command feature.
// Example: `ocid1.instance.oc1..uniqueID`
JumpHostId *string `mandatory:"false" json:"jumpHostId"`
BackupLocation *UpdateOkeBackupLocationDetails `mandatory:"false" json:"backupLocation"`
BackupConfig *UpdateOkeClusterBackupConfigDetails `mandatory:"false" json:"backupConfig"`
// The list of source-to-destination load balancer mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
LoadBalancerMappings []UpdateOkeClusterLoadBalancerMappingDetails `mandatory:"false" json:"loadBalancerMappings"`
// The list of source-to-destination network load balancer mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
NetworkLoadBalancerMappings []UpdateOkeClusterNetworkLoadBalancerMappingDetails `mandatory:"false" json:"networkLoadBalancerMappings"`
// The list of source-to-destination vault mappings required for DR operations.
// This property applies to the OKE cluster member in primary region.
VaultMappings []UpdateOkeClusterVaultMappingDetails `mandatory:"false" json:"vaultMappings"`
// The list of managed node pools with configurations for minimum and maximum node counts.
// This property applies to the OKE cluster member in both the primary and standby region.
ManagedNodePoolConfigs []UpdateOkeClusterManagedNodePoolConfigurationDetails `mandatory:"false" json:"managedNodePoolConfigs"`
// The list of virtual node pools with configurations for minimum and maximum node counts.
// This property applies to the OKE cluster member in both the primary and standby region.
VirtualNodePoolConfigs []UpdateOkeClusterVirtualNodePoolConfigurationDetails `mandatory:"false" json:"virtualNodePoolConfigs"`
}
func (m UpdateDrProtectionGroupMemberOkeClusterDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberOkeClusterDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberOkeClusterDetails) String() string
func (m UpdateDrProtectionGroupMemberOkeClusterDetails) 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
UpdateDrProtectionGroupMemberVolumeGroupDetails Update properties for a volume group member.
type UpdateDrProtectionGroupMemberVolumeGroupDetails struct {
// The OCID of the member.
// Example: `ocid1.database.oc1..uniqueID`
MemberId *string `mandatory:"true" json:"memberId"`
}
func (m UpdateDrProtectionGroupMemberVolumeGroupDetails) GetMemberId() *string
GetMemberId returns MemberId
func (m UpdateDrProtectionGroupMemberVolumeGroupDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDrProtectionGroupMemberVolumeGroupDetails) String() string
func (m UpdateDrProtectionGroupMemberVolumeGroupDetails) 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
UpdateDrProtectionGroupRequest wrapper for the UpdateDrProtectionGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/UpdateDrProtectionGroup.go.html to see an example of how to use UpdateDrProtectionGroupRequest.
type UpdateDrProtectionGroupRequest struct {
// Details for updating the the DR protection group.
UpdateDrProtectionGroupDetails `contributesTo:"body"`
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"path" name:"drProtectionGroupId"`
// 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"`
// The client request ID for tracing.
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 UpdateDrProtectionGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDrProtectionGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDrProtectionGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDrProtectionGroupRequest) String() string
func (request UpdateDrProtectionGroupRequest) 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
UpdateDrProtectionGroupResponse wrapper for the UpdateDrProtectionGroup operation
type UpdateDrProtectionGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 UpdateDrProtectionGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDrProtectionGroupResponse) String() string
UpdateDrProtectionGroupRoleDetails The details for updating the role of a DR protection group.
type UpdateDrProtectionGroupRoleDetails struct {
// The new role of the DR protection group.
Role DrProtectionGroupRoleEnum `mandatory:"true" json:"role"`
}
func (m UpdateDrProtectionGroupRoleDetails) String() string
func (m UpdateDrProtectionGroupRoleDetails) 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
UpdateDrProtectionGroupRoleRequest wrapper for the UpdateDrProtectionGroupRole operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/UpdateDrProtectionGroupRole.go.html to see an example of how to use UpdateDrProtectionGroupRoleRequest.
type UpdateDrProtectionGroupRoleRequest struct {
// The role details for the DR protection group to be updated.
UpdateDrProtectionGroupRoleDetails `contributesTo:"body"`
// The OCID of the DR protection group.
// Example: `ocid1.drprotectiongroup.oc1..uniqueID`
DrProtectionGroupId *string `mandatory:"true" contributesTo:"path" name:"drProtectionGroupId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 UpdateDrProtectionGroupRoleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDrProtectionGroupRoleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDrProtectionGroupRoleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDrProtectionGroupRoleRequest) String() string
func (request UpdateDrProtectionGroupRoleRequest) 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
UpdateDrProtectionGroupRoleResponse wrapper for the UpdateDrProtectionGroupRole operation
type UpdateDrProtectionGroupRoleResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 UpdateDrProtectionGroupRoleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDrProtectionGroupRoleResponse) String() string
UpdateFileSystemMountDetails The details for updating the mount properties of a file system.
type UpdateFileSystemMountDetails struct {
// The OCID of the mount target for this file system.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"false" json:"mountTargetId"`
}
func (m UpdateFileSystemMountDetails) String() string
func (m UpdateFileSystemMountDetails) 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
UpdateFileSystemUnmountDetails The details for updating the unmount properties of a file system.
type UpdateFileSystemUnmountDetails struct {
// The OCID of the mount target for this file system.
// Example: `ocid1.mounttarget.oc1..uniqueID`
MountTargetId *string `mandatory:"false" json:"mountTargetId"`
}
func (m UpdateFileSystemUnmountDetails) String() string
func (m UpdateFileSystemUnmountDetails) 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
UpdateInvokeFunctionPrecheckStepDetails The details for updating Invoke Oracle function precheck step.
type UpdateInvokeFunctionPrecheckStepDetails struct {
}
func (m UpdateInvokeFunctionPrecheckStepDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateInvokeFunctionPrecheckStepDetails) String() string
func (m UpdateInvokeFunctionPrecheckStepDetails) 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
UpdateInvokeFunctionUserDefinedStepDetails The details for updating an Invoke Oracle Function step.
type UpdateInvokeFunctionUserDefinedStepDetails struct {
// The OCID of function to be invoked.
// Example: `ocid1.fnfunc.oc1..uniqueID`
FunctionId *string `mandatory:"true" json:"functionId"`
// The request body for the function.
// Example: `{ "FnParam1", "FnParam2" }`
RequestBody *string `mandatory:"false" json:"requestBody"`
}
func (m UpdateInvokeFunctionUserDefinedStepDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateInvokeFunctionUserDefinedStepDetails) String() string
func (m UpdateInvokeFunctionUserDefinedStepDetails) 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
UpdateLocalScriptPrecheckStepDetails The details for updating Run local script precheck step.
type UpdateLocalScriptPrecheckStepDetails struct {
}
func (m UpdateLocalScriptPrecheckStepDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateLocalScriptPrecheckStepDetails) String() string
func (m UpdateLocalScriptPrecheckStepDetails) 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
UpdateObjectStorageLogLocationDetails The details for updating an object storage log location for a DR protection group.
type UpdateObjectStorageLogLocationDetails struct {
// The namespace in object storage (Note - this is usually the tenancy name).
// Example: `myocitenancy`
Namespace *string `mandatory:"true" json:"namespace"`
// The bucket name inside the object storage namespace.
// Example: `operation_logs`
Bucket *string `mandatory:"true" json:"bucket"`
}
func (m UpdateObjectStorageLogLocationDetails) String() string
func (m UpdateObjectStorageLogLocationDetails) 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
UpdateObjectStorageScriptLocationDetails The details for updating an object storage script location for a user-defined step in a DR plan.
type UpdateObjectStorageScriptLocationDetails struct {
// The namespace in object storage (Note - this is usually the tenancy name).
// Example: `myocitenancy`
Namespace *string `mandatory:"true" json:"namespace"`
// The bucket name inside the object storage namespace.
// Example: `custom_dr_scripts`
Bucket *string `mandatory:"true" json:"bucket"`
// The object name inside the object storage bucket.
// Example: `validate_app_start.sh`
Object *string `mandatory:"true" json:"object"`
}
func (m UpdateObjectStorageScriptLocationDetails) String() string
func (m UpdateObjectStorageScriptLocationDetails) 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
UpdateObjectStoreScriptPrecheckStepDetails The details for updating Run object store script precheck step.
type UpdateObjectStoreScriptPrecheckStepDetails struct {
}
func (m UpdateObjectStoreScriptPrecheckStepDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateObjectStoreScriptPrecheckStepDetails) String() string
func (m UpdateObjectStoreScriptPrecheckStepDetails) 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
UpdateOkeBackupLocationDetails The details for updating the backup location of an OKE Cluster.
type UpdateOkeBackupLocationDetails struct {
// The namespace in the object storage backup location (Note - this is usually the tenancy name).
// Example: `myocitenancy`
Namespace *string `mandatory:"false" json:"namespace"`
// The bucket name inside the object storage namespace.
// Example: `operation_logs`
Bucket *string `mandatory:"false" json:"bucket"`
}
func (m UpdateOkeBackupLocationDetails) String() string
func (m UpdateOkeBackupLocationDetails) 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
UpdateOkeClusterBackupConfigDetails Update backup configuration properties for an OKE member.
type UpdateOkeClusterBackupConfigDetails struct {
// A list of namespaces that need to be backed up.
// The default value is null. If a list of namespaces is not provided, all namespaces will be backed up.
// This property applies to the OKE cluster member in primary region.
// Example: ["default", "pv-nginx"]
Namespaces []string `mandatory:"false" json:"namespaces"`
// The schedule for backing up namespaces to the destination region. If a backup schedule is not specified, only a single backup will be created.
// This format of the string specifying the backup schedule must conform with RFC-5545.
// This schedule will use the UTC timezone.
// This property applies to the OKE cluster member in primary region.
// Example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1
BackupSchedule *string `mandatory:"false" json:"backupSchedule"`
// Controls the behaviour of image replication across regions.
// This property applies to the OKE cluster member in primary region.
ReplicateImages OkeClusterImageReplicationEnum `mandatory:"false" json:"replicateImages,omitempty"`
// The maximum number of backups that should be retained.
// This property applies to the OKE cluster member in primary region.
MaxNumberOfBackupsRetained *int `mandatory:"false" json:"maxNumberOfBackupsRetained"`
// The OCID of the vault secret that stores the image credential.
// This property applies to the OKE cluster member in both the primary and standby region.
ImageReplicationVaultSecretId *string `mandatory:"false" json:"imageReplicationVaultSecretId"`
}
func (m UpdateOkeClusterBackupConfigDetails) String() string
func (m UpdateOkeClusterBackupConfigDetails) 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
UpdateOkeClusterLoadBalancerMappingDetails Update source-to-destination mapping for a load balancer.
type UpdateOkeClusterLoadBalancerMappingDetails struct {
// The OCID of the source Load Balancer .
//
// Example: `ocid1.loadbalancer.oc1..uniqueID`
SourceLoadBalancerId *string `mandatory:"true" json:"sourceLoadBalancerId"`
// The OCID of the destination Load Balancer.
// Example: `ocid1.loadbalancer.oc1..uniqueID`
DestinationLoadBalancerId *string `mandatory:"true" json:"destinationLoadBalancerId"`
}
func (m UpdateOkeClusterLoadBalancerMappingDetails) String() string
func (m UpdateOkeClusterLoadBalancerMappingDetails) 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
UpdateOkeClusterManagedNodePoolConfigurationDetails Update managed node pool configuration properties for an OKE member.
type UpdateOkeClusterManagedNodePoolConfigurationDetails struct {
// The OCID of the managed node pool in OKE cluster.
Id *string `mandatory:"true" json:"id"`
// The minimum number to which nodes in the managed node pool could be scaled down.
Minimum *int `mandatory:"false" json:"minimum"`
// The maximum number to which nodes in the managed node pool could be scaled up.
Maximum *int `mandatory:"false" json:"maximum"`
}
func (m UpdateOkeClusterManagedNodePoolConfigurationDetails) String() string
func (m UpdateOkeClusterManagedNodePoolConfigurationDetails) 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
UpdateOkeClusterNetworkLoadBalancerMappingDetails Update source-to-destination mapping for a network load balancer.
type UpdateOkeClusterNetworkLoadBalancerMappingDetails struct {
// The OCID of the source Network Load Balancer.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
SourceNetworkLoadBalancerId *string `mandatory:"true" json:"sourceNetworkLoadBalancerId"`
// The OCID of the destination Network Load Balancer.
// Example: `ocid1.networkloadbalancer.oc1..uniqueID`
DestinationNetworkLoadBalancerId *string `mandatory:"true" json:"destinationNetworkLoadBalancerId"`
}
func (m UpdateOkeClusterNetworkLoadBalancerMappingDetails) String() string
func (m UpdateOkeClusterNetworkLoadBalancerMappingDetails) 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
UpdateOkeClusterVaultMappingDetails Update source-to-destination mapping for a vault.
type UpdateOkeClusterVaultMappingDetails struct {
// The OCID of the source Vault.
// Example: `ocid1.vault.oc1..uniqueID`
SourceVaultId *string `mandatory:"true" json:"sourceVaultId"`
// The OCID of the destination Vault.
// Example: `ocid1.vault.oc1..uniqueID`
DestinationVaultId *string `mandatory:"true" json:"destinationVaultId"`
}
func (m UpdateOkeClusterVaultMappingDetails) String() string
func (m UpdateOkeClusterVaultMappingDetails) 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
UpdateOkeClusterVirtualNodePoolConfigurationDetails Update virtual node pool configuration properties for an OKE member.
type UpdateOkeClusterVirtualNodePoolConfigurationDetails struct {
// The OCID of the virtual node pool in OKE cluster.
Id *string `mandatory:"true" json:"id"`
// The minimum number to which nodes in the virtual node pool could be scaled down.
Minimum *int `mandatory:"false" json:"minimum"`
// The maximum number to which nodes in the virtual node pool could be scaled up.
Maximum *int `mandatory:"false" json:"maximum"`
}
func (m UpdateOkeClusterVirtualNodePoolConfigurationDetails) String() string
func (m UpdateOkeClusterVirtualNodePoolConfigurationDetails) 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
UpdateRunLocalScriptUserDefinedStepDetails The details for updating a Run Local Script step.
type UpdateRunLocalScriptUserDefinedStepDetails struct {
// The OCID of the instance on which this script or command should be executed.
// **For moving instances:** *runOnInstanceId* must be the OCID of the instance in the region where the
// instance is currently present.
// **For non-moving instances:** *runOnInstanceId* must be the OCID of the non-moving instance.
// Example: `ocid1.instance.oc1..uniqueID`
RunOnInstanceId *string `mandatory:"true" json:"runOnInstanceId"`
// The script name and arguments.
// Example: `/usr/bin/python3 /home/opc/scripts/my_app_script.py arg1 arg2 arg3`
ScriptCommand *string `mandatory:"true" json:"scriptCommand"`
// The userid on the instance to be used for executing the script or command.
// Example: `opc`
RunAsUser *string `mandatory:"false" json:"runAsUser"`
}
func (m UpdateRunLocalScriptUserDefinedStepDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateRunLocalScriptUserDefinedStepDetails) String() string
func (m UpdateRunLocalScriptUserDefinedStepDetails) 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
UpdateRunObjectStoreScriptUserDefinedStepDetails The details for updating a Run Object Store Script step.
type UpdateRunObjectStoreScriptUserDefinedStepDetails struct {
// The OCID of the instance on which this script or command should be executed.
// **For moving instances:** *runOnInstanceId* must be the OCID of the instance in the region where the
// instance is currently present.
// **For non-moving instances:** *runOnInstanceId* must be the OCID of the non-moving instance.
// Example: `ocid1.instance.oc1..uniqueID`
RunOnInstanceId *string `mandatory:"true" json:"runOnInstanceId"`
ObjectStorageScriptLocation *UpdateObjectStorageScriptLocationDetails `mandatory:"true" json:"objectStorageScriptLocation"`
}
func (m UpdateRunObjectStoreScriptUserDefinedStepDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateRunObjectStoreScriptUserDefinedStepDetails) String() string
func (m UpdateRunObjectStoreScriptUserDefinedStepDetails) 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
VerifyDrPlanDefaultDetails The default type.
type VerifyDrPlanDefaultDetails struct {
}
func (m VerifyDrPlanDefaultDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VerifyDrPlanDefaultDetails) String() string
func (m VerifyDrPlanDefaultDetails) 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
VerifyDrPlanDetails The details for verifying a DR plan.
type VerifyDrPlanDetails interface {
}
VerifyDrPlanDetailsTypeEnum Enum with underlying type: string
type VerifyDrPlanDetailsTypeEnum string
Set of constants representing the allowable values for VerifyDrPlanDetailsTypeEnum
const (
VerifyDrPlanDetailsTypeDefault VerifyDrPlanDetailsTypeEnum = "DEFAULT"
)
func GetMappingVerifyDrPlanDetailsTypeEnum(val string) (VerifyDrPlanDetailsTypeEnum, bool)
GetMappingVerifyDrPlanDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVerifyDrPlanDetailsTypeEnumValues() []VerifyDrPlanDetailsTypeEnum
GetVerifyDrPlanDetailsTypeEnumValues Enumerates the set of values for VerifyDrPlanDetailsTypeEnum
VerifyDrPlanRequest wrapper for the VerifyDrPlan operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/disasterrecovery/VerifyDrPlan.go.html to see an example of how to use VerifyDrPlanRequest.
type VerifyDrPlanRequest struct {
// Details for verifying a DR plan.
VerifyDrPlanDetails `contributesTo:"body"`
// The OCID of the DR plan.
// Example: `ocid1.drplan.oc1..uniqueID`
DrPlanId *string `mandatory:"true" contributesTo:"path" name:"drPlanId"`
// 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"`
// 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"`
// The client request ID for tracing.
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 VerifyDrPlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request VerifyDrPlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request VerifyDrPlanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request VerifyDrPlanRequest) String() string
func (request VerifyDrPlanRequest) 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
VerifyDrPlanResponse wrapper for the VerifyDrPlan operation
type VerifyDrPlanResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier (OCID) for the asynchronous request. You can use this to query status of the asynchronous operation. Use GetWorkRequest with this OCID to track the status of the 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 VerifyDrPlanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response VerifyDrPlanResponse) String() string
WorkRequest Information on a work request.
type WorkRequest struct {
// The type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID of the work request.
// Example: `ocid1.drworkrequest.oc1..uniqueID`
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
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// The percentage of the request completed.
// Example: `75`
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
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 associcated with a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed here --
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
// Example: `429`
Code *string `mandatory:"true" json:"code"`
// A human-readable description of the issue encountered.
// Example: `TooManyRequests`
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
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 The results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
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 related to the execution of a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
// Example: `DR plan execution is in progress`
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
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 The results of a workRequestLog search. Contains both WorkRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A 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.
// Example: `DrPlanExecution`
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 (OCID) of the resource the work request affects.
// Example: `ocid1.drplanexecution.oc1..uniqueID`
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can use to perform a GET on 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 The summary of a work request.
type WorkRequestSummary struct {
// The type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID of the work request.
// Example: `ocid1.workrequest.oc1..uniqueID`
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.
// Example: `ocid1.compartment.oc1..uniqueID`
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// The percentage of the request completed.
// Example: `75`
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished. An RFC3339 formatted datetime string.
// Example: `2019-03-29T09:36:42Z`
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 The results of a workRequestSummary search. Contains both WorkRequestSummary items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work request summaries.
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