func GetAnonymousTransactionsHandlingPolicyEnumStringValues() []string
GetAnonymousTransactionsHandlingPolicyEnumStringValues Enumerates the set of values in String for AnonymousTransactionsHandlingPolicyEnum
func GetBackupBackupTypeEnumStringValues() []string
GetBackupBackupTypeEnumStringValues Enumerates the set of values in String for BackupBackupTypeEnum
func GetBackupCreationTypeEnumStringValues() []string
GetBackupCreationTypeEnumStringValues Enumerates the set of values in String for BackupCreationTypeEnum
func GetBackupLifecycleStateEnumStringValues() []string
GetBackupLifecycleStateEnumStringValues Enumerates the set of values in String for BackupLifecycleStateEnum
func GetCaCertificateCertificateTypeEnumStringValues() []string
GetCaCertificateCertificateTypeEnumStringValues Enumerates the set of values in String for CaCertificateCertificateTypeEnum
func GetChannelFilterTypeEnumStringValues() []string
GetChannelFilterTypeEnumStringValues Enumerates the set of values in String for ChannelFilterTypeEnum
func GetChannelLifecycleStateEnumStringValues() []string
GetChannelLifecycleStateEnumStringValues Enumerates the set of values in String for ChannelLifecycleStateEnum
func GetChannelSourceMysqlSslModeEnumStringValues() []string
GetChannelSourceMysqlSslModeEnumStringValues Enumerates the set of values in String for ChannelSourceMysqlSslModeEnum
func GetChannelSourceSourceTypeEnumStringValues() []string
GetChannelSourceSourceTypeEnumStringValues Enumerates the set of values in String for ChannelSourceSourceTypeEnum
func GetChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnumStringValues() []string
GetChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnumStringValues Enumerates the set of values in String for ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum
func GetChannelTargetTargetTypeEnumStringValues() []string
GetChannelTargetTargetTypeEnumStringValues Enumerates the set of values in String for ChannelTargetTargetTypeEnum
func GetConfigurationLifecycleStateEnumStringValues() []string
GetConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for ConfigurationLifecycleStateEnum
func GetConfigurationTypeEnumStringValues() []string
GetConfigurationTypeEnumStringValues Enumerates the set of values in String for ConfigurationTypeEnum
func GetConfigurationVariablesBinlogRowMetadataEnumStringValues() []string
GetConfigurationVariablesBinlogRowMetadataEnumStringValues Enumerates the set of values in String for ConfigurationVariablesBinlogRowMetadataEnum
func GetConfigurationVariablesCompletionTypeEnumStringValues() []string
GetConfigurationVariablesCompletionTypeEnumStringValues Enumerates the set of values in String for ConfigurationVariablesCompletionTypeEnum
func GetConfigurationVariablesDefaultAuthenticationPluginEnumStringValues() []string
GetConfigurationVariablesDefaultAuthenticationPluginEnumStringValues Enumerates the set of values in String for ConfigurationVariablesDefaultAuthenticationPluginEnum
func GetConfigurationVariablesGroupReplicationConsistencyEnumStringValues() []string
GetConfigurationVariablesGroupReplicationConsistencyEnumStringValues Enumerates the set of values in String for ConfigurationVariablesGroupReplicationConsistencyEnum
func GetConfigurationVariablesTransactionIsolationEnumStringValues() []string
GetConfigurationVariablesTransactionIsolationEnumStringValues Enumerates the set of values in String for ConfigurationVariablesTransactionIsolationEnum
func GetCrashRecoveryStatusEnumStringValues() []string
GetCrashRecoveryStatusEnumStringValues Enumerates the set of values in String for CrashRecoveryStatusEnum
func GetCreateBackupDetailsBackupTypeEnumStringValues() []string
GetCreateBackupDetailsBackupTypeEnumStringValues Enumerates the set of values in String for CreateBackupDetailsBackupTypeEnum
func GetCreateDbSystemSourceDetailsSourceTypeEnumStringValues() []string
GetCreateDbSystemSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for CreateDbSystemSourceDetailsSourceTypeEnum
func GetCreateDeletionPolicyDetailsAutomaticBackupRetentionEnumStringValues() []string
GetCreateDeletionPolicyDetailsAutomaticBackupRetentionEnumStringValues Enumerates the set of values in String for CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum
func GetCreateDeletionPolicyDetailsFinalBackupEnumStringValues() []string
GetCreateDeletionPolicyDetailsFinalBackupEnumStringValues Enumerates the set of values in String for CreateDeletionPolicyDetailsFinalBackupEnum
func GetDatabaseManagementStatusEnumStringValues() []string
GetDatabaseManagementStatusEnumStringValues Enumerates the set of values in String for DatabaseManagementStatusEnum
func GetDbSystemEndpointModesEnumStringValues() []string
GetDbSystemEndpointModesEnumStringValues Enumerates the set of values in String for DbSystemEndpointModesEnum
func GetDbSystemEndpointResourceTypeEnumStringValues() []string
GetDbSystemEndpointResourceTypeEnumStringValues Enumerates the set of values in String for DbSystemEndpointResourceTypeEnum
func GetDbSystemEndpointStatusEnumStringValues() []string
GetDbSystemEndpointStatusEnumStringValues Enumerates the set of values in String for DbSystemEndpointStatusEnum
func GetDbSystemLifecycleStateEnumStringValues() []string
GetDbSystemLifecycleStateEnumStringValues Enumerates the set of values in String for DbSystemLifecycleStateEnum
func GetDbSystemSourceSourceTypeEnumStringValues() []string
GetDbSystemSourceSourceTypeEnumStringValues Enumerates the set of values in String for DbSystemSourceSourceTypeEnum
func GetDeletionPolicyDetailsAutomaticBackupRetentionEnumStringValues() []string
GetDeletionPolicyDetailsAutomaticBackupRetentionEnumStringValues Enumerates the set of values in String for DeletionPolicyDetailsAutomaticBackupRetentionEnum
func GetDeletionPolicyDetailsFinalBackupEnumStringValues() []string
GetDeletionPolicyDetailsFinalBackupEnumStringValues Enumerates the set of values in String for DeletionPolicyDetailsFinalBackupEnum
func GetHeatWaveClusterLifecycleStateEnumStringValues() []string
GetHeatWaveClusterLifecycleStateEnumStringValues Enumerates the set of values in String for HeatWaveClusterLifecycleStateEnum
func GetHeatWaveClusterMemoryEstimateStatusEnumStringValues() []string
GetHeatWaveClusterMemoryEstimateStatusEnumStringValues Enumerates the set of values in String for HeatWaveClusterMemoryEstimateStatusEnum
func GetHeatWaveNodeLifecycleStateEnumStringValues() []string
GetHeatWaveNodeLifecycleStateEnumStringValues Enumerates the set of values in String for HeatWaveNodeLifecycleStateEnum
func GetInitializationVariablesLowerCaseTableNamesEnumStringValues() []string
GetInitializationVariablesLowerCaseTableNamesEnumStringValues Enumerates the set of values in String for InitializationVariablesLowerCaseTableNamesEnum
func GetInnoDbShutdownModeEnumStringValues() []string
GetInnoDbShutdownModeEnumStringValues Enumerates the set of values in String for InnoDbShutdownModeEnum
func GetListBackupsSortByEnumStringValues() []string
GetListBackupsSortByEnumStringValues Enumerates the set of values in String for ListBackupsSortByEnum
func GetListBackupsSortOrderEnumStringValues() []string
GetListBackupsSortOrderEnumStringValues Enumerates the set of values in String for ListBackupsSortOrderEnum
func GetListChannelsSortByEnumStringValues() []string
GetListChannelsSortByEnumStringValues Enumerates the set of values in String for ListChannelsSortByEnum
func GetListChannelsSortOrderEnumStringValues() []string
GetListChannelsSortOrderEnumStringValues Enumerates the set of values in String for ListChannelsSortOrderEnum
func GetListConfigurationsSortByEnumStringValues() []string
GetListConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListConfigurationsSortByEnum
func GetListConfigurationsSortOrderEnumStringValues() []string
GetListConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListConfigurationsSortOrderEnum
func GetListConfigurationsTypeEnumStringValues() []string
GetListConfigurationsTypeEnumStringValues Enumerates the set of values in String for ListConfigurationsTypeEnum
func GetListDbSystemsDatabaseManagementEnumStringValues() []string
GetListDbSystemsDatabaseManagementEnumStringValues Enumerates the set of values in String for ListDbSystemsDatabaseManagementEnum
func GetListDbSystemsSortByEnumStringValues() []string
GetListDbSystemsSortByEnumStringValues Enumerates the set of values in String for ListDbSystemsSortByEnum
func GetListDbSystemsSortOrderEnumStringValues() []string
GetListDbSystemsSortOrderEnumStringValues Enumerates the set of values in String for ListDbSystemsSortOrderEnum
func GetListReplicasSortByEnumStringValues() []string
GetListReplicasSortByEnumStringValues Enumerates the set of values in String for ListReplicasSortByEnum
func GetListReplicasSortOrderEnumStringValues() []string
GetListReplicasSortOrderEnumStringValues Enumerates the set of values in String for ListReplicasSortOrderEnum
func GetListShapesIsSupportedForEnumStringValues() []string
GetListShapesIsSupportedForEnumStringValues Enumerates the set of values in String for ListShapesIsSupportedForEnum
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 GetReplicaLifecycleStateEnumStringValues() []string
GetReplicaLifecycleStateEnumStringValues Enumerates the set of values in String for ReplicaLifecycleStateEnum
func GetReplicaSummaryLifecycleStateEnumStringValues() []string
GetReplicaSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ReplicaSummaryLifecycleStateEnum
func GetShapeSummaryIsSupportedForEnumStringValues() []string
GetShapeSummaryIsSupportedForEnumStringValues Enumerates the set of values in String for ShapeSummaryIsSupportedForEnum
func GetUpdateDeletionPolicyDetailsAutomaticBackupRetentionEnumStringValues() []string
GetUpdateDeletionPolicyDetailsAutomaticBackupRetentionEnumStringValues Enumerates the set of values in String for UpdateDeletionPolicyDetailsAutomaticBackupRetentionEnum
func GetUpdateDeletionPolicyDetailsFinalBackupEnumStringValues() []string
GetUpdateDeletionPolicyDetailsFinalBackupEnumStringValues Enumerates the set of values in String for UpdateDeletionPolicyDetailsFinalBackupEnum
func GetWorkRequestOperationStatusEnumStringValues() []string
GetWorkRequestOperationStatusEnumStringValues Enumerates the set of values in String for WorkRequestOperationStatusEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
AddHeatWaveClusterDetails Details required to add a HeatWave cluster.
type AddHeatWaveClusterDetails struct {
// The shape determines resources to allocate to the HeatWave
// nodes - CPU cores, memory.
ShapeName *string `mandatory:"true" json:"shapeName"`
// The number of analytics-processing nodes provisioned for the
// HeatWave cluster.
ClusterSize *int `mandatory:"true" json:"clusterSize"`
// Enable/disable Lakehouse for the HeatWave cluster.
IsLakehouseEnabled *bool `mandatory:"false" json:"isLakehouseEnabled"`
}
func (m AddHeatWaveClusterDetails) String() string
func (m AddHeatWaveClusterDetails) 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
AddHeatWaveClusterRequest wrapper for the AddHeatWaveCluster operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/AddHeatWaveCluster.go.html to see an example of how to use AddHeatWaveClusterRequest.
type AddHeatWaveClusterRequest struct {
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// Request to add a HeatWave cluster.
AddHeatWaveClusterDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `If-Match` header 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"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 AddHeatWaveClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddHeatWaveClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddHeatWaveClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddHeatWaveClusterRequest) String() string
func (request AddHeatWaveClusterRequest) 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
AddHeatWaveClusterResponse wrapper for the AddHeatWaveCluster operation
type AddHeatWaveClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The HeatWaveCluster instance
HeatWaveCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response AddHeatWaveClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddHeatWaveClusterResponse) String() string
AnonymousTransactionsHandling Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does.
type AnonymousTransactionsHandling interface {
}
AnonymousTransactionsHandlingPolicyEnum Enum with underlying type: string
type AnonymousTransactionsHandlingPolicyEnum string
Set of constants representing the allowable values for AnonymousTransactionsHandlingPolicyEnum
const (
AnonymousTransactionsHandlingPolicyErrorOnAnonymous AnonymousTransactionsHandlingPolicyEnum = "ERROR_ON_ANONYMOUS"
AnonymousTransactionsHandlingPolicyAssignTargetUuid AnonymousTransactionsHandlingPolicyEnum = "ASSIGN_TARGET_UUID"
AnonymousTransactionsHandlingPolicyAssignManualUuid AnonymousTransactionsHandlingPolicyEnum = "ASSIGN_MANUAL_UUID"
)
func GetAnonymousTransactionsHandlingPolicyEnumValues() []AnonymousTransactionsHandlingPolicyEnum
GetAnonymousTransactionsHandlingPolicyEnumValues Enumerates the set of values for AnonymousTransactionsHandlingPolicyEnum
func GetMappingAnonymousTransactionsHandlingPolicyEnum(val string) (AnonymousTransactionsHandlingPolicyEnum, bool)
GetMappingAnonymousTransactionsHandlingPolicyEnum performs case Insensitive comparison on enum value and return the desired enum
AssignManualUuidHandling Enables assignment of IDs on the target to anonymous transactions coming from the source. A manually defined UUID is added as a prefix to the ID.
type AssignManualUuidHandling struct {
// Specifies one of the coordinates (file) at which the replica should begin
// reading the source's log. As this value specifies the point where replication
// starts from, it is only used once, when it starts. It is never used again,
// unless a new UpdateChannel operation modifies it.
LastConfiguredLogFilename *string `mandatory:"false" json:"lastConfiguredLogFilename"`
// Specifies one of the coordinates (offset) at which the replica should begin
// reading the source's log. As this value specifies the point where replication
// starts from, it is only used once, when it starts. It is never used again,
// unless a new UpdateChannel operation modifies it.
LastConfiguredLogOffset *int64 `mandatory:"false" json:"lastConfiguredLogOffset"`
// The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions
// coming from the source. You can change the UUID later.
Uuid *string `mandatory:"false" json:"uuid"`
}
func (m AssignManualUuidHandling) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AssignManualUuidHandling) String() string
func (m AssignManualUuidHandling) 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
AssignTargetUuidHandling Enables assignment of IDs on the target to anonymous transactions coming from the source. The target server UUID is added as a prefix to the ID.
type AssignTargetUuidHandling struct {
// Specifies one of the coordinates (file) at which the replica should begin
// reading the source's log. As this value specifies the point where replication
// starts from, it is only used once, when it starts. It is never used again,
// unless a new UpdateChannel operation modifies it.
LastConfiguredLogFilename *string `mandatory:"false" json:"lastConfiguredLogFilename"`
// Specifies one of the coordinates (offset) at which the replica should begin
// reading the source's log. As this value specifies the point where replication
// starts from, it is only used once, when it starts. It is never used again,
// unless a new UpdateChannel operation modifies it.
LastConfiguredLogOffset *int64 `mandatory:"false" json:"lastConfiguredLogOffset"`
}
func (m AssignTargetUuidHandling) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AssignTargetUuidHandling) String() string
func (m AssignTargetUuidHandling) 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
Backup A full or incremental copy of a DB System which can be used to create a new DB System or recover a DB System. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
type Backup struct {
// OCID of the backup itself
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the backup record was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time at which the backup was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The state of the backup.
LifecycleState BackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Additional information about the current lifecycleState.
LifecycleDetails *string `mandatory:"true" json:"lifecycleDetails"`
// The type of backup.
BackupType BackupBackupTypeEnum `mandatory:"true" json:"backupType"`
// Indicates how the backup was created: manually, automatic, or by an Operator.
CreationType BackupCreationTypeEnum `mandatory:"true" json:"creationType"`
// The OCID of the DB System the backup is associated with.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// A user-supplied display name for the backup.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user-supplied description for the backup.
Description *string `mandatory:"false" json:"description"`
DbSystemSnapshot *DbSystemSnapshot `mandatory:"false" json:"dbSystemSnapshot"`
// The size of the backup in base-2 (IEC) gibibytes. (GiB).
BackupSizeInGBs *int `mandatory:"false" json:"backupSizeInGBs"`
// Number of days to retain this backup.
RetentionInDays *int `mandatory:"false" json:"retentionInDays"`
// Initial size of the data volume in GiBs.
DataStorageSizeInGBs *int `mandatory:"false" json:"dataStorageSizeInGBs"`
// The MySQL server version of the DB System used for backup.
MysqlVersion *string `mandatory:"false" json:"mysqlVersion"`
// The shape of the DB System used for backup.
ShapeName *string `mandatory:"false" json:"shapeName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Backup) String() string
func (m Backup) 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
BackupBackupTypeEnum Enum with underlying type: string
type BackupBackupTypeEnum string
Set of constants representing the allowable values for BackupBackupTypeEnum
const (
BackupBackupTypeFull BackupBackupTypeEnum = "FULL"
BackupBackupTypeIncremental BackupBackupTypeEnum = "INCREMENTAL"
)
func GetBackupBackupTypeEnumValues() []BackupBackupTypeEnum
GetBackupBackupTypeEnumValues Enumerates the set of values for BackupBackupTypeEnum
func GetMappingBackupBackupTypeEnum(val string) (BackupBackupTypeEnum, bool)
GetMappingBackupBackupTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BackupCreationTypeEnum Enum with underlying type: string
type BackupCreationTypeEnum string
Set of constants representing the allowable values for BackupCreationTypeEnum
const (
BackupCreationTypeManual BackupCreationTypeEnum = "MANUAL"
BackupCreationTypeAutomatic BackupCreationTypeEnum = "AUTOMATIC"
BackupCreationTypeOperator BackupCreationTypeEnum = "OPERATOR"
)
func GetBackupCreationTypeEnumValues() []BackupCreationTypeEnum
GetBackupCreationTypeEnumValues Enumerates the set of values for BackupCreationTypeEnum
func GetMappingBackupCreationTypeEnum(val string) (BackupCreationTypeEnum, bool)
GetMappingBackupCreationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BackupLifecycleStateEnum Enum with underlying type: string
type BackupLifecycleStateEnum string
Set of constants representing the allowable values for BackupLifecycleStateEnum
const (
BackupLifecycleStateCreating BackupLifecycleStateEnum = "CREATING"
BackupLifecycleStateActive BackupLifecycleStateEnum = "ACTIVE"
BackupLifecycleStateInactive BackupLifecycleStateEnum = "INACTIVE"
BackupLifecycleStateUpdating BackupLifecycleStateEnum = "UPDATING"
BackupLifecycleStateDeleting BackupLifecycleStateEnum = "DELETING"
BackupLifecycleStateDeleted BackupLifecycleStateEnum = "DELETED"
BackupLifecycleStateFailed BackupLifecycleStateEnum = "FAILED"
)
func GetBackupLifecycleStateEnumValues() []BackupLifecycleStateEnum
GetBackupLifecycleStateEnumValues Enumerates the set of values for BackupLifecycleStateEnum
func GetMappingBackupLifecycleStateEnum(val string) (BackupLifecycleStateEnum, bool)
GetMappingBackupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BackupPolicy The Backup policy for the DB System.
type BackupPolicy struct {
// If automated backups are enabled or disabled.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The start of a 30-minute window of time in which daily, automated backups occur.
// This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
// At some point in the window, the system may incur a brief service disruption as the backup is performed.
// If not defined, a window is selected from the following Region-based time-spans:
// - eu-frankfurt-1: 20:00 - 04:00 UTC
// - us-ashburn-1: 03:00 - 11:00 UTC
// - uk-london-1: 06:00 - 14:00 UTC
// - ap-tokyo-1: 13:00 - 21:00
// - us-phoenix-1: 06:00 - 14:00
WindowStartTime *string `mandatory:"true" json:"windowStartTime"`
// The number of days automated backups are retained.
RetentionInDays *int `mandatory:"true" json:"retentionInDays"`
// Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
PitrPolicy *PitrPolicy `mandatory:"false" json:"pitrPolicy"`
}
func (m BackupPolicy) String() string
func (m BackupPolicy) 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
BackupSummary Details of Backups such as OCID, description, backupType, and so on. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
type BackupSummary struct {
// OCID of the backup.
Id *string `mandatory:"true" json:"id"`
// The time the backup was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The state of the backup.
LifecycleState BackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The type of backup.
BackupType BackupBackupTypeEnum `mandatory:"true" json:"backupType"`
// If the backup was created automatically, or by a manual request.
CreationType BackupCreationTypeEnum `mandatory:"true" json:"creationType"`
// The OCID of the DB System the Backup is associated with.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The OCID of the compartment the backup exists in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-supplied display name for the backup.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user-supplied description of the backup.
Description *string `mandatory:"false" json:"description"`
// Size of the data volume in GiBs.
DataStorageSizeInGBs *int `mandatory:"false" json:"dataStorageSizeInGBs"`
// The size of the backup in GiBs.
BackupSizeInGBs *int `mandatory:"false" json:"backupSizeInGBs"`
// Number of days to retain this backup.
RetentionInDays *int `mandatory:"false" json:"retentionInDays"`
// The version of the DB System used for backup.
MysqlVersion *string `mandatory:"false" json:"mysqlVersion"`
// The shape of the DB System instance used for backup.
ShapeName *string `mandatory:"false" json:"shapeName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m BackupSummary) String() string
func (m BackupSummary) 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
CaCertificate The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes.
type CaCertificate interface {
}
CaCertificateCertificateTypeEnum Enum with underlying type: string
type CaCertificateCertificateTypeEnum string
Set of constants representing the allowable values for CaCertificateCertificateTypeEnum
const (
CaCertificateCertificateTypePem CaCertificateCertificateTypeEnum = "PEM"
)
func GetCaCertificateCertificateTypeEnumValues() []CaCertificateCertificateTypeEnum
GetCaCertificateCertificateTypeEnumValues Enumerates the set of values for CaCertificateCertificateTypeEnum
func GetMappingCaCertificateCertificateTypeEnum(val string) (CaCertificateCertificateTypeEnum, bool)
GetMappingCaCertificateCertificateTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeBackupCompartmentDetails OCID of the target compartment for DB System Backup change compartment request.
type ChangeBackupCompartmentDetails struct {
// OCID of the target compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeBackupCompartmentDetails) String() string
func (m ChangeBackupCompartmentDetails) 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
ChangeBackupCompartmentRequest wrapper for the ChangeBackupCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ChangeBackupCompartment.go.html to see an example of how to use ChangeBackupCompartmentRequest.
type ChangeBackupCompartmentRequest struct {
// The OCID of the Backup
BackupId *string `mandatory:"true" contributesTo:"path" name:"backupId"`
// Target compartment for a DB System Backup.
ChangeBackupCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `If-Match` header 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"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 ChangeBackupCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBackupCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBackupCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBackupCompartmentRequest) String() string
func (request ChangeBackupCompartmentRequest) 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
ChangeBackupCompartmentResponse wrapper for the ChangeBackupCompartment operation
type ChangeBackupCompartmentResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ChangeBackupCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBackupCompartmentResponse) String() string
Channel A Channel connecting a DB System to an external entity.
type Channel struct {
// The OCID of the Channel.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The user-friendly name for the Channel. It does not have to be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// Whether the Channel has been enabled by the user.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
Source ChannelSource `mandatory:"true" json:"source"`
Target ChannelTarget `mandatory:"true" json:"target"`
// The state of the Channel.
LifecycleState ChannelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the Channel was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the Channel was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// User provided description of the Channel.
Description *string `mandatory:"false" json:"description"`
// A message describing the state of the Channel.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Channel) String() string
func (m *Channel) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Channel) 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
ChannelFilter Replication filter rule for a channel.
type ChannelFilter struct {
// The type of the filter rule.
// For details on each type, see
// Replication Filtering Rules (https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html)
Type ChannelFilterTypeEnum `mandatory:"true" json:"type"`
// The body of the filter rule. This can represent a database, a table, or a database pair (represented as
// "db1->db2"). For more information, see
// Replication Filtering Rules (https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html).
Value *string `mandatory:"true" json:"value"`
}
func (m ChannelFilter) String() string
func (m ChannelFilter) 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
ChannelFilterTypeEnum Enum with underlying type: string
type ChannelFilterTypeEnum string
Set of constants representing the allowable values for ChannelFilterTypeEnum
const (
ChannelFilterTypeDoDb ChannelFilterTypeEnum = "REPLICATE_DO_DB"
ChannelFilterTypeIgnoreDb ChannelFilterTypeEnum = "REPLICATE_IGNORE_DB"
ChannelFilterTypeDoTable ChannelFilterTypeEnum = "REPLICATE_DO_TABLE"
ChannelFilterTypeIgnoreTable ChannelFilterTypeEnum = "REPLICATE_IGNORE_TABLE"
ChannelFilterTypeWildDoTable ChannelFilterTypeEnum = "REPLICATE_WILD_DO_TABLE"
ChannelFilterTypeWildIgnoreTable ChannelFilterTypeEnum = "REPLICATE_WILD_IGNORE_TABLE"
ChannelFilterTypeRewriteDb ChannelFilterTypeEnum = "REPLICATE_REWRITE_DB"
)
func GetChannelFilterTypeEnumValues() []ChannelFilterTypeEnum
GetChannelFilterTypeEnumValues Enumerates the set of values for ChannelFilterTypeEnum
func GetMappingChannelFilterTypeEnum(val string) (ChannelFilterTypeEnum, bool)
GetMappingChannelFilterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChannelLifecycleStateEnum Enum with underlying type: string
type ChannelLifecycleStateEnum string
Set of constants representing the allowable values for ChannelLifecycleStateEnum
const (
ChannelLifecycleStateCreating ChannelLifecycleStateEnum = "CREATING"
ChannelLifecycleStateActive ChannelLifecycleStateEnum = "ACTIVE"
ChannelLifecycleStateNeedsAttention ChannelLifecycleStateEnum = "NEEDS_ATTENTION"
ChannelLifecycleStateInactive ChannelLifecycleStateEnum = "INACTIVE"
ChannelLifecycleStateUpdating ChannelLifecycleStateEnum = "UPDATING"
ChannelLifecycleStateDeleting ChannelLifecycleStateEnum = "DELETING"
ChannelLifecycleStateDeleted ChannelLifecycleStateEnum = "DELETED"
ChannelLifecycleStateFailed ChannelLifecycleStateEnum = "FAILED"
)
func GetChannelLifecycleStateEnumValues() []ChannelLifecycleStateEnum
GetChannelLifecycleStateEnumValues Enumerates the set of values for ChannelLifecycleStateEnum
func GetMappingChannelLifecycleStateEnum(val string) (ChannelLifecycleStateEnum, bool)
GetMappingChannelLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ChannelSource Parameters detailing how to provision the source for the given Channel.
type ChannelSource interface {
}
ChannelSourceMysql Core properties of a Mysql Channel source.
type ChannelSourceMysql struct {
// The network address of the MySQL instance.
Hostname *string `mandatory:"true" json:"hostname"`
// The port the source MySQL instance listens on.
Port *int `mandatory:"true" json:"port"`
// The name of the replication user on the source MySQL instance.
// The username has a maximum length of 96 characters. For more information,
// please see the MySQL documentation (https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html)
Username *string `mandatory:"true" json:"username"`
SslCaCertificate CaCertificate `mandatory:"false" json:"sslCaCertificate"`
AnonymousTransactionsHandling AnonymousTransactionsHandling `mandatory:"false" json:"anonymousTransactionsHandling"`
// The SSL mode of the Channel.
SslMode ChannelSourceMysqlSslModeEnum `mandatory:"true" json:"sslMode"`
}
func (m ChannelSourceMysql) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ChannelSourceMysql) String() string
func (m *ChannelSourceMysql) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ChannelSourceMysql) 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
ChannelSourceMysqlSslModeEnum Enum with underlying type: string
type ChannelSourceMysqlSslModeEnum string
Set of constants representing the allowable values for ChannelSourceMysqlSslModeEnum
const (
ChannelSourceMysqlSslModeVerifyIdentity ChannelSourceMysqlSslModeEnum = "VERIFY_IDENTITY"
ChannelSourceMysqlSslModeVerifyCa ChannelSourceMysqlSslModeEnum = "VERIFY_CA"
ChannelSourceMysqlSslModeRequired ChannelSourceMysqlSslModeEnum = "REQUIRED"
ChannelSourceMysqlSslModeDisabled ChannelSourceMysqlSslModeEnum = "DISABLED"
)
func GetChannelSourceMysqlSslModeEnumValues() []ChannelSourceMysqlSslModeEnum
GetChannelSourceMysqlSslModeEnumValues Enumerates the set of values for ChannelSourceMysqlSslModeEnum
func GetMappingChannelSourceMysqlSslModeEnum(val string) (ChannelSourceMysqlSslModeEnum, bool)
GetMappingChannelSourceMysqlSslModeEnum performs case Insensitive comparison on enum value and return the desired enum
ChannelSourceSourceTypeEnum Enum with underlying type: string
type ChannelSourceSourceTypeEnum string
Set of constants representing the allowable values for ChannelSourceSourceTypeEnum
const (
ChannelSourceSourceTypeMysql ChannelSourceSourceTypeEnum = "MYSQL"
)
func GetChannelSourceSourceTypeEnumValues() []ChannelSourceSourceTypeEnum
GetChannelSourceSourceTypeEnumValues Enumerates the set of values for ChannelSourceSourceTypeEnum
func GetMappingChannelSourceSourceTypeEnum(val string) (ChannelSourceSourceTypeEnum, bool)
GetMappingChannelSourceSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChannelSummary Summary of a Channel.
type ChannelSummary struct {
// The OCID of the Channel.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Whether the Channel has been enabled by the user.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
Source ChannelSource `mandatory:"true" json:"source"`
Target ChannelTarget `mandatory:"true" json:"target"`
// The state of the Channel.
LifecycleState ChannelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The user-friendly name for the Channel. It does not have to be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time the Channel was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the Channel was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// A message describing the state of the Channel.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ChannelSummary) String() string
func (m *ChannelSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ChannelSummary) 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
ChannelTarget Details about the Channel target.
type ChannelTarget interface {
}
ChannelTargetDbSystem Core properties of a DB System Channel target.
type ChannelTargetDbSystem struct {
// The OCID of the source DB System.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The case-insensitive name that identifies the replication channel. Channel names
// must follow the rules defined for MySQL identifiers (https://dev.mysql.com/doc/refman/8.0/en/identifiers.html).
// The names of non-Deleted Channels must be unique for each DB System.
ChannelName *string `mandatory:"true" json:"channelName"`
// The username for the replication applier of the target MySQL DB System.
ApplierUsername *string `mandatory:"true" json:"applierUsername"`
// Specifies the amount of time, in seconds, that the channel waits before
// applying a transaction received from the source.
DelayInSeconds *int `mandatory:"true" json:"delayInSeconds"`
// Replication filter rules to be applied at the DB System Channel target.
Filters []ChannelFilter `mandatory:"false" json:"filters"`
// Specifies how a replication channel handles the creation and alteration of tables
// that do not have a primary key.
TablesWithoutPrimaryKeyHandling ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum `mandatory:"true" json:"tablesWithoutPrimaryKeyHandling"`
}
func (m ChannelTargetDbSystem) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ChannelTargetDbSystem) String() string
func (m ChannelTargetDbSystem) 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
ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum Enum with underlying type: string
type ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum string
Set of constants representing the allowable values for ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum
const (
ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingRaiseError ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum = "RAISE_ERROR"
ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingAllow ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum = "ALLOW"
ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingGenerateImplicitPrimaryKey ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum = "GENERATE_IMPLICIT_PRIMARY_KEY"
)
func GetChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnumValues() []ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum
GetChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnumValues Enumerates the set of values for ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum
func GetMappingChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum(val string) (ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum, bool)
GetMappingChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum performs case Insensitive comparison on enum value and return the desired enum
ChannelTargetTargetTypeEnum Enum with underlying type: string
type ChannelTargetTargetTypeEnum string
Set of constants representing the allowable values for ChannelTargetTargetTypeEnum
const (
ChannelTargetTargetTypeDbsystem ChannelTargetTargetTypeEnum = "DBSYSTEM"
)
func GetChannelTargetTargetTypeEnumValues() []ChannelTargetTargetTypeEnum
GetChannelTargetTargetTypeEnumValues Enumerates the set of values for ChannelTargetTargetTypeEnum
func GetMappingChannelTargetTargetTypeEnum(val string) (ChannelTargetTargetTypeEnum, bool)
GetMappingChannelTargetTargetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChannelsClient a client for Channels
type ChannelsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewChannelsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ChannelsClient, err error)
NewChannelsClientWithConfigurationProvider Creates a new default Channels client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewChannelsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ChannelsClient, err error)
NewChannelsClientWithOboToken Creates a new default Channels 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 *ChannelsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ChannelsClient) CreateChannel(ctx context.Context, request CreateChannelRequest) (response CreateChannelResponse, err error)
CreateChannel Creates a Channel to establish replication from a source to a target.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateChannel.go.html to see an example of how to use CreateChannel API. A default retry strategy applies to this operation CreateChannel()
func (client ChannelsClient) DeleteChannel(ctx context.Context, request DeleteChannelRequest) (response DeleteChannelResponse, err error)
DeleteChannel Deletes the specified Channel.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteChannel.go.html to see an example of how to use DeleteChannel API. A default retry strategy applies to this operation DeleteChannel()
func (client ChannelsClient) GetChannel(ctx context.Context, request GetChannelRequest) (response GetChannelResponse, err error)
GetChannel Gets the full details of the specified Channel, including the user-specified configuration parameters (passwords are omitted), as well as information about the state of the Channel, its sources and targets.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetChannel.go.html to see an example of how to use GetChannel API. A default retry strategy applies to this operation GetChannel()
func (client ChannelsClient) ListChannels(ctx context.Context, request ListChannelsRequest) (response ListChannelsResponse, err error)
ListChannels Lists all the Channels that match the specified filters.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListChannels.go.html to see an example of how to use ListChannels API. A default retry strategy applies to this operation ListChannels()
func (client ChannelsClient) ResetChannel(ctx context.Context, request ResetChannelRequest) (response ResetChannelResponse, err error)
ResetChannel Resets the specified Channel by purging its cached information, leaving the Channel as if it had just been created. This operation is only accepted in Inactive Channels.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ResetChannel.go.html to see an example of how to use ResetChannel API. A default retry strategy applies to this operation ResetChannel()
func (client ChannelsClient) ResumeChannel(ctx context.Context, request ResumeChannelRequest) (response ResumeChannelResponse, err error)
ResumeChannel Resumes an enabled Channel that has become Inactive due to an error. The resume operation requires that the error that cause the Channel to become Inactive has already been fixed, otherwise the operation may fail.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ResumeChannel.go.html to see an example of how to use ResumeChannel API. A default retry strategy applies to this operation ResumeChannel()
func (client *ChannelsClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ChannelsClient) UpdateChannel(ctx context.Context, request UpdateChannelRequest) (response UpdateChannelResponse, err error)
UpdateChannel Updates the properties of the specified Channel. If the Channel is Active the Update operation will asynchronously apply the new configuration parameters to the Channel and the Channel may become temporarily unavailable. Otherwise, the new configuration will be applied the next time the Channel becomes Active.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/UpdateChannel.go.html to see an example of how to use UpdateChannel API. A default retry strategy applies to this operation UpdateChannel()
Configuration The set of MySQL variables to be used when deploying a MySQL Database Service DB System.
type Configuration struct {
// The OCID of the Configuration.
Id *string `mandatory:"true" json:"id"`
// OCID of the Compartment the Configuration exists in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the associated Shape.
ShapeName *string `mandatory:"true" json:"shapeName"`
// The Configuration type, DEFAULT or CUSTOM.
Type ConfigurationTypeEnum `mandatory:"true" json:"type"`
// The date and time the Configuration was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the Configuration was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the Configuration.
LifecycleState ConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
Variables *ConfigurationVariables `mandatory:"true" json:"variables"`
// User-provided data about the Configuration.
Description *string `mandatory:"false" json:"description"`
// The display name of the Configuration.
DisplayName *string `mandatory:"false" json:"displayName"`
InitVariables *InitializationVariables `mandatory:"false" json:"initVariables"`
// The OCID of the Configuration from which this Configuration is
// "derived". This is entirely a metadata relationship. There is no
// relation between the values in this Configuration and its parent.
ParentConfigurationId *string `mandatory:"false" json:"parentConfigurationId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Configuration) String() string
func (m Configuration) 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
ConfigurationLifecycleStateEnum Enum with underlying type: string
type ConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for ConfigurationLifecycleStateEnum
const (
ConfigurationLifecycleStateActive ConfigurationLifecycleStateEnum = "ACTIVE"
ConfigurationLifecycleStateDeleted ConfigurationLifecycleStateEnum = "DELETED"
)
func GetConfigurationLifecycleStateEnumValues() []ConfigurationLifecycleStateEnum
GetConfigurationLifecycleStateEnumValues Enumerates the set of values for ConfigurationLifecycleStateEnum
func GetMappingConfigurationLifecycleStateEnum(val string) (ConfigurationLifecycleStateEnum, bool)
GetMappingConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigurationSummary The general details of a Configuration such as its id, displayName, type, and shape association.
type ConfigurationSummary struct {
// The OCID of the Configuration.
Id *string `mandatory:"true" json:"id"`
// OCID of the Compartment the Configuration exists in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the associated Shape.
ShapeName *string `mandatory:"true" json:"shapeName"`
// The Configuration type, DEFAULT or CUSTOM
Type ConfigurationTypeEnum `mandatory:"true" json:"type"`
// The current state of the Configuration.
LifecycleState ConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// User-provided data about the Configuration.
Description *string `mandatory:"false" json:"description"`
// The display name of the Configuration.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time the Configuration was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the Configuration was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ConfigurationSummary) String() string
func (m ConfigurationSummary) 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
ConfigurationTypeEnum Enum with underlying type: string
type ConfigurationTypeEnum string
Set of constants representing the allowable values for ConfigurationTypeEnum
const (
ConfigurationTypeDefault ConfigurationTypeEnum = "DEFAULT"
ConfigurationTypeCustom ConfigurationTypeEnum = "CUSTOM"
)
func GetConfigurationTypeEnumValues() []ConfigurationTypeEnum
GetConfigurationTypeEnumValues Enumerates the set of values for ConfigurationTypeEnum
func GetMappingConfigurationTypeEnum(val string) (ConfigurationTypeEnum, bool)
GetMappingConfigurationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigurationVariables User-defined service variables.
type ConfigurationVariables struct {
// ("completion_type")
CompletionType ConfigurationVariablesCompletionTypeEnum `mandatory:"false" json:"completionType,omitempty"`
// If enabled, the server stores all temporary tables on disk rather than in memory.
// bigTables corresponds to the MySQL server variable big_tables (https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_big_tables).
BigTables *bool `mandatory:"false" json:"bigTables"`
// Set the chunking size for updates to the global memory usage counter Global_connection_memory.
// connectionMemoryChunkSize corresponds to the MySQL system variable connection_memory_chunk_size (https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_connection_memory_chunk_size).
ConnectionMemoryChunkSize *int `mandatory:"false" json:"connectionMemoryChunkSize"`
// Set the maximum amount of memory that can be used by a single user connection.
// connectionMemoryLimit corresponds to the MySQL system variable connection_memory_limit (https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_connection_memory_limit).
ConnectionMemoryLimit *int64 `mandatory:"false" json:"connectionMemoryLimit"`
// ("default_authentication_plugin")
DefaultAuthenticationPlugin ConfigurationVariablesDefaultAuthenticationPluginEnum `mandatory:"false" json:"defaultAuthenticationPlugin,omitempty"`
// Set the total amount of memory that can be used by all user connections.
// globalConnectionMemoryLimit corresponds to the MySQL system variable global_connection_memory_limit (https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_global_connection_memory_limit).
GlobalConnectionMemoryLimit *int64 `mandatory:"false" json:"globalConnectionMemoryLimit"`
// Determines whether the MySQL server calculates Global_connection_memory.
// globalConnectionMemoryTracking corresponds to the MySQL system variable global_connection_memory_tracking (https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_global_connection_memory_tracking).
GlobalConnectionMemoryTracking *bool `mandatory:"false" json:"globalConnectionMemoryTracking"`
// ("transaction_isolation")
TransactionIsolation ConfigurationVariablesTransactionIsolationEnum `mandatory:"false" json:"transactionIsolation,omitempty"`
// ("innodb_ft_server_stopword_table")
InnodbFtServerStopwordTable *string `mandatory:"false" json:"innodbFtServerStopwordTable"`
// ("mandatory_roles")
MandatoryRoles *string `mandatory:"false" json:"mandatoryRoles"`
// ("autocommit")
Autocommit *bool `mandatory:"false" json:"autocommit"`
// ("foreign_key_checks")
ForeignKeyChecks *bool `mandatory:"false" json:"foreignKeyChecks"`
// - EVENTUAL:
// Both RO and RW transactions do not wait for preceding transactions to be applied before executing.
// A RW transaction does not wait for other members to apply a transaction. This means that a transaction
// could be externalized on one member before the others. This also means that in the event of a primary failover,
// the new primary can accept new RO and RW transactions before the previous primary transactions are all applied.
// RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts.
// - BEFORE_ON_PRIMARY_FAILOVER:
// New RO or RW transactions with a newly elected primary that is applying backlog from the old
// primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens,
// intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that
// clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal,
// but does depend on the size of the backlog.
// - BEFORE:
// A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding
// transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the
// latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is
// used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER.
// - AFTER:
// A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions.
// This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or
// a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that
// applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent
// reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction,
// by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees
// provided by BEFORE_ON_PRIMARY_FAILOVER.
// - BEFORE_AND_AFTER:
// A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been
// applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place.
// This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER.
GroupReplicationConsistency ConfigurationVariablesGroupReplicationConsistencyEnum `mandatory:"false" json:"groupReplicationConsistency,omitempty"`
// ("innodb_ft_enable_stopword")
InnodbFtEnableStopword *bool `mandatory:"false" json:"innodbFtEnableStopword"`
// Enables dedicated log writer threads for writing redo log records from the log buffer to the system buffers and flushing the system buffers to the redo log files.
// This is the MySQL variable "innodb_log_writer_threads". For more information, please see the MySQL documentation (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_log_writer_threads)
InnodbLogWriterThreads *bool `mandatory:"false" json:"innodbLogWriterThreads"`
// ("local_infile")
LocalInfile *bool `mandatory:"false" json:"localInfile"`
// ("mysql_firewall_mode")
MysqlFirewallMode *bool `mandatory:"false" json:"mysqlFirewallMode"`
// ("mysqlx_enable_hello_notice") DEPRECATED -- variable should not be settable and will be ignored
MysqlxEnableHelloNotice *bool `mandatory:"false" json:"mysqlxEnableHelloNotice"`
// ("sql_require_primary_key")
SqlRequirePrimaryKey *bool `mandatory:"false" json:"sqlRequirePrimaryKey"`
// ("sql_warnings")
SqlWarnings *bool `mandatory:"false" json:"sqlWarnings"`
// Sets the binary log expiration period in seconds.
// binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable binlog_expire_logs_seconds (https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_expire_logs_seconds).
BinlogExpireLogsSeconds *int `mandatory:"false" json:"binlogExpireLogsSeconds"`
// Configures the amount of table metadata added to the binary log when using row-based logging.
// binlogRowMetadata corresponds to the MySQL binary logging system variable binlog_row_metadata (https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_metadata).
BinlogRowMetadata ConfigurationVariablesBinlogRowMetadataEnum `mandatory:"false" json:"binlogRowMetadata,omitempty"`
// When set to PARTIAL_JSON, this enables use of a space-efficient binary log format for updates that modify only a small portion of a JSON document.
// binlogRowValueOptions corresponds to the MySQL binary logging system variable binlog_row_value_options (https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_value_options).
BinlogRowValueOptions *string `mandatory:"false" json:"binlogRowValueOptions"`
// Enables compression for transactions that are written to binary log files on this server.
// binlogTransactionCompression corresponds to the MySQL binary logging system variable binlog_transaction_compression (https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_transaction_compression).
BinlogTransactionCompression *bool `mandatory:"false" json:"binlogTransactionCompression"`
// The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data.
// innodbBufferPoolSize corresponds to the MySQL server system variable
// innodb_buffer_pool_size (https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_buffer_pool_size).
// The default and maximum values depend on the amount of RAM provisioned by the shape.
// See Default User Variables (https://docs.cloud.oracle.com/mysql-database/doc/configuring-db-system.html#GUID-B5504C19-F6F4-4DAB-8506-189A4E8F4A6A).
InnodbBufferPoolSize *int64 `mandatory:"false" json:"innodbBufferPoolSize"`
// ("innodb_ft_result_cache_limit")
InnodbFtResultCacheLimit *int64 `mandatory:"false" json:"innodbFtResultCacheLimit"`
// Sets the size of the transaction cache.
// maxBinlogCacheSize corresponds to the MySQL server system variable max_binlog_cache_size (https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_max_binlog_cache_size).
MaxBinlogCacheSize *int64 `mandatory:"false" json:"maxBinlogCacheSize"`
// ("max_connect_errors")
MaxConnectErrors *int64 `mandatory:"false" json:"maxConnectErrors"`
// This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.
// maxHeapTableSize corresponds to the MySQL system variable
// max_heap_table_size (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_heap_table_size)
MaxHeapTableSize *int64 `mandatory:"false" json:"maxHeapTableSize"`
// ("max_connections")
MaxConnections *int `mandatory:"false" json:"maxConnections"`
// ("max_prepared_stmt_count")
MaxPreparedStmtCount *int `mandatory:"false" json:"maxPreparedStmtCount"`
// The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake.
// connectTimeout corresponds to the MySQL system variable
// connect_timeout (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_connect_timeout)
// Increasing the connect_timeout value might help if clients frequently encounter errors of the form
// "Lost connection to MySQL server at 'XXX', system error: errno".
ConnectTimeout *int `mandatory:"false" json:"connectTimeout"`
// ("cte_max_recursion_depth")
CteMaxRecursionDepth *int64 `mandatory:"false" json:"cteMaxRecursionDepth"`
// ("generated_random_password_length") DEPRECATED -- variable should not be settable and will be ignored
GeneratedRandomPasswordLength *int `mandatory:"false" json:"generatedRandomPasswordLength"`
// ("information_schema_stats_expiry")
InformationSchemaStatsExpiry *int `mandatory:"false" json:"informationSchemaStatsExpiry"`
// Specifies the percentage of the most recently used pages for each buffer pool to read out and dump.
// innodbBufferPoolDumpPct corresponds to the MySQL InnoDB system variable
// innodb_buffer_pool_dump_pct (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_buffer_pool_dump_pct).
// The range is 1 to 100. The default value is 25.
// For example, if there are 4 buffer pools with 100 pages each, and innodb_buffer_pool_dump_pct is set to 25,
// the 25 most recently used pages from each buffer pool are dumped.
InnodbBufferPoolDumpPct *int `mandatory:"false" json:"innodbBufferPoolDumpPct"`
// ("innodb_buffer_pool_instances")
InnodbBufferPoolInstances *int `mandatory:"false" json:"innodbBufferPoolInstances"`
// innodbDdlBufferSize corresponds to the MySQL system variable innodb_ddl_buffer_size (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_buffer_size)
InnodbDdlBufferSize *int64 `mandatory:"false" json:"innodbDdlBufferSize"`
// innodbDdlThreads corresponds to the MySQL system variable innodb_ddl_threads (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_threads)
InnodbDdlThreads *int `mandatory:"false" json:"innodbDdlThreads"`
// ("innodb_ft_max_token_size")
InnodbFtMaxTokenSize *int `mandatory:"false" json:"innodbFtMaxTokenSize"`
// ("innodb_ft_min_token_size")
InnodbFtMinTokenSize *int `mandatory:"false" json:"innodbFtMinTokenSize"`
// ("innodb_ft_num_word_optimize")
InnodbFtNumWordOptimize *int `mandatory:"false" json:"innodbFtNumWordOptimize"`
// ("innodb_lock_wait_timeout")
InnodbLockWaitTimeout *int `mandatory:"false" json:"innodbLockWaitTimeout"`
// The desired maximum purge lag in terms of transactions.
// InnoDB maintains a list of transactions that have index records delete-marked by UPDATE or DELETE operations. The length of the list is the purge lag.
// If this value is exceeded, a delay is imposed on INSERT, UPDATE, and DELETE operations to allow time for purge to catch up.
// The default value is 0, which means there is no maximum purge lag and no delay.
// innodbMaxPurgeLag corresponds to the MySQL server system variable
// innodb_max_purge_lag (https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_max_purge_lag).
InnodbMaxPurgeLag *int64 `mandatory:"false" json:"innodbMaxPurgeLag"`
// The maximum delay in microseconds for the delay imposed when the innodb_max_purge_lag threshold is exceeded.
// The specified innodb_max_purge_lag_delay value is an upper limit on the delay period.
// innodbMaxPurgeLagDelay corresponds to the MySQL server system variable
// innodb_max_purge_lag_delay (https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_max_purge_lag_delay).
InnodbMaxPurgeLagDelay *int `mandatory:"false" json:"innodbMaxPurgeLagDelay"`
// The number of seconds the server waits for activity on an interactive connection before closing it.
// interactiveTimeout corresponds to the MySQL system variable.
// interactive_timeout (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_interactive_timeout)
InteractiveTimeout *int `mandatory:"false" json:"interactiveTimeout"`
// The number of index pages to sample when estimating cardinality and other statistics for an indexed column,
// such as those calculated by ANALYZE TABLE.
// innodbStatsPersistentSamplePages corresponds to the MySQL InnoDB system variable
// innodb_stats_persistent_sample_pages (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_stats_persistent_sample_pages)
// innodb_stats_persistent_sample_pages only applies when innodb_stats_persistent is enabled for a table;
// when innodb_stats_persistent is disabled, innodb_stats_transient_sample_pages applies instead.
InnodbStatsPersistentSamplePages *int64 `mandatory:"false" json:"innodbStatsPersistentSamplePages"`
// The number of index pages to sample when estimating cardinality and other statistics for an indexed column,
// such as those calculated by ANALYZE TABLE (https://dev.mysql.com/doc/refman/8.0/en/analyze-table.html).
// innodbStatsTransientSamplePages corresponds to the MySQL InnoDB system variable
// innodb_stats_transient_sample_pages (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_stats_transient_sample_pages)
// innodb_stats_transient_sample_pages only applies when innodb_stats_persistent is disabled for a table;
// when innodb_stats_persistent is enabled, innodb_stats_persistent_sample_pages applies instead.
// innodb_stats_persistent is ON by default and cannot be changed. It is possible to override it using the
// STATS_PERSISTENT clause of the CREATE TABLE (https://dev.mysql.com/doc/refman/8.0/en/create-table.html) and
// ALTER TABLE (https://dev.mysql.com/doc/refman/8.0/en/alter-table.html) statements.
InnodbStatsTransientSamplePages *int64 `mandatory:"false" json:"innodbStatsTransientSamplePages"`
// The maximum size of one packet or any generated/intermediate string.
// This is the mysql variable "max_allowed_packet".
MaxAllowedPacket *int `mandatory:"false" json:"maxAllowedPacket"`
// ("max_execution_time")
MaxExecutionTime *int64 `mandatory:"false" json:"maxExecutionTime"`
// The number of seconds X Plugin waits for the first packet to be received from newly connected clients.
// mysqlxConnectTimeout corresponds to the MySQL X Plugin system variable
// mysqlx_connect_timeout (https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_connect_timeout)
MysqlxConnectTimeout *int `mandatory:"false" json:"mysqlxConnectTimeout"`
// ("mysqlx_document_id_unique_prefix") DEPRECATED -- variable should not be settable and will be ignored
MysqlxDocumentIdUniquePrefix *int `mandatory:"false" json:"mysqlxDocumentIdUniquePrefix"`
// ("mysqlx_idle_worker_thread_timeout") DEPRECATED -- variable should not be settable and will be ignored
MysqlxIdleWorkerThreadTimeout *int `mandatory:"false" json:"mysqlxIdleWorkerThreadTimeout"`
// The number of seconds to wait for interactive clients to timeout.
// mysqlxInteractiveTimeout corresponds to the MySQL X Plugin system variable.
// mysqlx_interactive_timeout (https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_interactive_timeout)
MysqlxInteractiveTimeout *int `mandatory:"false" json:"mysqlxInteractiveTimeout"`
// The maximum size of network packets that can be received by X Plugin.
// This is the mysql variable "mysqlx_max_allowed_packet".
MysqlxMaxAllowedPacket *int `mandatory:"false" json:"mysqlxMaxAllowedPacket"`
// ("mysqlx_min_worker_threads") DEPRECATED -- variable should not be settable and will be ignored
MysqlxMinWorkerThreads *int `mandatory:"false" json:"mysqlxMinWorkerThreads"`
// The number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the
// read operation is not successful, X Plugin closes the connection and returns a warning notice with the error
// code ER_IO_READ_ERROR to the client application.
// mysqlxReadTimeout corresponds to the MySQL X Plugin system variable
// mysqlx_read_timeout (https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_read_timeout)
MysqlxReadTimeout *int `mandatory:"false" json:"mysqlxReadTimeout"`
// The number of seconds that X Plugin waits for activity on a connection.
// mysqlxWaitTimeout corresponds to the MySQL X Plugin system variable.
// mysqlx_wait_timeout (https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_wait_timeout)
MysqlxWaitTimeout *int `mandatory:"false" json:"mysqlxWaitTimeout"`
// The number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the
// write operation is not successful, X Plugin closes the connection.
// mysqlxReadmysqlxWriteTimeoutTimeout corresponds to the MySQL X Plugin system variable
// mysqlx_write_timeout (https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_write_timeout)
MysqlxWriteTimeout *int `mandatory:"false" json:"mysqlxWriteTimeout"`
// The number of seconds to wait for more data from a connection before aborting the read.
// netReadTimeout corresponds to the MySQL system variable
// net_read_timeout (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_net_read_timeout)
NetReadTimeout *int `mandatory:"false" json:"netReadTimeout"`
// The number of seconds to wait for a block to be written to a connection before aborting the write.
// netWriteTimeout corresponds to the MySQL system variable
// net_write_timeout (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_net_write_timeout)
NetWriteTimeout *int `mandatory:"false" json:"netWriteTimeout"`
// ("parser_max_mem_size")
ParserMaxMemSize *int64 `mandatory:"false" json:"parserMaxMemSize"`
// ("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored
QueryAllocBlockSize *int64 `mandatory:"false" json:"queryAllocBlockSize"`
// ("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored
QueryPreallocSize *int64 `mandatory:"false" json:"queryPreallocSize"`
// regexpTimeLimit corresponds to the MySQL system variable regexp_time_limit (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_regexp_time_limit)
RegexpTimeLimit *int `mandatory:"false" json:"regexpTimeLimit"`
// ("sql_mode")
SqlMode *string `mandatory:"false" json:"sqlMode"`
// The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables.
// tmp_table_size corresponds to the MySQL system variable
// tmp_table_size (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_tmp_table_size)
TmpTableSize *int64 `mandatory:"false" json:"tmpTableSize"`
// Set the default compression level for the deflate algorithm. ("mysqlx_deflate_default_compression_level")
MysqlxDeflateDefaultCompressionLevel *int `mandatory:"false" json:"mysqlxDeflateDefaultCompressionLevel"`
// Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlx_deflate_max_client_compression_level")
MysqlxDeflateMaxClientCompressionLevel *int `mandatory:"false" json:"mysqlxDeflateMaxClientCompressionLevel"`
// Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlx_lz4_max_client_compression_level")
MysqlxLz4MaxClientCompressionLevel *int `mandatory:"false" json:"mysqlxLz4MaxClientCompressionLevel"`
// Set the default compression level for the lz4 algorithm. ("mysqlx_lz4_default_compression_level")
MysqlxLz4DefaultCompressionLevel *int `mandatory:"false" json:"mysqlxLz4DefaultCompressionLevel"`
// Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlx_zstd_max_client_compression_level")
MysqlxZstdMaxClientCompressionLevel *int `mandatory:"false" json:"mysqlxZstdMaxClientCompressionLevel"`
// Set the default compression level for the zstd algorithm. ("mysqlx_zstd_default_compression_level")
MysqlxZstdDefaultCompressionLevel *int `mandatory:"false" json:"mysqlxZstdDefaultCompressionLevel"`
// DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored.
MysqlZstdDefaultCompressionLevel *int `mandatory:"false" json:"mysqlZstdDefaultCompressionLevel"`
// Each session that must perform a sort allocates a buffer of this size.
// sortBufferSize corresponds to the MySQL system variable sort_buffer_size (https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_sort_buffer_size)
SortBufferSize *int64 `mandatory:"false" json:"sortBufferSize"`
// The number of seconds the server waits for activity on a noninteractive connection before closing it.
// waitTimeout corresponds to the MySQL system variable.
// wait_timeout (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_wait_timeout)
WaitTimeout *int `mandatory:"false" json:"waitTimeout"`
// Controls whether the thread pool uses dedicated listener threads. If enabled, a listener thread in each thread group is dedicated to the task of listening
// for network events from clients, ensuring that the maximum number of query worker threads is no more than the value specified by threadPoolMaxTransactionsLimit.
// threadPoolDedicatedListeners corresponds to the MySQL Database Service-specific system variable thread_pool_dedicated_listeners.
ThreadPoolDedicatedListeners *bool `mandatory:"false" json:"threadPoolDedicatedListeners"`
// Limits the maximum number of open transactions to the defined value. The default value is 0, which enforces no limit.
// threadPoolMaxTransactionsLimit corresponds to the MySQL Database Service-specific system variable thread_pool_max_transactions_limit.
ThreadPoolMaxTransactionsLimit *int `mandatory:"false" json:"threadPoolMaxTransactionsLimit"`
// Initializes the time zone for each client that connects.
// This corresponds to the MySQL System Variable "time_zone".
// The values can be given in one of the following formats, none of which are case-sensitive:
// - As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. The permitted range is '-13:59' to '+14:00', inclusive.
// - As a named time zone, as defined by the "IANA Time Zone database", such as 'Europe/Helsinki', 'US/Eastern', 'MET', or 'UTC'.
TimeZone *string `mandatory:"false" json:"timeZone"`
}
func (m ConfigurationVariables) String() string
func (m ConfigurationVariables) 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
ConfigurationVariablesBinlogRowMetadataEnum Enum with underlying type: string
type ConfigurationVariablesBinlogRowMetadataEnum string
Set of constants representing the allowable values for ConfigurationVariablesBinlogRowMetadataEnum
const (
ConfigurationVariablesBinlogRowMetadataFull ConfigurationVariablesBinlogRowMetadataEnum = "FULL"
ConfigurationVariablesBinlogRowMetadataMinimal ConfigurationVariablesBinlogRowMetadataEnum = "MINIMAL"
)
func GetConfigurationVariablesBinlogRowMetadataEnumValues() []ConfigurationVariablesBinlogRowMetadataEnum
GetConfigurationVariablesBinlogRowMetadataEnumValues Enumerates the set of values for ConfigurationVariablesBinlogRowMetadataEnum
func GetMappingConfigurationVariablesBinlogRowMetadataEnum(val string) (ConfigurationVariablesBinlogRowMetadataEnum, bool)
GetMappingConfigurationVariablesBinlogRowMetadataEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigurationVariablesCompletionTypeEnum Enum with underlying type: string
type ConfigurationVariablesCompletionTypeEnum string
Set of constants representing the allowable values for ConfigurationVariablesCompletionTypeEnum
const (
ConfigurationVariablesCompletionTypeNoChain ConfigurationVariablesCompletionTypeEnum = "NO_CHAIN"
ConfigurationVariablesCompletionTypeChain ConfigurationVariablesCompletionTypeEnum = "CHAIN"
ConfigurationVariablesCompletionTypeRelease ConfigurationVariablesCompletionTypeEnum = "RELEASE"
)
func GetConfigurationVariablesCompletionTypeEnumValues() []ConfigurationVariablesCompletionTypeEnum
GetConfigurationVariablesCompletionTypeEnumValues Enumerates the set of values for ConfigurationVariablesCompletionTypeEnum
func GetMappingConfigurationVariablesCompletionTypeEnum(val string) (ConfigurationVariablesCompletionTypeEnum, bool)
GetMappingConfigurationVariablesCompletionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigurationVariablesDefaultAuthenticationPluginEnum Enum with underlying type: string
type ConfigurationVariablesDefaultAuthenticationPluginEnum string
Set of constants representing the allowable values for ConfigurationVariablesDefaultAuthenticationPluginEnum
const (
ConfigurationVariablesDefaultAuthenticationPluginMysqlNativePassword ConfigurationVariablesDefaultAuthenticationPluginEnum = "mysql_native_password"
ConfigurationVariablesDefaultAuthenticationPluginSha256Password ConfigurationVariablesDefaultAuthenticationPluginEnum = "sha256_password"
ConfigurationVariablesDefaultAuthenticationPluginCachingSha2Password ConfigurationVariablesDefaultAuthenticationPluginEnum = "caching_sha2_password"
)
func GetConfigurationVariablesDefaultAuthenticationPluginEnumValues() []ConfigurationVariablesDefaultAuthenticationPluginEnum
GetConfigurationVariablesDefaultAuthenticationPluginEnumValues Enumerates the set of values for ConfigurationVariablesDefaultAuthenticationPluginEnum
func GetMappingConfigurationVariablesDefaultAuthenticationPluginEnum(val string) (ConfigurationVariablesDefaultAuthenticationPluginEnum, bool)
GetMappingConfigurationVariablesDefaultAuthenticationPluginEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigurationVariablesGroupReplicationConsistencyEnum Enum with underlying type: string
type ConfigurationVariablesGroupReplicationConsistencyEnum string
Set of constants representing the allowable values for ConfigurationVariablesGroupReplicationConsistencyEnum
const (
ConfigurationVariablesGroupReplicationConsistencyEventual ConfigurationVariablesGroupReplicationConsistencyEnum = "EVENTUAL"
ConfigurationVariablesGroupReplicationConsistencyBeforeOnPrimaryFailover ConfigurationVariablesGroupReplicationConsistencyEnum = "BEFORE_ON_PRIMARY_FAILOVER"
ConfigurationVariablesGroupReplicationConsistencyBefore ConfigurationVariablesGroupReplicationConsistencyEnum = "BEFORE"
ConfigurationVariablesGroupReplicationConsistencyAfter ConfigurationVariablesGroupReplicationConsistencyEnum = "AFTER"
ConfigurationVariablesGroupReplicationConsistencyBeforeAndAfter ConfigurationVariablesGroupReplicationConsistencyEnum = "BEFORE_AND_AFTER"
)
func GetConfigurationVariablesGroupReplicationConsistencyEnumValues() []ConfigurationVariablesGroupReplicationConsistencyEnum
GetConfigurationVariablesGroupReplicationConsistencyEnumValues Enumerates the set of values for ConfigurationVariablesGroupReplicationConsistencyEnum
func GetMappingConfigurationVariablesGroupReplicationConsistencyEnum(val string) (ConfigurationVariablesGroupReplicationConsistencyEnum, bool)
GetMappingConfigurationVariablesGroupReplicationConsistencyEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigurationVariablesTransactionIsolationEnum Enum with underlying type: string
type ConfigurationVariablesTransactionIsolationEnum string
Set of constants representing the allowable values for ConfigurationVariablesTransactionIsolationEnum
const (
ConfigurationVariablesTransactionIsolationReadUncommitted ConfigurationVariablesTransactionIsolationEnum = "READ-UNCOMMITTED"
ConfigurationVariablesTransactionIsolationReadCommited ConfigurationVariablesTransactionIsolationEnum = "READ-COMMITED"
ConfigurationVariablesTransactionIsolationReadCommitted ConfigurationVariablesTransactionIsolationEnum = "READ-COMMITTED"
ConfigurationVariablesTransactionIsolationRepeatableRead ConfigurationVariablesTransactionIsolationEnum = "REPEATABLE-READ"
ConfigurationVariablesTransactionIsolationSerializable ConfigurationVariablesTransactionIsolationEnum = "SERIALIZABLE"
)
func GetConfigurationVariablesTransactionIsolationEnumValues() []ConfigurationVariablesTransactionIsolationEnum
GetConfigurationVariablesTransactionIsolationEnumValues Enumerates the set of values for ConfigurationVariablesTransactionIsolationEnum
func GetMappingConfigurationVariablesTransactionIsolationEnum(val string) (ConfigurationVariablesTransactionIsolationEnum, bool)
GetMappingConfigurationVariablesTransactionIsolationEnum performs case Insensitive comparison on enum value and return the desired enum
CrashRecoveryStatusEnum Enum with underlying type: string
type CrashRecoveryStatusEnum string
Set of constants representing the allowable values for CrashRecoveryStatusEnum
const (
CrashRecoveryStatusEnabled CrashRecoveryStatusEnum = "ENABLED"
CrashRecoveryStatusDisabled CrashRecoveryStatusEnum = "DISABLED"
)
func GetCrashRecoveryStatusEnumValues() []CrashRecoveryStatusEnum
GetCrashRecoveryStatusEnumValues Enumerates the set of values for CrashRecoveryStatusEnum
func GetMappingCrashRecoveryStatusEnum(val string) (CrashRecoveryStatusEnum, bool)
GetMappingCrashRecoveryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
CreateBackupDetails Complete information for a Backup.
type CreateBackupDetails struct {
// The OCID of the DB System the Backup is associated with.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// A user-supplied display name for the backup.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user-supplied description for the backup.
Description *string `mandatory:"false" json:"description"`
// The type of backup.
BackupType CreateBackupDetailsBackupTypeEnum `mandatory:"false" json:"backupType,omitempty"`
// Number of days to retain this backup.
RetentionInDays *int `mandatory:"false" json:"retentionInDays"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateBackupDetails) String() string
func (m CreateBackupDetails) 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
CreateBackupDetailsBackupTypeEnum Enum with underlying type: string
type CreateBackupDetailsBackupTypeEnum string
Set of constants representing the allowable values for CreateBackupDetailsBackupTypeEnum
const (
CreateBackupDetailsBackupTypeFull CreateBackupDetailsBackupTypeEnum = "FULL"
CreateBackupDetailsBackupTypeIncremental CreateBackupDetailsBackupTypeEnum = "INCREMENTAL"
)
func GetCreateBackupDetailsBackupTypeEnumValues() []CreateBackupDetailsBackupTypeEnum
GetCreateBackupDetailsBackupTypeEnumValues Enumerates the set of values for CreateBackupDetailsBackupTypeEnum
func GetMappingCreateBackupDetailsBackupTypeEnum(val string) (CreateBackupDetailsBackupTypeEnum, bool)
GetMappingCreateBackupDetailsBackupTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateBackupPolicyDetails Backup policy as optionally used for DB System Creation.
type CreateBackupPolicyDetails struct {
// Specifies if automatic backups are enabled.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// The start of a 30-minute window of time in which daily, automated backups occur.
// This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
// At some point in the window, the system may incur a brief service disruption as the backup is performed.
WindowStartTime *string `mandatory:"false" json:"windowStartTime"`
// Number of days to retain an automatic backup.
RetentionInDays *int `mandatory:"false" json:"retentionInDays"`
// Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
PitrPolicy *PitrPolicy `mandatory:"false" json:"pitrPolicy"`
}
func (m CreateBackupPolicyDetails) String() string
func (m CreateBackupPolicyDetails) 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
CreateBackupRequest wrapper for the CreateBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateBackup.go.html to see an example of how to use CreateBackupRequest.
type CreateBackupRequest struct {
// Create a Backup of a DB System.
CreateBackupDetails `contributesTo:"body"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBackupRequest) String() string
func (request CreateBackupRequest) 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
CreateBackupResponse wrapper for the CreateBackup operation
type CreateBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The Backup instance
Backup `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBackupResponse) String() string
CreateChannelDetails Details required to create a Channel.
type CreateChannelDetails struct {
Source CreateChannelSourceDetails `mandatory:"true" json:"source"`
Target CreateChannelTargetDetails `mandatory:"true" json:"target"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name for the Channel. It does not have to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// Whether the Channel should be enabled upon creation. If set to true, the Channel
// will be asynchronously started as a result of the create Channel operation.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// User provided information about the Channel.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateChannelDetails) String() string
func (m *CreateChannelDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateChannelDetails) 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
CreateChannelRequest wrapper for the CreateChannel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateChannel.go.html to see an example of how to use CreateChannelRequest.
type CreateChannelRequest struct {
// The parameters of the request to create the Channel.
CreateChannelDetails `contributesTo:"body"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateChannelRequest) String() string
func (request CreateChannelRequest) 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
CreateChannelResponse wrapper for the CreateChannel operation
type CreateChannelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Channel instance
Channel `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateChannelResponse) String() string
CreateChannelSourceDetails Parameters detailing how to provision the source for the given Channel.
type CreateChannelSourceDetails interface {
}
CreateChannelSourceFromMysqlDetails Parameters detailing how to provision the source endpoint that is a MySQL Server. Typically a MySQL Server that is not managed by the MySQL Database Service.
type CreateChannelSourceFromMysqlDetails struct {
// The network address of the MySQL instance.
Hostname *string `mandatory:"true" json:"hostname"`
// The name of the replication user on the source MySQL instance.
// The username has a maximum length of 96 characters. For more information,
// please see the MySQL documentation (https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html)
Username *string `mandatory:"true" json:"username"`
// The password for the replication user. The password must be
// between 8 and 32 characters long, and must contain at least 1
// numeric character, 1 lowercase character, 1 uppercase character,
// and 1 special (nonalphanumeric) character.
Password *string `mandatory:"true" json:"password"`
// The port the source MySQL instance listens on.
Port *int `mandatory:"false" json:"port"`
SslCaCertificate CaCertificate `mandatory:"false" json:"sslCaCertificate"`
AnonymousTransactionsHandling AnonymousTransactionsHandling `mandatory:"false" json:"anonymousTransactionsHandling"`
// The SSL mode of the Channel.
SslMode ChannelSourceMysqlSslModeEnum `mandatory:"true" json:"sslMode"`
}
func (m CreateChannelSourceFromMysqlDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateChannelSourceFromMysqlDetails) String() string
func (m *CreateChannelSourceFromMysqlDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateChannelSourceFromMysqlDetails) 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
CreateChannelTargetDetails Parameters detailing how to provision the target for the given Channel.
type CreateChannelTargetDetails interface {
}
CreateChannelTargetFromDbSystemDetails Parameters detailing how to provision the target endpoint that is a DB System.
type CreateChannelTargetFromDbSystemDetails struct {
// The OCID of the target DB System.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The case-insensitive name that identifies the replication channel. Channel names
// must follow the rules defined for MySQL identifiers (https://dev.mysql.com/doc/refman/8.0/en/identifiers.html).
// The names of non-Deleted Channels must be unique for each DB System.
ChannelName *string `mandatory:"false" json:"channelName"`
// The username for the replication applier of the target MySQL DB System.
ApplierUsername *string `mandatory:"false" json:"applierUsername"`
// Replication filter rules to be applied at the DB System Channel target.
Filters []ChannelFilter `mandatory:"false" json:"filters"`
// Specifies the amount of time, in seconds, that the channel waits before
// applying a transaction received from the source.
DelayInSeconds *int `mandatory:"false" json:"delayInSeconds"`
// Specifies how a replication channel handles the creation and alteration of tables
// that do not have a primary key. The default value is set to ALLOW.
TablesWithoutPrimaryKeyHandling ChannelTargetDbSystemTablesWithoutPrimaryKeyHandlingEnum `mandatory:"false" json:"tablesWithoutPrimaryKeyHandling,omitempty"`
}
func (m CreateChannelTargetFromDbSystemDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateChannelTargetFromDbSystemDetails) String() string
func (m CreateChannelTargetFromDbSystemDetails) 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
CreateConfigurationDetails The details required to create a new Configuration.
type CreateConfigurationDetails struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the associated Shape.
ShapeName *string `mandatory:"true" json:"shapeName"`
// User-provided data about the Configuration.
Description *string `mandatory:"false" json:"description"`
// The display name of the Configuration.
DisplayName *string `mandatory:"false" json:"displayName"`
InitVariables *InitializationVariables `mandatory:"false" json:"initVariables"`
Variables *ConfigurationVariables `mandatory:"false" json:"variables"`
// The OCID of the Configuration from which the new Configuration is derived. The values in CreateConfigurationDetails.variables supersede the variables of the parent Configuration.
ParentConfigurationId *string `mandatory:"false" json:"parentConfigurationId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateConfigurationDetails) String() string
func (m CreateConfigurationDetails) 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
CreateConfigurationRequest wrapper for the CreateConfiguration operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateConfiguration.go.html to see an example of how to use CreateConfigurationRequest.
type CreateConfigurationRequest struct {
// Request to create a Configuration.
CreateConfigurationDetails `contributesTo:"body"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateConfigurationRequest) String() string
func (request CreateConfigurationRequest) 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
CreateConfigurationResponse wrapper for the CreateConfiguration operation
type CreateConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Configuration instance
Configuration `presentIn:"body"`
// The URI for the entity being described in the response body.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateConfigurationResponse) String() string
CreateDbSystemDetails Details required to create a DB System.
type CreateDbSystemDetails struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the shape. The shape determines the resources allocated
// - CPU cores and memory for VM shapes; CPU cores, memory and storage
// for non-VM (or bare metal) shapes. To get a list of shapes, use the
// ListShapes operation.
ShapeName *string `mandatory:"true" json:"shapeName"`
// The OCID of the subnet the DB System is associated with.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The user-friendly name for the DB System. It does not have to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// User-provided data about the DB System.
Description *string `mandatory:"false" json:"description"`
// Specifies if the DB System is highly available.
// When creating a DB System with High Availability, three instances
// are created and placed according to your region- and
// subnet-type. The secondaries are placed automatically in the other
// two availability or fault domains. You can choose the preferred
// location of your primary instance, only.
IsHighlyAvailable *bool `mandatory:"false" json:"isHighlyAvailable"`
// The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
// In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains
// and the MySQL instance in that domain is promoted to the primary instance.
// This redirection does not affect the IP address of the DB System in any way.
// For a standalone DB System, this defines the availability domain in which the DB System is placed.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
// In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains
// and the MySQL instance in that domain is promoted to the primary instance.
// This redirection does not affect the IP address of the DB System in any way.
// For a standalone DB System, this defines the fault domain in which the DB System is placed.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// The OCID of the Configuration to be used for this DB System.
ConfigurationId *string `mandatory:"false" json:"configurationId"`
// The specific MySQL version identifier.
MysqlVersion *string `mandatory:"false" json:"mysqlVersion"`
// The username for the administrative user.
AdminUsername *string `mandatory:"false" json:"adminUsername"`
// The password for the administrative user. The password must be
// between 8 and 32 characters long, and must contain at least 1
// numeric character, 1 lowercase character, 1 uppercase character, and
// 1 special (nonalphanumeric) character.
AdminPassword *string `mandatory:"false" json:"adminPassword"`
// Initial size of the data volume in GBs that will be created and attached.
// Keep in mind that this only specifies the size of the database data volume,
// the log volume for the database will be scaled appropriately with its shape.
DataStorageSizeInGBs *int `mandatory:"false" json:"dataStorageSizeInGBs"`
// The hostname for the primary endpoint of the DB System. Used for DNS.
// The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN)
// (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").
// Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// The IP address the DB System is configured to listen on.
// A private IP address of your choice to assign to the primary endpoint of the DB System.
// Must be an available IP address within the subnet's CIDR. If you don't specify a value,
// Oracle automatically assigns a private IP address from the subnet. This should be a
// "dotted-quad" style IPv4 address.
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The port for primary endpoint of the DB System to listen on.
Port *int `mandatory:"false" json:"port"`
// The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
PortX *int `mandatory:"false" json:"portX"`
BackupPolicy *CreateBackupPolicyDetails `mandatory:"false" json:"backupPolicy"`
Source CreateDbSystemSourceDetails `mandatory:"false" json:"source"`
Maintenance *CreateMaintenanceDetails `mandatory:"false" json:"maintenance"`
// Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
DeletionPolicy *CreateDeletionPolicyDetails `mandatory:"false" json:"deletionPolicy"`
// Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,
// and whether to enable or disable syncing of the Binary Logs.
CrashRecovery CrashRecoveryStatusEnum `mandatory:"false" json:"crashRecovery,omitempty"`
// Whether to enable monitoring via the Database Management service.
DatabaseManagement DatabaseManagementStatusEnum `mandatory:"false" json:"databaseManagement,omitempty"`
}
func (m CreateDbSystemDetails) String() string
func (m *CreateDbSystemDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateDbSystemDetails) 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
CreateDbSystemRequest wrapper for the CreateDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateDbSystem.go.html to see an example of how to use CreateDbSystemRequest.
type CreateDbSystemRequest struct {
// Request to create a DB System.
CreateDbSystemDetails `contributesTo:"body"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDbSystemRequest) String() string
func (request CreateDbSystemRequest) 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
CreateDbSystemResponse wrapper for the CreateDbSystem operation
type CreateDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// The DbSystem instance
DbSystem `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The URI for the entity being described in the response body.
Location *string `presentIn:"header" name:"location"`
// 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDbSystemResponse) String() string
CreateDbSystemSourceDetails Parameters detailing how to provision the initial data of the system.
type CreateDbSystemSourceDetails interface {
}
CreateDbSystemSourceDetailsSourceTypeEnum Enum with underlying type: string
type CreateDbSystemSourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for CreateDbSystemSourceDetailsSourceTypeEnum
const (
CreateDbSystemSourceDetailsSourceTypeNone CreateDbSystemSourceDetailsSourceTypeEnum = "NONE"
CreateDbSystemSourceDetailsSourceTypeBackup CreateDbSystemSourceDetailsSourceTypeEnum = "BACKUP"
CreateDbSystemSourceDetailsSourceTypePitr CreateDbSystemSourceDetailsSourceTypeEnum = "PITR"
CreateDbSystemSourceDetailsSourceTypeImporturl CreateDbSystemSourceDetailsSourceTypeEnum = "IMPORTURL"
)
func GetCreateDbSystemSourceDetailsSourceTypeEnumValues() []CreateDbSystemSourceDetailsSourceTypeEnum
GetCreateDbSystemSourceDetailsSourceTypeEnumValues Enumerates the set of values for CreateDbSystemSourceDetailsSourceTypeEnum
func GetMappingCreateDbSystemSourceDetailsSourceTypeEnum(val string) (CreateDbSystemSourceDetailsSourceTypeEnum, bool)
GetMappingCreateDbSystemSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDbSystemSourceFromBackupDetails Use the backupId to specify from which backup the new DB System will be created.
type CreateDbSystemSourceFromBackupDetails struct {
// The OCID of the backup to be used as the source for the new DB System.
BackupId *string `mandatory:"true" json:"backupId"`
}
func (m CreateDbSystemSourceFromBackupDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDbSystemSourceFromBackupDetails) String() string
func (m CreateDbSystemSourceFromBackupDetails) 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
CreateDbSystemSourceFromNoneDetails Creation of a DbSystem from no particular source.
type CreateDbSystemSourceFromNoneDetails struct {
}
func (m CreateDbSystemSourceFromNoneDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDbSystemSourceFromNoneDetails) String() string
func (m CreateDbSystemSourceFromNoneDetails) 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
CreateDbSystemSourceFromPitrDetails DB System OCID to perform a point in time recovery to the current point in time. DB System OCID and recovery point to perform a point in time recovery to the specified recovery point.
type CreateDbSystemSourceFromPitrDetails struct {
// The OCID of the DB System from which a backup shall be selected to be
// restored when creating the new DB System. Use this together with
// recovery point to perform a point in time recovery operation.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The date and time, as per RFC 3339, of the change up to which the
// new DB System shall be restored to, using a backup and logs from the
// original DB System. In case no point in time is specified, then this
// new DB System shall be restored up to the latest change recorded for
// the original DB System.
RecoveryPoint *common.SDKTime `mandatory:"false" json:"recoveryPoint"`
}
func (m CreateDbSystemSourceFromPitrDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDbSystemSourceFromPitrDetails) String() string
func (m CreateDbSystemSourceFromPitrDetails) 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
CreateDbSystemSourceImportFromUrlDetails An Object Storage PAR from which to import the DB System initial data.
type CreateDbSystemSourceImportFromUrlDetails struct {
// The Pre-Authenticated Request (PAR) of a bucket/prefix or PAR of a @.manifest.json object from the Object Storage.
// Check Using Pre-Authenticated Requests (https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)
// for information related to PAR creation.
// Please create PAR with "Permit object reads" access type and "Enable Object Listing" permission when using a bucket/prefix PAR.
// Please create PAR with "Permit object reads" access type when using a @.manifest.json object PAR.
SourceUrl *string `mandatory:"true" json:"sourceUrl"`
}
func (m CreateDbSystemSourceImportFromUrlDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDbSystemSourceImportFromUrlDetails) String() string
func (m CreateDbSystemSourceImportFromUrlDetails) 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
CreateDeletionPolicyDetails Policy for how the DB System and related resources should be handled at the time of its deletion.
type CreateDeletionPolicyDetails struct {
// Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
AutomaticBackupRetention CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum `mandatory:"false" json:"automaticBackupRetention,omitempty"`
// Specifies whether or not a backup is taken when the DB System is deleted.
// REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted.
// SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
FinalBackup CreateDeletionPolicyDetailsFinalBackupEnum `mandatory:"false" json:"finalBackup,omitempty"`
// Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
IsDeleteProtected *bool `mandatory:"false" json:"isDeleteProtected"`
}
func (m CreateDeletionPolicyDetails) String() string
func (m CreateDeletionPolicyDetails) 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
CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum Enum with underlying type: string
type CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum string
Set of constants representing the allowable values for CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum
const (
CreateDeletionPolicyDetailsAutomaticBackupRetentionDelete CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum = "DELETE"
CreateDeletionPolicyDetailsAutomaticBackupRetentionRetain CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum = "RETAIN"
)
func GetCreateDeletionPolicyDetailsAutomaticBackupRetentionEnumValues() []CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum
GetCreateDeletionPolicyDetailsAutomaticBackupRetentionEnumValues Enumerates the set of values for CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum
func GetMappingCreateDeletionPolicyDetailsAutomaticBackupRetentionEnum(val string) (CreateDeletionPolicyDetailsAutomaticBackupRetentionEnum, bool)
GetMappingCreateDeletionPolicyDetailsAutomaticBackupRetentionEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDeletionPolicyDetailsFinalBackupEnum Enum with underlying type: string
type CreateDeletionPolicyDetailsFinalBackupEnum string
Set of constants representing the allowable values for CreateDeletionPolicyDetailsFinalBackupEnum
const (
CreateDeletionPolicyDetailsFinalBackupSkipFinalBackup CreateDeletionPolicyDetailsFinalBackupEnum = "SKIP_FINAL_BACKUP"
CreateDeletionPolicyDetailsFinalBackupRequireFinalBackup CreateDeletionPolicyDetailsFinalBackupEnum = "REQUIRE_FINAL_BACKUP"
)
func GetCreateDeletionPolicyDetailsFinalBackupEnumValues() []CreateDeletionPolicyDetailsFinalBackupEnum
GetCreateDeletionPolicyDetailsFinalBackupEnumValues Enumerates the set of values for CreateDeletionPolicyDetailsFinalBackupEnum
func GetMappingCreateDeletionPolicyDetailsFinalBackupEnum(val string) (CreateDeletionPolicyDetailsFinalBackupEnum, bool)
GetMappingCreateDeletionPolicyDetailsFinalBackupEnum performs case Insensitive comparison on enum value and return the desired enum
CreateMaintenanceDetails The Maintenance Policy for the DB System or Read Replica that this model is included in.
type CreateMaintenanceDetails struct {
// The start of the 2 hour maintenance window.
// This string is of the format: "{day-of-week} {time-of-day}".
// "{day-of-week}" is a case-insensitive string like "mon", "tue", &c.
// "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
// If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window.
WindowStartTime *string `mandatory:"true" json:"windowStartTime"`
}
func (m CreateMaintenanceDetails) String() string
func (m CreateMaintenanceDetails) 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
CreateReplicaDetails Details required to create a read replica.
type CreateReplicaDetails struct {
// The OCID of the DB System the read replica is associated with.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The user-friendly name for the read replica. It does not have to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// User provided description of the read replica.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow.
// Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If
// the DB System is delete protected, read replicas can still be deleted individually if they are not delete
// protected themselves.
IsDeleteProtected *bool `mandatory:"false" json:"isDeleteProtected"`
ReplicaOverrides *ReplicaOverrides `mandatory:"false" json:"replicaOverrides"`
}
func (m CreateReplicaDetails) String() string
func (m CreateReplicaDetails) 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
CreateReplicaRequest wrapper for the CreateReplica operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateReplica.go.html to see an example of how to use CreateReplicaRequest.
type CreateReplicaRequest struct {
// The parameters of the request to create the read replica.
CreateReplicaDetails `contributesTo:"body"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateReplicaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateReplicaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateReplicaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateReplicaRequest) String() string
func (request CreateReplicaRequest) 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
CreateReplicaResponse wrapper for the CreateReplica operation
type CreateReplicaResponse struct {
// The underlying http response
RawResponse *http.Response
// The Replica instance
Replica `presentIn:"body"`
// The URI for the entity being described in the response body.
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateReplicaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateReplicaResponse) String() string
DatabaseManagementStatusEnum Enum with underlying type: string
type DatabaseManagementStatusEnum string
Set of constants representing the allowable values for DatabaseManagementStatusEnum
const (
DatabaseManagementStatusEnabled DatabaseManagementStatusEnum = "ENABLED"
DatabaseManagementStatusDisabled DatabaseManagementStatusEnum = "DISABLED"
)
func GetDatabaseManagementStatusEnumValues() []DatabaseManagementStatusEnum
GetDatabaseManagementStatusEnumValues Enumerates the set of values for DatabaseManagementStatusEnum
func GetMappingDatabaseManagementStatusEnum(val string) (DatabaseManagementStatusEnum, bool)
GetMappingDatabaseManagementStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DbBackupsClient a client for DbBackups
type DbBackupsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDbBackupsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DbBackupsClient, err error)
NewDbBackupsClientWithConfigurationProvider Creates a new default DbBackups client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDbBackupsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DbBackupsClient, err error)
NewDbBackupsClientWithOboToken Creates a new default DbBackups 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 DbBackupsClient) ChangeBackupCompartment(ctx context.Context, request ChangeBackupCompartmentRequest) (response ChangeBackupCompartmentResponse, err error)
ChangeBackupCompartment Moves a DB System Backup into a different compartment. When provided, If-Match is checked against ETag values of the Backup.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ChangeBackupCompartment.go.html to see an example of how to use ChangeBackupCompartment API.
func (client *DbBackupsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DbBackupsClient) CreateBackup(ctx context.Context, request CreateBackupRequest) (response CreateBackupResponse, err error)
CreateBackup Create a backup of a DB System.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateBackup.go.html to see an example of how to use CreateBackup API. A default retry strategy applies to this operation CreateBackup()
func (client DbBackupsClient) DeleteBackup(ctx context.Context, request DeleteBackupRequest) (response DeleteBackupResponse, err error)
DeleteBackup Delete a Backup.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteBackup.go.html to see an example of how to use DeleteBackup API. A default retry strategy applies to this operation DeleteBackup()
func (client DbBackupsClient) GetBackup(ctx context.Context, request GetBackupRequest) (response GetBackupResponse, err error)
GetBackup Get information about the specified Backup
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetBackup.go.html to see an example of how to use GetBackup API. A default retry strategy applies to this operation GetBackup()
func (client DbBackupsClient) ListBackups(ctx context.Context, request ListBackupsRequest) (response ListBackupsResponse, err error)
ListBackups Get a list of DB System backups.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListBackups.go.html to see an example of how to use ListBackups API. A default retry strategy applies to this operation ListBackups()
func (client *DbBackupsClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DbBackupsClient) UpdateBackup(ctx context.Context, request UpdateBackupRequest) (response UpdateBackupResponse, err error)
UpdateBackup Update the metadata of a Backup. Metadata such as the displayName or description
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/UpdateBackup.go.html to see an example of how to use UpdateBackup API. A default retry strategy applies to this operation UpdateBackup()
DbSystem A DB System is the core logical unit of MySQL Database Service.
type DbSystem struct {
// The OCID of the DB System.
Id *string `mandatory:"true" json:"id"`
// The user-friendly name for the DB System. It does not have to be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment the DB System belongs in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the subnet the DB System is associated with.
SubnetId *string `mandatory:"true" json:"subnetId"`
// Name of the MySQL Version in use for the DB System.
MysqlVersion *string `mandatory:"true" json:"mysqlVersion"`
// Initial size of the data volume in GiBs that will be created and attached.
DataStorageSizeInGBs *int `mandatory:"true" json:"dataStorageSizeInGBs"`
// The current state of the DB System.
LifecycleState DbSystemLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
Maintenance *MaintenanceDetails `mandatory:"true" json:"maintenance"`
DeletionPolicy *DeletionPolicyDetails `mandatory:"true" json:"deletionPolicy"`
// The date and time the DB System was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the DB System was last updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// User-provided data about the DB System.
Description *string `mandatory:"false" json:"description"`
// Specifies if the DB System is highly available.
IsHighlyAvailable *bool `mandatory:"false" json:"isHighlyAvailable"`
CurrentPlacement *DbSystemPlacement `mandatory:"false" json:"currentPlacement"`
// If the DB System has a HeatWave Cluster attached.
IsHeatWaveClusterAttached *bool `mandatory:"false" json:"isHeatWaveClusterAttached"`
HeatWaveCluster *HeatWaveClusterSummary `mandatory:"false" json:"heatWaveCluster"`
// The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
// In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains
// and the MySQL instance in that domain is promoted to the primary instance.
// This redirection does not affect the IP address of the DB System in any way.
// For a standalone DB System, this defines the availability domain in which the DB System is placed.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
// In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains
// and the MySQL instance in that domain is promoted to the primary instance.
// This redirection does not affect the IP address of the DB System in any way.
// For a standalone DB System, this defines the fault domain in which the DB System is placed.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// The shape of the primary instances of the DB System. The shape
// determines resources allocated to a DB System - CPU cores
// and memory for VM shapes; CPU cores, memory and storage for non-VM
// (or bare metal) shapes. To get a list of shapes, use (the
// ListShapes operation.
ShapeName *string `mandatory:"false" json:"shapeName"`
BackupPolicy *BackupPolicy `mandatory:"false" json:"backupPolicy"`
Source DbSystemSource `mandatory:"false" json:"source"`
// The OCID of the Configuration to be used for Instances in this DB System.
ConfigurationId *string `mandatory:"false" json:"configurationId"`
// The hostname for the primary endpoint of the DB System. Used for DNS.
// The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN)
// (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").
// Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// The IP address the DB System is configured to listen on. A private
// IP address of the primary endpoint of the DB System. Must be an
// available IP address within the subnet's CIDR. This will be a
// "dotted-quad" style IPv4 address.
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The port for primary endpoint of the DB System to listen on.
Port *int `mandatory:"false" json:"port"`
// The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
PortX *int `mandatory:"false" json:"portX"`
// The network endpoints available for this DB System.
Endpoints []DbSystemEndpoint `mandatory:"false" json:"endpoints"`
// A list with a summary of all the Channels attached to the DB System.
Channels []ChannelSummary `mandatory:"false" json:"channels"`
// Additional information about the current lifecycleState.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,
// and whether to enable or disable syncing of the Binary Logs.
CrashRecovery CrashRecoveryStatusEnum `mandatory:"false" json:"crashRecovery,omitempty"`
PointInTimeRecoveryDetails *PointInTimeRecoveryDetails `mandatory:"false" json:"pointInTimeRecoveryDetails"`
// Whether to enable monitoring via the Database Management service.
DatabaseManagement DatabaseManagementStatusEnum `mandatory:"false" json:"databaseManagement,omitempty"`
}
func (m DbSystem) String() string
func (m *DbSystem) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DbSystem) 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
DbSystemClient a client for DbSystem
type DbSystemClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDbSystemClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DbSystemClient, err error)
NewDbSystemClientWithConfigurationProvider Creates a new default DbSystem client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDbSystemClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DbSystemClient, err error)
NewDbSystemClientWithOboToken Creates a new default DbSystem 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 DbSystemClient) AddHeatWaveCluster(ctx context.Context, request AddHeatWaveClusterRequest) (response AddHeatWaveClusterResponse, err error)
AddHeatWaveCluster Adds a HeatWave cluster to the DB System.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/AddHeatWaveCluster.go.html to see an example of how to use AddHeatWaveCluster API. A default retry strategy applies to this operation AddHeatWaveCluster()
func (client *DbSystemClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DbSystemClient) CreateDbSystem(ctx context.Context, request CreateDbSystemRequest) (response CreateDbSystemResponse, err error)
CreateDbSystem Creates and launches a DB System.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateDbSystem.go.html to see an example of how to use CreateDbSystem API. A default retry strategy applies to this operation CreateDbSystem()
func (client DbSystemClient) DeleteDbSystem(ctx context.Context, request DeleteDbSystemRequest) (response DeleteDbSystemResponse, err error)
DeleteDbSystem Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteDbSystem.go.html to see an example of how to use DeleteDbSystem API. A default retry strategy applies to this operation DeleteDbSystem()
func (client DbSystemClient) DeleteHeatWaveCluster(ctx context.Context, request DeleteHeatWaveClusterRequest) (response DeleteHeatWaveClusterResponse, err error)
DeleteHeatWaveCluster Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteHeatWaveCluster.go.html to see an example of how to use DeleteHeatWaveCluster API. A default retry strategy applies to this operation DeleteHeatWaveCluster()
func (client DbSystemClient) GenerateHeatWaveClusterMemoryEstimate(ctx context.Context, request GenerateHeatWaveClusterMemoryEstimateRequest) (response GenerateHeatWaveClusterMemoryEstimateResponse, err error)
GenerateHeatWaveClusterMemoryEstimate Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GenerateHeatWaveClusterMemoryEstimate.go.html to see an example of how to use GenerateHeatWaveClusterMemoryEstimate API. A default retry strategy applies to this operation GenerateHeatWaveClusterMemoryEstimate()
func (client DbSystemClient) GetDbSystem(ctx context.Context, request GetDbSystemRequest) (response GetDbSystemResponse, err error)
GetDbSystem Get information about the specified DB System.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetDbSystem.go.html to see an example of how to use GetDbSystem API. A default retry strategy applies to this operation GetDbSystem()
func (client DbSystemClient) GetHeatWaveCluster(ctx context.Context, request GetHeatWaveClusterRequest) (response GetHeatWaveClusterResponse, err error)
GetHeatWaveCluster Gets information about the HeatWave cluster.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetHeatWaveCluster.go.html to see an example of how to use GetHeatWaveCluster API. A default retry strategy applies to this operation GetHeatWaveCluster()
func (client DbSystemClient) GetHeatWaveClusterMemoryEstimate(ctx context.Context, request GetHeatWaveClusterMemoryEstimateRequest) (response GetHeatWaveClusterMemoryEstimateResponse, err error)
GetHeatWaveClusterMemoryEstimate Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetHeatWaveClusterMemoryEstimate.go.html to see an example of how to use GetHeatWaveClusterMemoryEstimate API. A default retry strategy applies to this operation GetHeatWaveClusterMemoryEstimate()
func (client DbSystemClient) ListDbSystems(ctx context.Context, request ListDbSystemsRequest) (response ListDbSystemsResponse, err error)
ListDbSystems Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListDbSystems.go.html to see an example of how to use ListDbSystems API. A default retry strategy applies to this operation ListDbSystems()
func (client DbSystemClient) RestartDbSystem(ctx context.Context, request RestartDbSystemRequest) (response RestartDbSystemResponse, err error)
RestartDbSystem Restarts the specified DB System.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/RestartDbSystem.go.html to see an example of how to use RestartDbSystem API. A default retry strategy applies to this operation RestartDbSystem()
func (client DbSystemClient) RestartHeatWaveCluster(ctx context.Context, request RestartHeatWaveClusterRequest) (response RestartHeatWaveClusterResponse, err error)
RestartHeatWaveCluster Restarts the HeatWave cluster.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/RestartHeatWaveCluster.go.html to see an example of how to use RestartHeatWaveCluster API. A default retry strategy applies to this operation RestartHeatWaveCluster()
func (client *DbSystemClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DbSystemClient) StartDbSystem(ctx context.Context, request StartDbSystemRequest) (response StartDbSystemResponse, err error)
StartDbSystem Start the specified DB System.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/StartDbSystem.go.html to see an example of how to use StartDbSystem API. A default retry strategy applies to this operation StartDbSystem()
func (client DbSystemClient) StartHeatWaveCluster(ctx context.Context, request StartHeatWaveClusterRequest) (response StartHeatWaveClusterResponse, err error)
StartHeatWaveCluster Starts the HeatWave cluster.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/StartHeatWaveCluster.go.html to see an example of how to use StartHeatWaveCluster API. A default retry strategy applies to this operation StartHeatWaveCluster()
func (client DbSystemClient) StopDbSystem(ctx context.Context, request StopDbSystemRequest) (response StopDbSystemResponse, err error)
StopDbSystem Stops the specified DB System. A stopped DB System is not billed.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/StopDbSystem.go.html to see an example of how to use StopDbSystem API. A default retry strategy applies to this operation StopDbSystem()
func (client DbSystemClient) StopHeatWaveCluster(ctx context.Context, request StopHeatWaveClusterRequest) (response StopHeatWaveClusterResponse, err error)
StopHeatWaveCluster Stops the HeatWave cluster.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/StopHeatWaveCluster.go.html to see an example of how to use StopHeatWaveCluster API. A default retry strategy applies to this operation StopHeatWaveCluster()
func (client DbSystemClient) UpdateDbSystem(ctx context.Context, request UpdateDbSystemRequest) (response UpdateDbSystemResponse, err error)
UpdateDbSystem Update the configuration of a DB System. Updating different fields in the DB System will have different results on the uptime of the DB System. For example, changing the displayName of a DB System will take effect immediately, but changing the shape of a DB System is an asynchronous operation that involves provisioning new Compute resources, pausing the DB System and migrating storage before making the DB System available again.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/UpdateDbSystem.go.html to see an example of how to use UpdateDbSystem API. A default retry strategy applies to this operation UpdateDbSystem()
func (client DbSystemClient) UpdateHeatWaveCluster(ctx context.Context, request UpdateHeatWaveClusterRequest) (response UpdateHeatWaveClusterResponse, err error)
UpdateHeatWaveCluster Updates the HeatWave cluster.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/UpdateHeatWaveCluster.go.html to see an example of how to use UpdateHeatWaveCluster API. A default retry strategy applies to this operation UpdateHeatWaveCluster()
DbSystemEndpoint A particular functional endpoint for access to a DB System, and the properties that apply to it.
type DbSystemEndpoint struct {
// The IP address the DB System is configured to listen on.
IpAddress *string `mandatory:"true" json:"ipAddress"`
// The port the MySQL instance listens on.
Port *int `mandatory:"true" json:"port"`
// The network port where to connect to use this endpoint using the X protocol.
PortX *int `mandatory:"true" json:"portX"`
// The network address of the DB System.
Hostname *string `mandatory:"false" json:"hostname"`
// The access modes from the client that this endpoint supports.
Modes []DbSystemEndpointModesEnum `mandatory:"false" json:"modes,omitempty"`
// The state of the endpoints, as far as it can seen from the DB System.
// There may be some inconsistency with the actual state of the MySQL service.
Status DbSystemEndpointStatusEnum `mandatory:"false" json:"status,omitempty"`
// Additional information about the current endpoint status.
StatusDetails *string `mandatory:"false" json:"statusDetails"`
// The type of endpoint that clients and connectors can connect to.
ResourceType DbSystemEndpointResourceTypeEnum `mandatory:"false" json:"resourceType,omitempty"`
// The OCID of the resource that this endpoint is attached to.
ResourceId *string `mandatory:"false" json:"resourceId"`
}
func (m DbSystemEndpoint) String() string
func (m DbSystemEndpoint) 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
DbSystemEndpointModesEnum Enum with underlying type: string
type DbSystemEndpointModesEnum string
Set of constants representing the allowable values for DbSystemEndpointModesEnum
const (
DbSystemEndpointModesRead DbSystemEndpointModesEnum = "READ"
DbSystemEndpointModesWrite DbSystemEndpointModesEnum = "WRITE"
)
func GetDbSystemEndpointModesEnumValues() []DbSystemEndpointModesEnum
GetDbSystemEndpointModesEnumValues Enumerates the set of values for DbSystemEndpointModesEnum
func GetMappingDbSystemEndpointModesEnum(val string) (DbSystemEndpointModesEnum, bool)
GetMappingDbSystemEndpointModesEnum performs case Insensitive comparison on enum value and return the desired enum
DbSystemEndpointResourceTypeEnum Enum with underlying type: string
type DbSystemEndpointResourceTypeEnum string
Set of constants representing the allowable values for DbSystemEndpointResourceTypeEnum
const (
DbSystemEndpointResourceTypeDbsystem DbSystemEndpointResourceTypeEnum = "DBSYSTEM"
DbSystemEndpointResourceTypeReadReplica DbSystemEndpointResourceTypeEnum = "READ_REPLICA"
DbSystemEndpointResourceTypeLoadBalancer DbSystemEndpointResourceTypeEnum = "LOAD_BALANCER"
)
func GetDbSystemEndpointResourceTypeEnumValues() []DbSystemEndpointResourceTypeEnum
GetDbSystemEndpointResourceTypeEnumValues Enumerates the set of values for DbSystemEndpointResourceTypeEnum
func GetMappingDbSystemEndpointResourceTypeEnum(val string) (DbSystemEndpointResourceTypeEnum, bool)
GetMappingDbSystemEndpointResourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DbSystemEndpointStatusEnum Enum with underlying type: string
type DbSystemEndpointStatusEnum string
Set of constants representing the allowable values for DbSystemEndpointStatusEnum
const (
DbSystemEndpointStatusActive DbSystemEndpointStatusEnum = "ACTIVE"
DbSystemEndpointStatusInactive DbSystemEndpointStatusEnum = "INACTIVE"
DbSystemEndpointStatusUpdating DbSystemEndpointStatusEnum = "UPDATING"
)
func GetDbSystemEndpointStatusEnumValues() []DbSystemEndpointStatusEnum
GetDbSystemEndpointStatusEnumValues Enumerates the set of values for DbSystemEndpointStatusEnum
func GetMappingDbSystemEndpointStatusEnum(val string) (DbSystemEndpointStatusEnum, bool)
GetMappingDbSystemEndpointStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DbSystemLifecycleStateEnum Enum with underlying type: string
type DbSystemLifecycleStateEnum string
Set of constants representing the allowable values for DbSystemLifecycleStateEnum
const (
DbSystemLifecycleStateCreating DbSystemLifecycleStateEnum = "CREATING"
DbSystemLifecycleStateActive DbSystemLifecycleStateEnum = "ACTIVE"
DbSystemLifecycleStateInactive DbSystemLifecycleStateEnum = "INACTIVE"
DbSystemLifecycleStateUpdating DbSystemLifecycleStateEnum = "UPDATING"
DbSystemLifecycleStateDeleting DbSystemLifecycleStateEnum = "DELETING"
DbSystemLifecycleStateDeleted DbSystemLifecycleStateEnum = "DELETED"
DbSystemLifecycleStateFailed DbSystemLifecycleStateEnum = "FAILED"
)
func GetDbSystemLifecycleStateEnumValues() []DbSystemLifecycleStateEnum
GetDbSystemLifecycleStateEnumValues Enumerates the set of values for DbSystemLifecycleStateEnum
func GetMappingDbSystemLifecycleStateEnum(val string) (DbSystemLifecycleStateEnum, bool)
GetMappingDbSystemLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DbSystemPlacement The availability domain and fault domain a DB System is placed in.
type DbSystemPlacement struct {
// The availability domain in which the DB System is placed.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The fault domain in which the DB System is placed.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
}
func (m DbSystemPlacement) String() string
func (m DbSystemPlacement) 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
DbSystemSnapshot Snapshot of the DbSystem details at the time of the backup
type DbSystemSnapshot struct {
// The OCID of the DB System.
Id *string `mandatory:"true" json:"id"`
// The user-friendly name for the DB System. It does not have to be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment the DB System belongs in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the subnet the DB System is associated with.
SubnetId *string `mandatory:"true" json:"subnetId"`
// Name of the MySQL Version in use for the DB System.
MysqlVersion *string `mandatory:"true" json:"mysqlVersion"`
// Initial size of the data volume in GiBs that will be created and attached.
DataStorageSizeInGBs *int `mandatory:"true" json:"dataStorageSizeInGBs"`
Maintenance *MaintenanceDetails `mandatory:"true" json:"maintenance"`
DeletionPolicy *DeletionPolicyDetails `mandatory:"true" json:"deletionPolicy"`
// User-provided data about the DB System.
Description *string `mandatory:"false" json:"description"`
// The Availability Domain where the primary DB System should be located.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The name of the Fault Domain the DB System is located in.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// The shape of the primary instances of the DB System. The shape
// determines resources allocated to a DB System - CPU cores
// and memory for VM shapes; CPU cores, memory and storage for non-VM
// (or bare metal) shapes. To get a list of shapes, use (the
// ListShapes operation.
ShapeName *string `mandatory:"false" json:"shapeName"`
// The username for the administrative user.
AdminUsername *string `mandatory:"false" json:"adminUsername"`
BackupPolicy *BackupPolicy `mandatory:"false" json:"backupPolicy"`
// The OCID of the Configuration to be used for Instances in this DB System.
ConfigurationId *string `mandatory:"false" json:"configurationId"`
// The hostname for the primary endpoint of the DB System. Used for DNS.
// The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN)
// (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com").
// Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// The IP address the DB System is configured to listen on. A private
// IP address of the primary endpoint of the DB System. Must be an
// available IP address within the subnet's CIDR. This will be a
// "dotted-quad" style IPv4 address.
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The port for primary endpoint of the DB System to listen on.
Port *int `mandatory:"false" json:"port"`
// The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port.
PortX *int `mandatory:"false" json:"portX"`
// Specifies if the DB System is highly available.
IsHighlyAvailable *bool `mandatory:"false" json:"isHighlyAvailable"`
// The network endpoints available for this DB System.
Endpoints []DbSystemEndpoint `mandatory:"false" json:"endpoints"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,
// and whether to enable or disable syncing of the Binary Logs.
CrashRecovery CrashRecoveryStatusEnum `mandatory:"false" json:"crashRecovery,omitempty"`
// Whether to enable monitoring via the Database Management service.
DatabaseManagement DatabaseManagementStatusEnum `mandatory:"false" json:"databaseManagement,omitempty"`
}
func (m DbSystemSnapshot) String() string
func (m DbSystemSnapshot) 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
DbSystemSource Parameters detailing how to provision the initial data of the DB System.
type DbSystemSource interface {
}
DbSystemSourceFromBackup From which backup this DB System was created.
type DbSystemSourceFromBackup struct {
// The OCID of the backup to be used as the source for the new DB System.
BackupId *string `mandatory:"true" json:"backupId"`
}
func (m DbSystemSourceFromBackup) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DbSystemSourceFromBackup) String() string
func (m DbSystemSourceFromBackup) 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
DbSystemSourceFromNone A DB System created from no particular external source.
type DbSystemSourceFromNone struct {
}
func (m DbSystemSourceFromNone) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DbSystemSourceFromNone) String() string
func (m DbSystemSourceFromNone) 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
DbSystemSourceFromPitr DB System OCID to perform a point in time recovery to the current point in time. DB System OCID and recovery point to perform a point in time recovery to the specified recovery point.
type DbSystemSourceFromPitr struct {
// The OCID of the DB System from which a backup shall be selected to be
// restored when creating the new DB System. Use this together with
// recovery point to perform a point in time recovery operation.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The date and time, as per RFC 3339, of the change up to which the
// new DB System shall be restored to, using a backup and logs from the
// original DB System. In case no point in time is specified, then this
// new DB System shall be restored up to the latest change recorded for
// the original DB System.
RecoveryPoint *common.SDKTime `mandatory:"false" json:"recoveryPoint"`
}
func (m DbSystemSourceFromPitr) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DbSystemSourceFromPitr) String() string
func (m DbSystemSourceFromPitr) 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
DbSystemSourceImportFromUrl An Object Storage PAR from which to import the DB System initial data.
type DbSystemSourceImportFromUrl struct {
}
func (m DbSystemSourceImportFromUrl) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DbSystemSourceImportFromUrl) String() string
func (m DbSystemSourceImportFromUrl) 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
DbSystemSourceSourceTypeEnum Enum with underlying type: string
type DbSystemSourceSourceTypeEnum string
Set of constants representing the allowable values for DbSystemSourceSourceTypeEnum
const (
DbSystemSourceSourceTypeNone DbSystemSourceSourceTypeEnum = "NONE"
DbSystemSourceSourceTypeBackup DbSystemSourceSourceTypeEnum = "BACKUP"
DbSystemSourceSourceTypePitr DbSystemSourceSourceTypeEnum = "PITR"
DbSystemSourceSourceTypeImporturl DbSystemSourceSourceTypeEnum = "IMPORTURL"
)
func GetDbSystemSourceSourceTypeEnumValues() []DbSystemSourceSourceTypeEnum
GetDbSystemSourceSourceTypeEnumValues Enumerates the set of values for DbSystemSourceSourceTypeEnum
func GetMappingDbSystemSourceSourceTypeEnum(val string) (DbSystemSourceSourceTypeEnum, bool)
GetMappingDbSystemSourceSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DbSystemSummary A summary of a DB System.
type DbSystemSummary struct {
// The OCID of the DB System.
Id *string `mandatory:"true" json:"id"`
// The user-friendly name for the DB System. It does not have to be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the DB System.
LifecycleState DbSystemLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Name of the MySQL Version in use for the DB System.
MysqlVersion *string `mandatory:"true" json:"mysqlVersion"`
// The date and time the DB System was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the DB System was last updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// User-provided data about the DB System.
Description *string `mandatory:"false" json:"description"`
// The OCID of the compartment the DB System belongs in.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Specifies if the DB System is highly available.
IsHighlyAvailable *bool `mandatory:"false" json:"isHighlyAvailable"`
CurrentPlacement *DbSystemPlacement `mandatory:"false" json:"currentPlacement"`
// If the DB System has a HeatWave Cluster attached.
IsHeatWaveClusterAttached *bool `mandatory:"false" json:"isHeatWaveClusterAttached"`
HeatWaveCluster *HeatWaveClusterSummary `mandatory:"false" json:"heatWaveCluster"`
// The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
// In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains
// and the MySQL instance in that domain is promoted to the primary instance.
// This redirection does not affect the IP address of the DB System in any way.
// For a standalone DB System, this defines the availability domain in which the DB System is placed.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance.
// In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains
// and the MySQL instance in that domain is promoted to the primary instance.
// This redirection does not affect the IP address of the DB System in any way.
// For a standalone DB System, this defines the fault domain in which the DB System is placed.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// The network endpoints available for this DB System.
Endpoints []DbSystemEndpoint `mandatory:"false" json:"endpoints"`
DeletionPolicy *DeletionPolicyDetails `mandatory:"false" json:"deletionPolicy"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
BackupPolicy *BackupPolicy `mandatory:"false" json:"backupPolicy"`
// The shape of the primary instances of the DB System. The shape
// determines resources allocated to a DB System - CPU cores
// and memory for VM shapes; CPU cores, memory and storage for non-VM
// (or bare metal) shapes. To get a list of shapes, use (the
// ListShapes operation.
ShapeName *string `mandatory:"false" json:"shapeName"`
// Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled,
// and whether to enable or disable syncing of the Binary Logs.
CrashRecovery CrashRecoveryStatusEnum `mandatory:"false" json:"crashRecovery,omitempty"`
// Whether to enable monitoring via the Database Management service.
DatabaseManagement DatabaseManagementStatusEnum `mandatory:"false" json:"databaseManagement,omitempty"`
}
func (m DbSystemSummary) String() string
func (m DbSystemSummary) 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
DeleteBackupRequest wrapper for the DeleteBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteBackup.go.html to see an example of how to use DeleteBackupRequest.
type DeleteBackupRequest struct {
// The OCID of the Backup
BackupId *string `mandatory:"true" contributesTo:"path" name:"backupId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `If-Match` header 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"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBackupRequest) String() string
func (request DeleteBackupRequest) 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
DeleteBackupResponse wrapper for the DeleteBackup operation
type DeleteBackupResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBackupResponse) String() string
DeleteChannelRequest wrapper for the DeleteChannel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteChannel.go.html to see an example of how to use DeleteChannelRequest.
type DeleteChannelRequest struct {
// The Channel OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `If-Match` header 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"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteChannelRequest) String() string
func (request DeleteChannelRequest) 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
DeleteChannelResponse wrapper for the DeleteChannel operation
type DeleteChannelResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteChannelResponse) String() string
DeleteConfigurationRequest wrapper for the DeleteConfiguration operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteConfiguration.go.html to see an example of how to use DeleteConfigurationRequest.
type DeleteConfigurationRequest struct {
// The OCID of the Configuration.
ConfigurationId *string `mandatory:"true" contributesTo:"path" name:"configurationId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `If-Match` header 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"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteConfigurationRequest) String() string
func (request DeleteConfigurationRequest) 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
DeleteConfigurationResponse wrapper for the DeleteConfiguration operation
type DeleteConfigurationResponse 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 DeleteConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteConfigurationResponse) String() string
DeleteDbSystemRequest wrapper for the DeleteDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteDbSystem.go.html to see an example of how to use DeleteDbSystemRequest.
type DeleteDbSystemRequest struct {
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `If-Match` header 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"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDbSystemRequest) String() string
func (request DeleteDbSystemRequest) 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
DeleteDbSystemResponse wrapper for the DeleteDbSystem operation
type DeleteDbSystemResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDbSystemResponse) String() string
DeleteHeatWaveClusterRequest wrapper for the DeleteHeatWaveCluster operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteHeatWaveCluster.go.html to see an example of how to use DeleteHeatWaveClusterRequest.
type DeleteHeatWaveClusterRequest struct {
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `If-Match` header 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"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteHeatWaveClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteHeatWaveClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteHeatWaveClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteHeatWaveClusterRequest) String() string
func (request DeleteHeatWaveClusterRequest) 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
DeleteHeatWaveClusterResponse wrapper for the DeleteHeatWaveCluster operation
type DeleteHeatWaveClusterResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteHeatWaveClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteHeatWaveClusterResponse) String() string
DeleteReplicaRequest wrapper for the DeleteReplica operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteReplica.go.html to see an example of how to use DeleteReplicaRequest.
type DeleteReplicaRequest struct {
// The Replica OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
ReplicaId *string `mandatory:"true" contributesTo:"path" name:"replicaId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `If-Match` header 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"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteReplicaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteReplicaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteReplicaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteReplicaRequest) String() string
func (request DeleteReplicaRequest) 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
DeleteReplicaResponse wrapper for the DeleteReplica operation
type DeleteReplicaResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteReplicaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteReplicaResponse) String() string
DeletionPolicyDetails The Deletion policy for the DB System.
type DeletionPolicyDetails struct {
// Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted.
AutomaticBackupRetention DeletionPolicyDetailsAutomaticBackupRetentionEnum `mandatory:"true" json:"automaticBackupRetention"`
// Specifies whether or not a backup is taken when the DB System is deleted.
// REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted.
// SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted.
FinalBackup DeletionPolicyDetailsFinalBackupEnum `mandatory:"true" json:"finalBackup"`
// Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow.
IsDeleteProtected *bool `mandatory:"true" json:"isDeleteProtected"`
}
func (m DeletionPolicyDetails) String() string
func (m DeletionPolicyDetails) 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
DeletionPolicyDetailsAutomaticBackupRetentionEnum Enum with underlying type: string
type DeletionPolicyDetailsAutomaticBackupRetentionEnum string
Set of constants representing the allowable values for DeletionPolicyDetailsAutomaticBackupRetentionEnum
const (
DeletionPolicyDetailsAutomaticBackupRetentionDelete DeletionPolicyDetailsAutomaticBackupRetentionEnum = "DELETE"
DeletionPolicyDetailsAutomaticBackupRetentionRetain DeletionPolicyDetailsAutomaticBackupRetentionEnum = "RETAIN"
)
func GetDeletionPolicyDetailsAutomaticBackupRetentionEnumValues() []DeletionPolicyDetailsAutomaticBackupRetentionEnum
GetDeletionPolicyDetailsAutomaticBackupRetentionEnumValues Enumerates the set of values for DeletionPolicyDetailsAutomaticBackupRetentionEnum
func GetMappingDeletionPolicyDetailsAutomaticBackupRetentionEnum(val string) (DeletionPolicyDetailsAutomaticBackupRetentionEnum, bool)
GetMappingDeletionPolicyDetailsAutomaticBackupRetentionEnum performs case Insensitive comparison on enum value and return the desired enum
DeletionPolicyDetailsFinalBackupEnum Enum with underlying type: string
type DeletionPolicyDetailsFinalBackupEnum string
Set of constants representing the allowable values for DeletionPolicyDetailsFinalBackupEnum
const (
DeletionPolicyDetailsFinalBackupSkipFinalBackup DeletionPolicyDetailsFinalBackupEnum = "SKIP_FINAL_BACKUP"
DeletionPolicyDetailsFinalBackupRequireFinalBackup DeletionPolicyDetailsFinalBackupEnum = "REQUIRE_FINAL_BACKUP"
)
func GetDeletionPolicyDetailsFinalBackupEnumValues() []DeletionPolicyDetailsFinalBackupEnum
GetDeletionPolicyDetailsFinalBackupEnumValues Enumerates the set of values for DeletionPolicyDetailsFinalBackupEnum
func GetMappingDeletionPolicyDetailsFinalBackupEnum(val string) (DeletionPolicyDetailsFinalBackupEnum, bool)
GetMappingDeletionPolicyDetailsFinalBackupEnum performs case Insensitive comparison on enum value and return the desired enum
ErrorOnAnonymousHandling Disables assignment of IDs to anonymous transactions coming from the source. Use this policy when the transaction identifiers are enabled in the source of the replication channel.
type ErrorOnAnonymousHandling struct {
}
func (m ErrorOnAnonymousHandling) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ErrorOnAnonymousHandling) String() string
func (m ErrorOnAnonymousHandling) 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
GenerateHeatWaveClusterMemoryEstimateRequest wrapper for the GenerateHeatWaveClusterMemoryEstimate operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GenerateHeatWaveClusterMemoryEstimate.go.html to see an example of how to use GenerateHeatWaveClusterMemoryEstimateRequest.
type GenerateHeatWaveClusterMemoryEstimateRequest struct {
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 GenerateHeatWaveClusterMemoryEstimateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateHeatWaveClusterMemoryEstimateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateHeatWaveClusterMemoryEstimateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateHeatWaveClusterMemoryEstimateRequest) String() string
func (request GenerateHeatWaveClusterMemoryEstimateRequest) 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
GenerateHeatWaveClusterMemoryEstimateResponse wrapper for the GenerateHeatWaveClusterMemoryEstimate operation
type GenerateHeatWaveClusterMemoryEstimateResponse struct {
// The underlying http response
RawResponse *http.Response
// The HeatWaveClusterMemoryEstimate instance
HeatWaveClusterMemoryEstimate `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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response GenerateHeatWaveClusterMemoryEstimateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateHeatWaveClusterMemoryEstimateResponse) String() string
GetBackupRequest wrapper for the GetBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetBackup.go.html to see an example of how to use GetBackupRequest.
type GetBackupRequest struct {
// The OCID of the Backup
BackupId *string `mandatory:"true" contributesTo:"path" name:"backupId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For conditional requests. In the GET call for a resource, set the
// `If-None-Match` header to the value of the ETag from a previous GET (or
// POST or PUT) response for that resource. The server will return with
// either a 304 Not Modified response if the resource has not changed, or a
// 200 OK response with the updated representation.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBackupRequest) String() string
func (request GetBackupRequest) 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
GetBackupResponse wrapper for the GetBackup operation
type GetBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The Backup instance
Backup `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBackupResponse) String() string
GetChannelRequest wrapper for the GetChannel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetChannel.go.html to see an example of how to use GetChannelRequest.
type GetChannelRequest struct {
// The Channel OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For conditional requests. In the GET call for a resource, set the
// `If-None-Match` header to the value of the ETag from a previous GET (or
// POST or PUT) response for that resource. The server will return with
// either a 304 Not Modified response if the resource has not changed, or a
// 200 OK response with the updated representation.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetChannelRequest) String() string
func (request GetChannelRequest) 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
GetChannelResponse wrapper for the GetChannel operation
type GetChannelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Channel instance
Channel `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetChannelResponse) String() string
GetConfigurationRequest wrapper for the GetConfiguration operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetConfiguration.go.html to see an example of how to use GetConfigurationRequest.
type GetConfigurationRequest struct {
// The OCID of the Configuration.
ConfigurationId *string `mandatory:"true" contributesTo:"path" name:"configurationId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For conditional requests. In the GET call for a resource, set the
// `If-None-Match` header to the value of the ETag from a previous GET (or
// POST or PUT) response for that resource. The server will return with
// either a 304 Not Modified response if the resource has not changed, or a
// 200 OK response with the updated representation.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConfigurationRequest) String() string
func (request GetConfigurationRequest) 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
GetConfigurationResponse wrapper for the GetConfiguration operation
type GetConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Configuration instance
Configuration `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConfigurationResponse) String() string
GetDbSystemRequest wrapper for the GetDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetDbSystem.go.html to see an example of how to use GetDbSystemRequest.
type GetDbSystemRequest struct {
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For conditional requests. In the GET call for a resource, set the
// `If-None-Match` header to the value of the ETag from a previous GET (or
// POST or PUT) response for that resource. The server will return with
// either a 304 Not Modified response if the resource has not changed, or a
// 200 OK response with the updated representation.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDbSystemRequest) String() string
func (request GetDbSystemRequest) 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
GetDbSystemResponse wrapper for the GetDbSystem operation
type GetDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// The DbSystem instance
DbSystem `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDbSystemResponse) String() string
GetHeatWaveClusterMemoryEstimateRequest wrapper for the GetHeatWaveClusterMemoryEstimate operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetHeatWaveClusterMemoryEstimate.go.html to see an example of how to use GetHeatWaveClusterMemoryEstimateRequest.
type GetHeatWaveClusterMemoryEstimateRequest struct {
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetHeatWaveClusterMemoryEstimateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHeatWaveClusterMemoryEstimateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHeatWaveClusterMemoryEstimateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHeatWaveClusterMemoryEstimateRequest) String() string
func (request GetHeatWaveClusterMemoryEstimateRequest) 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
GetHeatWaveClusterMemoryEstimateResponse wrapper for the GetHeatWaveClusterMemoryEstimate operation
type GetHeatWaveClusterMemoryEstimateResponse struct {
// The underlying http response
RawResponse *http.Response
// The HeatWaveClusterMemoryEstimate instance
HeatWaveClusterMemoryEstimate `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"`
}
func (response GetHeatWaveClusterMemoryEstimateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHeatWaveClusterMemoryEstimateResponse) String() string
GetHeatWaveClusterRequest wrapper for the GetHeatWaveCluster operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetHeatWaveCluster.go.html to see an example of how to use GetHeatWaveClusterRequest.
type GetHeatWaveClusterRequest struct {
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For conditional requests. In the GET call for a resource, set the
// `If-None-Match` header to the value of the ETag from a previous GET (or
// POST or PUT) response for that resource. The server will return with
// either a 304 Not Modified response if the resource has not changed, or a
// 200 OK response with the updated representation.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetHeatWaveClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHeatWaveClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHeatWaveClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHeatWaveClusterRequest) String() string
func (request GetHeatWaveClusterRequest) 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
GetHeatWaveClusterResponse wrapper for the GetHeatWaveCluster operation
type GetHeatWaveClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The HeatWaveCluster instance
HeatWaveCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetHeatWaveClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHeatWaveClusterResponse) String() string
GetReplicaRequest wrapper for the GetReplica operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetReplica.go.html to see an example of how to use GetReplicaRequest.
type GetReplicaRequest struct {
// The Replica OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
ReplicaId *string `mandatory:"true" contributesTo:"path" name:"replicaId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For conditional requests. In the GET call for a resource, set the
// `If-None-Match` header to the value of the ETag from a previous GET (or
// POST or PUT) response for that resource. The server will return with
// either a 304 Not Modified response if the resource has not changed, or a
// 200 OK response with the updated representation.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetReplicaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetReplicaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetReplicaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetReplicaRequest) String() string
func (request GetReplicaRequest) 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
GetReplicaResponse wrapper for the GetReplica operation
type GetReplicaResponse struct {
// The underlying http response
RawResponse *http.Response
// The Replica instance
Replica `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetReplicaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetReplicaResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// the ID of the WorkRequest
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// For conditional requests. In the GET call for a resource, set the
// `If-None-Match` header to the value of the ETag from a previous GET (or
// POST or PUT) response for that resource. The server will return with
// either a 304 Not Modified response if the resource has not changed, or a
// 200 OK response with the updated representation.
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-match"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
// 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"`
// Flag to indicate whether or not the object was modified. If this is true,
// the getter for the object itself will return null. Callers should check this
// if they specified one of the request params that might result in a conditional
// response (like 'if-match'/'if-none-match').
IsNotModified bool
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HeatWaveCluster A HeatWave cluster is a database accelerator for a DB System.
type HeatWaveCluster struct {
// The OCID of the parent DB System this HeatWave cluster is attached to.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The shape determines resources to allocate to the HeatWave
// nodes - CPU cores, memory.
ShapeName *string `mandatory:"true" json:"shapeName"`
// The number of analytics-processing compute instances, of the
// specified shape, in the HeatWave cluster.
ClusterSize *int `mandatory:"true" json:"clusterSize"`
// A HeatWave node is a compute host that is part of a HeatWave cluster.
ClusterNodes []HeatWaveNode `mandatory:"true" json:"clusterNodes"`
// The current state of the HeatWave cluster.
LifecycleState HeatWaveClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the HeatWave cluster was created,
// as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the HeatWave cluster was last updated,
// as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Lakehouse enabled status for the HeatWave cluster.
IsLakehouseEnabled *bool `mandatory:"false" json:"isLakehouseEnabled"`
// Additional information about the current lifecycleState.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m HeatWaveCluster) String() string
func (m HeatWaveCluster) 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
HeatWaveClusterLifecycleStateEnum Enum with underlying type: string
type HeatWaveClusterLifecycleStateEnum string
Set of constants representing the allowable values for HeatWaveClusterLifecycleStateEnum
const (
HeatWaveClusterLifecycleStateCreating HeatWaveClusterLifecycleStateEnum = "CREATING"
HeatWaveClusterLifecycleStateActive HeatWaveClusterLifecycleStateEnum = "ACTIVE"
HeatWaveClusterLifecycleStateInactive HeatWaveClusterLifecycleStateEnum = "INACTIVE"
HeatWaveClusterLifecycleStateUpdating HeatWaveClusterLifecycleStateEnum = "UPDATING"
HeatWaveClusterLifecycleStateDeleting HeatWaveClusterLifecycleStateEnum = "DELETING"
HeatWaveClusterLifecycleStateDeleted HeatWaveClusterLifecycleStateEnum = "DELETED"
HeatWaveClusterLifecycleStateFailed HeatWaveClusterLifecycleStateEnum = "FAILED"
)
func GetHeatWaveClusterLifecycleStateEnumValues() []HeatWaveClusterLifecycleStateEnum
GetHeatWaveClusterLifecycleStateEnumValues Enumerates the set of values for HeatWaveClusterLifecycleStateEnum
func GetMappingHeatWaveClusterLifecycleStateEnum(val string) (HeatWaveClusterLifecycleStateEnum, bool)
GetMappingHeatWaveClusterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
HeatWaveClusterMemoryEstimate HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size. For each MySQL user table the estimated memory footprint when the table is loaded to the HeatWave cluster memory is returned.
type HeatWaveClusterMemoryEstimate struct {
// The OCID of the DB System the HeatWave cluster memory estimate is associated with.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// Current status of the Work Request generating the HeatWave cluster memory estimate.
Status HeatWaveClusterMemoryEstimateStatusEnum `mandatory:"true" json:"status"`
// The date and time that the Work Request to generate the HeatWave cluster memory estimate was issued, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc333).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time that the HeatWave cluster memory estimate was generated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc333).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Collection of schemas with estimated memory footprints for MySQL user tables of each schema
// when loaded to HeatWave cluster memory.
TableSchemas []HeatWaveClusterSchemaMemoryEstimate `mandatory:"true" json:"tableSchemas"`
}
func (m HeatWaveClusterMemoryEstimate) String() string
func (m HeatWaveClusterMemoryEstimate) 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
HeatWaveClusterMemoryEstimateStatusEnum Enum with underlying type: string
type HeatWaveClusterMemoryEstimateStatusEnum string
Set of constants representing the allowable values for HeatWaveClusterMemoryEstimateStatusEnum
const (
HeatWaveClusterMemoryEstimateStatusAccepted HeatWaveClusterMemoryEstimateStatusEnum = "ACCEPTED"
HeatWaveClusterMemoryEstimateStatusInProgress HeatWaveClusterMemoryEstimateStatusEnum = "IN_PROGRESS"
HeatWaveClusterMemoryEstimateStatusFailed HeatWaveClusterMemoryEstimateStatusEnum = "FAILED"
HeatWaveClusterMemoryEstimateStatusSucceeded HeatWaveClusterMemoryEstimateStatusEnum = "SUCCEEDED"
HeatWaveClusterMemoryEstimateStatusCanceling HeatWaveClusterMemoryEstimateStatusEnum = "CANCELING"
HeatWaveClusterMemoryEstimateStatusCanceled HeatWaveClusterMemoryEstimateStatusEnum = "CANCELED"
)
func GetHeatWaveClusterMemoryEstimateStatusEnumValues() []HeatWaveClusterMemoryEstimateStatusEnum
GetHeatWaveClusterMemoryEstimateStatusEnumValues Enumerates the set of values for HeatWaveClusterMemoryEstimateStatusEnum
func GetMappingHeatWaveClusterMemoryEstimateStatusEnum(val string) (HeatWaveClusterMemoryEstimateStatusEnum, bool)
GetMappingHeatWaveClusterMemoryEstimateStatusEnum performs case Insensitive comparison on enum value and return the desired enum
HeatWaveClusterSchemaMemoryEstimate Schema with estimated memory footprints for each MySQL user table of the schema when loaded to HeatWave cluster memory.
type HeatWaveClusterSchemaMemoryEstimate struct {
// The name of the schema.
SchemaName *string `mandatory:"true" json:"schemaName"`
// Estimated memory footprints for MySQL user tables of the schema
// when loaded to HeatWave cluster memory.
PerTableEstimates []HeatWaveClusterTableMemoryEstimate `mandatory:"true" json:"perTableEstimates"`
}
func (m HeatWaveClusterSchemaMemoryEstimate) String() string
func (m HeatWaveClusterSchemaMemoryEstimate) 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
HeatWaveClusterSummary A summary of a HeatWave cluster.
type HeatWaveClusterSummary struct {
// The shape determines resources to allocate to the HeatWave
// nodes - CPU cores, memory.
ShapeName *string `mandatory:"true" json:"shapeName"`
// The number of analytics-processing compute instances, of the
// specified shape, in the HeatWave cluster.
ClusterSize *int `mandatory:"true" json:"clusterSize"`
// The current state of the MySQL HeatWave cluster.
LifecycleState HeatWaveClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the HeatWave cluster was created,
// as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the HeatWave cluster was last updated,
// as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Lakehouse enabled status for the HeatWave cluster.
IsLakehouseEnabled *bool `mandatory:"false" json:"isLakehouseEnabled"`
}
func (m HeatWaveClusterSummary) String() string
func (m HeatWaveClusterSummary) 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
HeatWaveClusterTableMemoryEstimate Estimated memory footprint for a MySQL user table when loaded to the HeatWave cluster memory.
type HeatWaveClusterTableMemoryEstimate struct {
// The table name.
TableName *string `mandatory:"true" json:"tableName"`
// The number of columns to be loaded to HeatWave cluster memory.
// These columns contribute to the analytical memory footprint.
ToLoadColumnCount *int `mandatory:"true" json:"toLoadColumnCount"`
// The number of variable-length columns to be loaded to HeatWave cluster memory.
// These columns contribute to the analytical memory footprint.
VarlenColumnCount *int `mandatory:"true" json:"varlenColumnCount"`
// The estimated number of rows in the table. This number was used to
// derive the analytical memory footprint.
EstimatedRowCount *int64 `mandatory:"true" json:"estimatedRowCount"`
// The estimated memory footprint of the table in MBs when loaded to
// HeatWave cluster memory (null if the table cannot be loaded to the
// HeatWave cluster).
AnalyticalFootprintInMbs *int64 `mandatory:"true" json:"analyticalFootprintInMbs"`
// Error comment (empty string if no errors occured).
ErrorComment *string `mandatory:"true" json:"errorComment"`
}
func (m HeatWaveClusterTableMemoryEstimate) String() string
func (m HeatWaveClusterTableMemoryEstimate) 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
HeatWaveNode A HeatWave node is a compute host that is part of a HeatWave cluster.
type HeatWaveNode struct {
// The ID of the node within MySQL HeatWave cluster.
NodeId *string `mandatory:"true" json:"nodeId"`
// The current state of the MySQL HeatWave node.
LifecycleState HeatWaveNodeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the MySQL HeatWave node was created,
// as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the MySQL HeatWave node was updated,
// as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m HeatWaveNode) String() string
func (m HeatWaveNode) 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
HeatWaveNodeLifecycleStateEnum Enum with underlying type: string
type HeatWaveNodeLifecycleStateEnum string
Set of constants representing the allowable values for HeatWaveNodeLifecycleStateEnum
const (
HeatWaveNodeLifecycleStateCreating HeatWaveNodeLifecycleStateEnum = "CREATING"
HeatWaveNodeLifecycleStateActive HeatWaveNodeLifecycleStateEnum = "ACTIVE"
HeatWaveNodeLifecycleStateInactive HeatWaveNodeLifecycleStateEnum = "INACTIVE"
HeatWaveNodeLifecycleStateUpdating HeatWaveNodeLifecycleStateEnum = "UPDATING"
HeatWaveNodeLifecycleStateDeleting HeatWaveNodeLifecycleStateEnum = "DELETING"
HeatWaveNodeLifecycleStateDeleted HeatWaveNodeLifecycleStateEnum = "DELETED"
HeatWaveNodeLifecycleStateFailed HeatWaveNodeLifecycleStateEnum = "FAILED"
)
func GetHeatWaveNodeLifecycleStateEnumValues() []HeatWaveNodeLifecycleStateEnum
GetHeatWaveNodeLifecycleStateEnumValues Enumerates the set of values for HeatWaveNodeLifecycleStateEnum
func GetMappingHeatWaveNodeLifecycleStateEnum(val string) (HeatWaveNodeLifecycleStateEnum, bool)
GetMappingHeatWaveNodeLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
InitializationVariables User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime.
type InitializationVariables struct {
//
// Represents the MySQL server system variable lower_case_table_names (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_lower_case_table_names).
// lowerCaseTableNames controls case-sensitivity of tables and schema names and how they are stored in the DB System.
// Valid values are:
// - CASE_SENSITIVE - (default) Table and schema name comparisons are case-sensitive and stored as specified. (lower_case_table_names=0)
// - CASE_INSENSITIVE_LOWERCASE - Table and schema name comparisons are not case-sensitive and stored in lowercase. (lower_case_table_names=1)
LowerCaseTableNames InitializationVariablesLowerCaseTableNamesEnum `mandatory:"false" json:"lowerCaseTableNames,omitempty"`
}
func (m InitializationVariables) String() string
func (m InitializationVariables) 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
InitializationVariablesLowerCaseTableNamesEnum Enum with underlying type: string
type InitializationVariablesLowerCaseTableNamesEnum string
Set of constants representing the allowable values for InitializationVariablesLowerCaseTableNamesEnum
const (
InitializationVariablesLowerCaseTableNamesSensitive InitializationVariablesLowerCaseTableNamesEnum = "CASE_SENSITIVE"
InitializationVariablesLowerCaseTableNamesInsensitiveLowercase InitializationVariablesLowerCaseTableNamesEnum = "CASE_INSENSITIVE_LOWERCASE"
)
func GetInitializationVariablesLowerCaseTableNamesEnumValues() []InitializationVariablesLowerCaseTableNamesEnum
GetInitializationVariablesLowerCaseTableNamesEnumValues Enumerates the set of values for InitializationVariablesLowerCaseTableNamesEnum
func GetMappingInitializationVariablesLowerCaseTableNamesEnum(val string) (InitializationVariablesLowerCaseTableNamesEnum, bool)
GetMappingInitializationVariablesLowerCaseTableNamesEnum performs case Insensitive comparison on enum value and return the desired enum
InnoDbShutdownModeEnum Enum with underlying type: string
type InnoDbShutdownModeEnum string
Set of constants representing the allowable values for InnoDbShutdownModeEnum
const (
InnoDbShutdownModeImmediate InnoDbShutdownModeEnum = "IMMEDIATE"
InnoDbShutdownModeFast InnoDbShutdownModeEnum = "FAST"
InnoDbShutdownModeSlow InnoDbShutdownModeEnum = "SLOW"
)
func GetInnoDbShutdownModeEnumValues() []InnoDbShutdownModeEnum
GetInnoDbShutdownModeEnumValues Enumerates the set of values for InnoDbShutdownModeEnum
func GetMappingInnoDbShutdownModeEnum(val string) (InnoDbShutdownModeEnum, bool)
GetMappingInnoDbShutdownModeEnum performs case Insensitive comparison on enum value and return the desired enum
ListBackupsRequest wrapper for the ListBackups operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListBackups.go.html to see an example of how to use ListBackupsRequest.
type ListBackupsRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Backup OCID
BackupId *string `mandatory:"false" contributesTo:"query" name:"backupId"`
// Backup Lifecycle State
LifecycleState BackupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"false" contributesTo:"query" name:"dbSystemId"`
// A filter to return only the resource matching the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Backup creationType
CreationType BackupCreationTypeEnum `mandatory:"false" contributesTo:"query" name:"creationType" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending.
SortBy ListBackupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use (ASC or DESC).
SortOrder ListBackupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListBackupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBackupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBackupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBackupsRequest) String() string
func (request ListBackupsRequest) 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
ListBackupsResponse wrapper for the ListBackups operation
type ListBackupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []BackupSummary instances
Items []BackupSummary `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 ListBackupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBackupsResponse) String() string
ListBackupsSortByEnum Enum with underlying type: string
type ListBackupsSortByEnum string
Set of constants representing the allowable values for ListBackupsSortByEnum
const (
ListBackupsSortByTimecreated ListBackupsSortByEnum = "timeCreated"
ListBackupsSortByTimeupdated ListBackupsSortByEnum = "timeUpdated"
ListBackupsSortByDisplayname ListBackupsSortByEnum = "displayName"
)
func GetListBackupsSortByEnumValues() []ListBackupsSortByEnum
GetListBackupsSortByEnumValues Enumerates the set of values for ListBackupsSortByEnum
func GetMappingListBackupsSortByEnum(val string) (ListBackupsSortByEnum, bool)
GetMappingListBackupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBackupsSortOrderEnum Enum with underlying type: string
type ListBackupsSortOrderEnum string
Set of constants representing the allowable values for ListBackupsSortOrderEnum
const (
ListBackupsSortOrderAsc ListBackupsSortOrderEnum = "ASC"
ListBackupsSortOrderDesc ListBackupsSortOrderEnum = "DESC"
)
func GetListBackupsSortOrderEnumValues() []ListBackupsSortOrderEnum
GetListBackupsSortOrderEnumValues Enumerates the set of values for ListBackupsSortOrderEnum
func GetMappingListBackupsSortOrderEnum(val string) (ListBackupsSortOrderEnum, bool)
GetMappingListBackupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListChannelsRequest wrapper for the ListChannels operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListChannels.go.html to see an example of how to use ListChannelsRequest.
type ListChannelsRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"false" contributesTo:"query" name:"dbSystemId"`
// The OCID of the Channel.
ChannelId *string `mandatory:"false" contributesTo:"query" name:"channelId"`
// A filter to return only the resource matching the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The LifecycleState of the Channel.
LifecycleState ChannelLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// If true, returns only Channels that are enabled. If false, returns only
// Channels that are disabled.
IsEnabled *bool `mandatory:"false" contributesTo:"query" name:"isEnabled"`
// The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.
SortBy ListChannelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use (ASC or DESC).
SortOrder ListChannelsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListChannelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListChannelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListChannelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListChannelsRequest) String() string
func (request ListChannelsRequest) 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
ListChannelsResponse wrapper for the ListChannels operation
type ListChannelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ChannelSummary instances
Items []ChannelSummary `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 ListChannelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListChannelsResponse) String() string
ListChannelsSortByEnum Enum with underlying type: string
type ListChannelsSortByEnum string
Set of constants representing the allowable values for ListChannelsSortByEnum
const (
ListChannelsSortByDisplayname ListChannelsSortByEnum = "displayName"
ListChannelsSortByTimecreated ListChannelsSortByEnum = "timeCreated"
)
func GetListChannelsSortByEnumValues() []ListChannelsSortByEnum
GetListChannelsSortByEnumValues Enumerates the set of values for ListChannelsSortByEnum
func GetMappingListChannelsSortByEnum(val string) (ListChannelsSortByEnum, bool)
GetMappingListChannelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListChannelsSortOrderEnum Enum with underlying type: string
type ListChannelsSortOrderEnum string
Set of constants representing the allowable values for ListChannelsSortOrderEnum
const (
ListChannelsSortOrderAsc ListChannelsSortOrderEnum = "ASC"
ListChannelsSortOrderDesc ListChannelsSortOrderEnum = "DESC"
)
func GetListChannelsSortOrderEnumValues() []ListChannelsSortOrderEnum
GetListChannelsSortOrderEnumValues Enumerates the set of values for ListChannelsSortOrderEnum
func GetMappingListChannelsSortOrderEnum(val string) (ListChannelsSortOrderEnum, bool)
GetMappingListChannelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListConfigurationsRequest wrapper for the ListConfigurations operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListConfigurations.go.html to see an example of how to use ListConfigurationsRequest.
type ListConfigurationsRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The requested Configuration instance.
ConfigurationId *string `mandatory:"false" contributesTo:"query" name:"configurationId"`
// Configuration Lifecycle State
LifecycleState ConfigurationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The requested Configuration types.
Type []ListConfigurationsTypeEnum `contributesTo:"query" name:"type" omitEmpty:"true" collectionFormat:"multi"`
// A filter to return only the resource matching the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The requested Shape name.
ShapeName *string `mandatory:"false" contributesTo:"query" name:"shapeName"`
// The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.
SortBy ListConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use (ASC or DESC).
SortOrder ListConfigurationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListConfigurationsRequest) String() string
func (request ListConfigurationsRequest) 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
ListConfigurationsResponse wrapper for the ListConfigurations operation
type ListConfigurationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ConfigurationSummary instances
Items []ConfigurationSummary `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 ListConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListConfigurationsResponse) String() string
ListConfigurationsSortByEnum Enum with underlying type: string
type ListConfigurationsSortByEnum string
Set of constants representing the allowable values for ListConfigurationsSortByEnum
const (
ListConfigurationsSortByDisplayname ListConfigurationsSortByEnum = "displayName"
ListConfigurationsSortByShapename ListConfigurationsSortByEnum = "shapeName"
ListConfigurationsSortByTimecreated ListConfigurationsSortByEnum = "timeCreated"
ListConfigurationsSortByTimeupdated ListConfigurationsSortByEnum = "timeUpdated"
)
func GetListConfigurationsSortByEnumValues() []ListConfigurationsSortByEnum
GetListConfigurationsSortByEnumValues Enumerates the set of values for ListConfigurationsSortByEnum
func GetMappingListConfigurationsSortByEnum(val string) (ListConfigurationsSortByEnum, bool)
GetMappingListConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListConfigurationsSortOrderEnum Enum with underlying type: string
type ListConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListConfigurationsSortOrderEnum
const (
ListConfigurationsSortOrderAsc ListConfigurationsSortOrderEnum = "ASC"
ListConfigurationsSortOrderDesc ListConfigurationsSortOrderEnum = "DESC"
)
func GetListConfigurationsSortOrderEnumValues() []ListConfigurationsSortOrderEnum
GetListConfigurationsSortOrderEnumValues Enumerates the set of values for ListConfigurationsSortOrderEnum
func GetMappingListConfigurationsSortOrderEnum(val string) (ListConfigurationsSortOrderEnum, bool)
GetMappingListConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListConfigurationsTypeEnum Enum with underlying type: string
type ListConfigurationsTypeEnum string
Set of constants representing the allowable values for ListConfigurationsTypeEnum
const (
ListConfigurationsTypeDefault ListConfigurationsTypeEnum = "DEFAULT"
ListConfigurationsTypeCustom ListConfigurationsTypeEnum = "CUSTOM"
)
func GetListConfigurationsTypeEnumValues() []ListConfigurationsTypeEnum
GetListConfigurationsTypeEnumValues Enumerates the set of values for ListConfigurationsTypeEnum
func GetMappingListConfigurationsTypeEnum(val string) (ListConfigurationsTypeEnum, bool)
GetMappingListConfigurationsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListDbSystemsDatabaseManagementEnum Enum with underlying type: string
type ListDbSystemsDatabaseManagementEnum string
Set of constants representing the allowable values for ListDbSystemsDatabaseManagementEnum
const (
ListDbSystemsDatabaseManagementEnabled ListDbSystemsDatabaseManagementEnum = "ENABLED"
ListDbSystemsDatabaseManagementDisabled ListDbSystemsDatabaseManagementEnum = "DISABLED"
)
func GetListDbSystemsDatabaseManagementEnumValues() []ListDbSystemsDatabaseManagementEnum
GetListDbSystemsDatabaseManagementEnumValues Enumerates the set of values for ListDbSystemsDatabaseManagementEnum
func GetMappingListDbSystemsDatabaseManagementEnum(val string) (ListDbSystemsDatabaseManagementEnum, bool)
GetMappingListDbSystemsDatabaseManagementEnum performs case Insensitive comparison on enum value and return the desired enum
ListDbSystemsRequest wrapper for the ListDbSystems operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListDbSystems.go.html to see an example of how to use ListDbSystemsRequest.
type ListDbSystemsRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// If true, return only DB Systems with a HeatWave cluster attached, if false
// return only DB Systems with no HeatWave cluster attached. If not
// present, return all DB Systems.
IsHeatWaveClusterAttached *bool `mandatory:"false" contributesTo:"query" name:"isHeatWaveClusterAttached"`
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"false" contributesTo:"query" name:"dbSystemId"`
// A filter to return only the resource matching the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// DbSystem Lifecycle State
LifecycleState DbSystemLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The requested Configuration instance.
ConfigurationId *string `mandatory:"false" contributesTo:"query" name:"configurationId"`
// Filter instances if they are using the latest revision of the
// Configuration they are associated with.
IsUpToDate *bool `mandatory:"false" contributesTo:"query" name:"isUpToDate"`
// Filter DB Systems by their Database Management configuration.
DatabaseManagement []ListDbSystemsDatabaseManagementEnum `contributesTo:"query" name:"databaseManagement" omitEmpty:"true" collectionFormat:"multi"`
// The field to sort by. Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.
SortBy ListDbSystemsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use (ASC or DESC).
SortOrder ListDbSystemsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListDbSystemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDbSystemsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDbSystemsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDbSystemsRequest) String() string
func (request ListDbSystemsRequest) 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
ListDbSystemsResponse wrapper for the ListDbSystems operation
type ListDbSystemsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []DbSystemSummary instances
Items []DbSystemSummary `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 ListDbSystemsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDbSystemsResponse) String() string
ListDbSystemsSortByEnum Enum with underlying type: string
type ListDbSystemsSortByEnum string
Set of constants representing the allowable values for ListDbSystemsSortByEnum
const (
ListDbSystemsSortByDisplayname ListDbSystemsSortByEnum = "displayName"
ListDbSystemsSortByTimecreated ListDbSystemsSortByEnum = "timeCreated"
)
func GetListDbSystemsSortByEnumValues() []ListDbSystemsSortByEnum
GetListDbSystemsSortByEnumValues Enumerates the set of values for ListDbSystemsSortByEnum
func GetMappingListDbSystemsSortByEnum(val string) (ListDbSystemsSortByEnum, bool)
GetMappingListDbSystemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDbSystemsSortOrderEnum Enum with underlying type: string
type ListDbSystemsSortOrderEnum string
Set of constants representing the allowable values for ListDbSystemsSortOrderEnum
const (
ListDbSystemsSortOrderAsc ListDbSystemsSortOrderEnum = "ASC"
ListDbSystemsSortOrderDesc ListDbSystemsSortOrderEnum = "DESC"
)
func GetListDbSystemsSortOrderEnumValues() []ListDbSystemsSortOrderEnum
GetListDbSystemsSortOrderEnumValues Enumerates the set of values for ListDbSystemsSortOrderEnum
func GetMappingListDbSystemsSortOrderEnum(val string) (ListDbSystemsSortOrderEnum, bool)
GetMappingListDbSystemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListReplicasRequest wrapper for the ListReplicas operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListReplicas.go.html to see an example of how to use ListReplicasRequest.
type ListReplicasRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// A filter to return only the resource matching the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"false" contributesTo:"query" name:"dbSystemId"`
// The LifecycleState of the read replica.
LifecycleState ReplicaSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The read replica OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
ReplicaId *string `mandatory:"false" contributesTo:"query" name:"replicaId"`
// The requested Configuration instance.
ConfigurationId *string `mandatory:"false" contributesTo:"query" name:"configurationId"`
// Filter instances if they are using the latest revision of the
// Configuration they are associated with.
IsUpToDate *bool `mandatory:"false" contributesTo:"query" name:"isUpToDate"`
// The field to sort by. You can sort by one field only. By default, the Time field is sorted in descending order and the Display Name field in ascending order.
SortBy ListReplicasSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use (ASC or DESC).
SortOrder ListReplicasSortOrderEnum `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 ListReplicasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListReplicasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListReplicasRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListReplicasRequest) String() string
func (request ListReplicasRequest) 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
ListReplicasResponse wrapper for the ListReplicas operation
type ListReplicasResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ReplicaSummary instances
Items []ReplicaSummary `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 ListReplicasResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListReplicasResponse) String() string
ListReplicasSortByEnum Enum with underlying type: string
type ListReplicasSortByEnum string
Set of constants representing the allowable values for ListReplicasSortByEnum
const (
ListReplicasSortByTimecreated ListReplicasSortByEnum = "timeCreated"
ListReplicasSortByDisplayname ListReplicasSortByEnum = "displayName"
)
func GetListReplicasSortByEnumValues() []ListReplicasSortByEnum
GetListReplicasSortByEnumValues Enumerates the set of values for ListReplicasSortByEnum
func GetMappingListReplicasSortByEnum(val string) (ListReplicasSortByEnum, bool)
GetMappingListReplicasSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListReplicasSortOrderEnum Enum with underlying type: string
type ListReplicasSortOrderEnum string
Set of constants representing the allowable values for ListReplicasSortOrderEnum
const (
ListReplicasSortOrderAsc ListReplicasSortOrderEnum = "ASC"
ListReplicasSortOrderDesc ListReplicasSortOrderEnum = "DESC"
)
func GetListReplicasSortOrderEnumValues() []ListReplicasSortOrderEnum
GetListReplicasSortOrderEnumValues Enumerates the set of values for ListReplicasSortOrderEnum
func GetMappingListReplicasSortOrderEnum(val string) (ListReplicasSortOrderEnum, bool)
GetMappingListReplicasSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListShapesIsSupportedForEnum Enum with underlying type: string
type ListShapesIsSupportedForEnum string
Set of constants representing the allowable values for ListShapesIsSupportedForEnum
const (
ListShapesIsSupportedForDbsystem ListShapesIsSupportedForEnum = "DBSYSTEM"
ListShapesIsSupportedForHeatwavecluster ListShapesIsSupportedForEnum = "HEATWAVECLUSTER"
)
func GetListShapesIsSupportedForEnumValues() []ListShapesIsSupportedForEnum
GetListShapesIsSupportedForEnumValues Enumerates the set of values for ListShapesIsSupportedForEnum
func GetMappingListShapesIsSupportedForEnum(val string) (ListShapesIsSupportedForEnum, bool)
GetMappingListShapesIsSupportedForEnum performs case Insensitive comparison on enum value and return the desired enum
ListShapesRequest wrapper for the ListShapes operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListShapes.go.html to see an example of how to use ListShapesRequest.
type ListShapesRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Return shapes that are supported by the service feature.
IsSupportedFor []ListShapesIsSupportedForEnum `contributesTo:"query" name:"isSupportedFor" omitEmpty:"true" collectionFormat:"multi"`
// The name of the Availability Domain.
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// Name
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// 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 ListShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListShapesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListShapesRequest) String() string
func (request ListShapesRequest) 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
ListShapesResponse wrapper for the ListShapes operation
type ListShapesResponse struct {
// The underlying http response
RawResponse *http.Response
// The []ShapeSummary instance
Items []ShapeSummary `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"`
}
func (response ListShapesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListShapesResponse) String() string
ListVersionsRequest wrapper for the ListVersions operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListVersions.go.html to see an example of how to use ListVersionsRequest.
type ListVersionsRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVersionsRequest) String() string
func (request ListVersionsRequest) 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
ListVersionsResponse wrapper for the ListVersions operation
type ListVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// The []VersionSummary instance
Items []VersionSummary `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"`
}
func (response ListVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVersionsResponse) String() string
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// the ID of the WorkRequest
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 []WorkRequestError instances
Items []WorkRequestError `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 ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// the ID of the WorkRequest
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 []WorkRequestLogEntry instances
Items []WorkRequestLogEntry `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 ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The compartment OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Customer-defined unique identifier for the request. If you need to
// contact Oracle about a specific request, please provide the request
// ID that you supplied in this header with the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The optional field to sort the results by.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use (ASC or DESC).
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return in a paginated list call. For information about pagination, see
// List Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` or `opc-prev-page` response header from
// the previous list call. For information about pagination, see List
// Pagination (https://docs.cloud.oracle.comAPI/Concepts/usingapi.htm#List_Pagination).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 []WorkRequestSummary instances
Items []WorkRequestSummary `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 (
ListWorkRequestsSortById ListWorkRequestsSortByEnum = "ID"
ListWorkRequestsSortByOperationType ListWorkRequestsSortByEnum = "OPERATION_TYPE"
ListWorkRequestsSortByStatus ListWorkRequestsSortByEnum = "STATUS"
ListWorkRequestsSortByTimeAccepted ListWorkRequestsSortByEnum = "TIME_ACCEPTED"
ListWorkRequestsSortByTimeStarted ListWorkRequestsSortByEnum = "TIME_STARTED"
ListWorkRequestsSortByTimeFinished ListWorkRequestsSortByEnum = "TIME_FINISHED"
)
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
MaintenanceDetails The Maintenance Policy for the DB System or Read Replica that this model is included in.
type MaintenanceDetails struct {
// The start time of the maintenance window.
// This string is of the format: "{day-of-week} {time-of-day}".
// "{day-of-week}" is a case-insensitive string like "mon", "tue", &c.
// "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
// If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window.
WindowStartTime *string `mandatory:"false" json:"windowStartTime"`
}
func (m MaintenanceDetails) String() string
func (m MaintenanceDetails) 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
MysqlaasClient a client for Mysqlaas
type MysqlaasClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewMysqlaasClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client MysqlaasClient, err error)
NewMysqlaasClientWithConfigurationProvider Creates a new default Mysqlaas client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewMysqlaasClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client MysqlaasClient, err error)
NewMysqlaasClientWithOboToken Creates a new default Mysqlaas 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 *MysqlaasClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client MysqlaasClient) CreateConfiguration(ctx context.Context, request CreateConfigurationRequest) (response CreateConfigurationResponse, err error)
CreateConfiguration Creates a new Configuration.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/CreateConfiguration.go.html to see an example of how to use CreateConfiguration API.
func (client MysqlaasClient) DeleteConfiguration(ctx context.Context, request DeleteConfigurationRequest) (response DeleteConfigurationResponse, err error)
DeleteConfiguration Deletes a Configuration. The Configuration must not be in use by any DB Systems.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/DeleteConfiguration.go.html to see an example of how to use DeleteConfiguration API. A default retry strategy applies to this operation DeleteConfiguration()
func (client MysqlaasClient) GetConfiguration(ctx context.Context, request GetConfigurationRequest) (response GetConfigurationResponse, err error)
GetConfiguration Get the full details of the specified Configuration, including the list of MySQL Variables and their values.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/GetConfiguration.go.html to see an example of how to use GetConfiguration API. A default retry strategy applies to this operation GetConfiguration()
func (client MysqlaasClient) ListConfigurations(ctx context.Context, request ListConfigurationsRequest) (response ListConfigurationsResponse, err error)
ListConfigurations Lists the Configurations available when creating a DB System. This may include DEFAULT configurations per Shape and CUSTOM configurations. The default sort order is a multi-part sort by:
- shapeName, ascending - DEFAULT-before-CUSTOM - displayName ascending
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListConfigurations.go.html to see an example of how to use ListConfigurations API. A default retry strategy applies to this operation ListConfigurations()
func (client MysqlaasClient) ListShapes(ctx context.Context, request ListShapesRequest) (response ListShapesResponse, err error)
ListShapes Gets a list of the shapes you can use to create a new MySQL DB System. The shape determines the resources allocated to the DB System: CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListShapes.go.html to see an example of how to use ListShapes API. A default retry strategy applies to this operation ListShapes()
func (client MysqlaasClient) ListVersions(ctx context.Context, request ListVersionsRequest) (response ListVersionsResponse, err error)
ListVersions Get a list of supported and available MySQL database major versions. The list is sorted by version family.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/ListVersions.go.html to see an example of how to use ListVersions API. A default retry strategy applies to this operation ListVersions()
func (client *MysqlaasClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client MysqlaasClient) UpdateConfiguration(ctx context.Context, request UpdateConfigurationRequest) (response UpdateConfigurationResponse, err error)
UpdateConfiguration Updates the Configuration details.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/mysql/UpdateConfiguration.go.html to see an example of how to use UpdateConfiguration API. A default retry strategy applies to this operation UpdateConfiguration()
PemCaCertificate The CA certificate in PEM format.
type PemCaCertificate struct {
// The string containing the CA certificate in PEM format.
Contents *string `mandatory:"true" json:"contents"`
}
func (m PemCaCertificate) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PemCaCertificate) String() string
func (m PemCaCertificate) 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
PitrPolicy The PITR policy for the DB System.
type PitrPolicy struct {
// Specifies if PITR is enabled or disabled.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
}
func (m PitrPolicy) String() string
func (m PitrPolicy) 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
PointInTimeRecoveryDetails Point-in-time Recovery details like earliest and latest recovery time point for the DB System.
type PointInTimeRecoveryDetails struct {
// Earliest recovery time point for the DB System, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeEarliestRecoveryPoint *common.SDKTime `mandatory:"true" json:"timeEarliestRecoveryPoint"`
// Latest recovery time point for the DB System, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeLatestRecoveryPoint *common.SDKTime `mandatory:"true" json:"timeLatestRecoveryPoint"`
}
func (m PointInTimeRecoveryDetails) String() string
func (m PointInTimeRecoveryDetails) 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
Replica A DB System read replica.
type Replica struct {
// The OCID of the read replica.
Id *string `mandatory:"true" json:"id"`
// The OCID of the DB System the read replica is associated with.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The OCID of the compartment that contains the read replica.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The user-friendly name for the read replica. It does not have to be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// The state of the read replica.
LifecycleState ReplicaLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the read replica was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The MySQL version currently in use by the read replica.
MysqlVersion *string `mandatory:"true" json:"mysqlVersion"`
// The IP address the read replica is configured to listen on.
IpAddress *string `mandatory:"true" json:"ipAddress"`
// The port the read replica is configured to listen on.
Port *int `mandatory:"true" json:"port"`
// The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
PortX *int `mandatory:"true" json:"portX"`
// User provided description of the read replica.
Description *string `mandatory:"false" json:"description"`
// A message describing the state of the read replica.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time the read replica was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The name of the Availability Domain the read replica is located in.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The name of the Fault Domain the read replica is located in.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow.
// Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If
// the DB System is delete protected, read replicas can still be deleted individually if they are not delete
// protected themselves.
IsDeleteProtected *bool `mandatory:"false" json:"isDeleteProtected"`
// The shape currently in use by the read replica. The shape determines the resources allocated:
// CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes.
// To get a list of shapes, use the ListShapes operation.
ShapeName *string `mandatory:"false" json:"shapeName"`
// The OCID of the Configuration currently in use by the read replica.
ConfigurationId *string `mandatory:"false" json:"configurationId"`
ReplicaOverrides *ReplicaOverrides `mandatory:"false" json:"replicaOverrides"`
}
func (m Replica) String() string
func (m Replica) 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
ReplicaLifecycleStateEnum Enum with underlying type: string
type ReplicaLifecycleStateEnum string
Set of constants representing the allowable values for ReplicaLifecycleStateEnum
const (
ReplicaLifecycleStateCreating ReplicaLifecycleStateEnum = "CREATING"
ReplicaLifecycleStateActive ReplicaLifecycleStateEnum = "ACTIVE"
ReplicaLifecycleStateInactive ReplicaLifecycleStateEnum = "INACTIVE"
ReplicaLifecycleStateUpdating ReplicaLifecycleStateEnum = "UPDATING"
ReplicaLifecycleStateDeleting ReplicaLifecycleStateEnum = "DELETING"
ReplicaLifecycleStateDeleted ReplicaLifecycleStateEnum = "DELETED"
ReplicaLifecycleStateNeedsAttention ReplicaLifecycleStateEnum = "NEEDS_ATTENTION"
ReplicaLifecycleStateFailed ReplicaLifecycleStateEnum = "FAILED"
)
func GetMappingReplicaLifecycleStateEnum(val string) (ReplicaLifecycleStateEnum, bool)
GetMappingReplicaLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicaLifecycleStateEnumValues() []ReplicaLifecycleStateEnum
GetReplicaLifecycleStateEnumValues Enumerates the set of values for ReplicaLifecycleStateEnum
ReplicaOverrides By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system.
type ReplicaOverrides struct {
// The MySQL version to be used by the read replica.
MysqlVersion *string `mandatory:"false" json:"mysqlVersion"`
// The shape to be used by the read replica. The shape determines the resources allocated:
// CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes.
// To get a list of shapes, use the ListShapes operation.
ShapeName *string `mandatory:"false" json:"shapeName"`
// The OCID of the Configuration to be used by the read replica.
ConfigurationId *string `mandatory:"false" json:"configurationId"`
}
func (m ReplicaOverrides) String() string
func (m ReplicaOverrides) 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
ReplicaSummary Summary of the read replica.
type ReplicaSummary struct {
// The OCID of the read replica.
Id *string `mandatory:"true" json:"id"`
// The OCID of the DB System the read replica is associated with.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// The OCID of the compartment that contains the read replica.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The user-friendly name for the read replica. It does not have to be unique.
DisplayName *string `mandatory:"true" json:"displayName"`
// The state of the read replica.
LifecycleState ReplicaSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the read replica was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The MySQL version currently in use by the read replica.
MysqlVersion *string `mandatory:"true" json:"mysqlVersion"`
// The IP address the read replica is configured to listen on.
IpAddress *string `mandatory:"true" json:"ipAddress"`
// The port the read replica is configured to listen on.
Port *int `mandatory:"true" json:"port"`
// The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
PortX *int `mandatory:"true" json:"portX"`
// User provided description of the read replica.
Description *string `mandatory:"false" json:"description"`
// A message describing the state of the read replica.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time the read replica was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The name of the Availability Domain the read replica is located in.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The name of the Fault Domain the read replica is located in.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow.
// Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If
// the DB System is delete protected, read replicas can still be deleted individually if they are not delete
// protected themselves.
IsDeleteProtected *bool `mandatory:"false" json:"isDeleteProtected"`
// The shape currently in use by the read replica. The shape determines the resources allocated:
// CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes.
// To get a list of shapes, use the ListShapes operation.
ShapeName *string `mandatory:"false" json:"shapeName"`
// The OCID of the Configuration currently in use by the read replica.
ConfigurationId *string `mandatory:"false" json:"configurationId"`
ReplicaOverrides *ReplicaOverrides `mandatory:"false" json:"replicaOverrides"`
}
func (m ReplicaSummary) String() string
func (m ReplicaSummary</