AddAnalyticsClusterDetails Details required to add an Analytics Cluster.
type AddAnalyticsClusterDetails struct { // The shape determines resources to allocate to the Analytics // Cluster nodes - CPU cores, memory. ShapeName *string `mandatory:"true" json:"shapeName"` // The number of analytics-processing nodes provisioned for the // Analytics Cluster. ClusterSize *int `mandatory:"true" json:"clusterSize"` }
func (m AddAnalyticsClusterDetails) String() string
AddAnalyticsClusterRequest wrapper for the AddAnalyticsCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/AddAnalyticsCluster.go.html to see an example of how to use AddAnalyticsClusterRequest.
type AddAnalyticsClusterRequest 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 an Analytics Cluster. AddAnalyticsClusterDetails `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 AddAnalyticsClusterRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddAnalyticsClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddAnalyticsClusterRequest) String() string
AddAnalyticsClusterResponse wrapper for the AddAnalyticsCluster operation
type AddAnalyticsClusterResponse struct { // The underlying http response RawResponse *http.Response // The AnalyticsCluster instance AnalyticsCluster `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 AddAnalyticsClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddAnalyticsClusterResponse) String() string
AnalyticsCluster An Analytics Cluster is a database accelerator for a DB System.
type AnalyticsCluster struct { // The OCID of the parent DB System this Analytics Cluster is attached to. DbSystemId *string `mandatory:"true" json:"dbSystemId"` // The shape determines resources to allocate to the Analytics // Cluster nodes - CPU cores, memory. ShapeName *string `mandatory:"true" json:"shapeName"` // The number of analytics-processing compute instances, of the // specified shape, in the Analytics Cluster. ClusterSize *int `mandatory:"true" json:"clusterSize"` // An Analytics Cluster Node is a compute host that is part of an Analytics Cluster. ClusterNodes []AnalyticsClusterNode `mandatory:"true" json:"clusterNodes"` // The current state of the Analytics Cluster. LifecycleState AnalyticsClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The date and time the Analytics Cluster was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The time the Analytics Cluster was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"` // Additional information about the current lifecycleState. LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"` }
func (m AnalyticsCluster) String() string
AnalyticsClusterLifecycleStateEnum Enum with underlying type: string
type AnalyticsClusterLifecycleStateEnum string
Set of constants representing the allowable values for AnalyticsClusterLifecycleStateEnum
const ( AnalyticsClusterLifecycleStateCreating AnalyticsClusterLifecycleStateEnum = "CREATING" AnalyticsClusterLifecycleStateActive AnalyticsClusterLifecycleStateEnum = "ACTIVE" AnalyticsClusterLifecycleStateInactive AnalyticsClusterLifecycleStateEnum = "INACTIVE" AnalyticsClusterLifecycleStateUpdating AnalyticsClusterLifecycleStateEnum = "UPDATING" AnalyticsClusterLifecycleStateDeleting AnalyticsClusterLifecycleStateEnum = "DELETING" AnalyticsClusterLifecycleStateDeleted AnalyticsClusterLifecycleStateEnum = "DELETED" AnalyticsClusterLifecycleStateFailed AnalyticsClusterLifecycleStateEnum = "FAILED" )
func GetAnalyticsClusterLifecycleStateEnumValues() []AnalyticsClusterLifecycleStateEnum
GetAnalyticsClusterLifecycleStateEnumValues Enumerates the set of values for AnalyticsClusterLifecycleStateEnum
AnalyticsClusterMemoryEstimate Analytics Cluster memory estimate that can be used to determine a suitable Analytics Cluster size. For each MySQL user table the estimated memory footprint when the table is loaded to the Analytics Cluster memory is returned.
type AnalyticsClusterMemoryEstimate struct { // The OCID of the DB System the Analytics Cluster memory estimate is associated with. DbSystemId *string `mandatory:"true" json:"dbSystemId"` // Current status of the Work Request generating the Analytics Cluster memory estimate. Status AnalyticsClusterMemoryEstimateStatusEnum `mandatory:"true" json:"status"` // The date and time that the Work Request to generate the Analytics 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 Analytics 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 Analytics Cluster memory. TableSchemas []AnalyticsClusterSchemaMemoryEstimate `mandatory:"true" json:"tableSchemas"` }
func (m AnalyticsClusterMemoryEstimate) String() string
AnalyticsClusterMemoryEstimateStatusEnum Enum with underlying type: string
type AnalyticsClusterMemoryEstimateStatusEnum string
Set of constants representing the allowable values for AnalyticsClusterMemoryEstimateStatusEnum
const ( AnalyticsClusterMemoryEstimateStatusAccepted AnalyticsClusterMemoryEstimateStatusEnum = "ACCEPTED" AnalyticsClusterMemoryEstimateStatusInProgress AnalyticsClusterMemoryEstimateStatusEnum = "IN_PROGRESS" AnalyticsClusterMemoryEstimateStatusFailed AnalyticsClusterMemoryEstimateStatusEnum = "FAILED" AnalyticsClusterMemoryEstimateStatusSucceeded AnalyticsClusterMemoryEstimateStatusEnum = "SUCCEEDED" AnalyticsClusterMemoryEstimateStatusCanceling AnalyticsClusterMemoryEstimateStatusEnum = "CANCELING" AnalyticsClusterMemoryEstimateStatusCanceled AnalyticsClusterMemoryEstimateStatusEnum = "CANCELED" )
func GetAnalyticsClusterMemoryEstimateStatusEnumValues() []AnalyticsClusterMemoryEstimateStatusEnum
GetAnalyticsClusterMemoryEstimateStatusEnumValues Enumerates the set of values for AnalyticsClusterMemoryEstimateStatusEnum
AnalyticsClusterNode An Analytics Cluster Node is a compute host that is part of an Analytics Cluster.
type AnalyticsClusterNode struct { // The ID of the node within MySQL Analytics Cluster. NodeId *string `mandatory:"true" json:"nodeId"` // The current state of the MySQL Analytics Cluster node. LifecycleState AnalyticsClusterNodeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The date and time the MySQL Analytics Cluster 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 Analytics Cluster node was updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` }
func (m AnalyticsClusterNode) String() string
AnalyticsClusterNodeLifecycleStateEnum Enum with underlying type: string
type AnalyticsClusterNodeLifecycleStateEnum string
Set of constants representing the allowable values for AnalyticsClusterNodeLifecycleStateEnum
const ( AnalyticsClusterNodeLifecycleStateCreating AnalyticsClusterNodeLifecycleStateEnum = "CREATING" AnalyticsClusterNodeLifecycleStateActive AnalyticsClusterNodeLifecycleStateEnum = "ACTIVE" AnalyticsClusterNodeLifecycleStateInactive AnalyticsClusterNodeLifecycleStateEnum = "INACTIVE" AnalyticsClusterNodeLifecycleStateUpdating AnalyticsClusterNodeLifecycleStateEnum = "UPDATING" AnalyticsClusterNodeLifecycleStateDeleting AnalyticsClusterNodeLifecycleStateEnum = "DELETING" AnalyticsClusterNodeLifecycleStateDeleted AnalyticsClusterNodeLifecycleStateEnum = "DELETED" AnalyticsClusterNodeLifecycleStateFailed AnalyticsClusterNodeLifecycleStateEnum = "FAILED" )
func GetAnalyticsClusterNodeLifecycleStateEnumValues() []AnalyticsClusterNodeLifecycleStateEnum
GetAnalyticsClusterNodeLifecycleStateEnumValues Enumerates the set of values for AnalyticsClusterNodeLifecycleStateEnum
AnalyticsClusterSchemaMemoryEstimate Schema with estimated memory footprints for each MySQL user table of the schema when loaded to Analytics Cluster memory.
type AnalyticsClusterSchemaMemoryEstimate 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 Analytics Cluster memory. PerTableEstimates []AnalyticsClusterTableMemoryEstimate `mandatory:"true" json:"perTableEstimates"` }
func (m AnalyticsClusterSchemaMemoryEstimate) String() string
AnalyticsClusterSummary A summary of an Analytics Cluster.
type AnalyticsClusterSummary struct { // The shape determines resources to allocate to the Analytics // Cluster nodes - CPU cores, memory. ShapeName *string `mandatory:"true" json:"shapeName"` // The number of analytics-processing compute instances, of the // specified shape, in the Analytics Cluster. ClusterSize *int `mandatory:"true" json:"clusterSize"` // The current state of the MySQL Analytics Cluster. LifecycleState AnalyticsClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // The date and time the Analytics Cluster was created, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // The time the Analytics Cluster was last updated, as described by RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"` }
func (m AnalyticsClusterSummary) String() string
AnalyticsClusterTableMemoryEstimate Estimated memory footprint for a MySQL user table when loaded to the Analytics Cluster memory.
type AnalyticsClusterTableMemoryEstimate struct { // The table name. TableName *string `mandatory:"true" json:"tableName"` // The number of columns to be loaded to Analytics 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 Analytics 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 // Analytics Cluster memory (null if the table cannot be loaded to the // Analytics Cluster). AnalyticalFootprintInMbs *int64 `mandatory:"true" json:"analyticalFootprintInMbs"` // Error comment (empty string if no errors occured). ErrorComment *string `mandatory:"true" json:"errorComment"` }
func (m AnalyticsClusterTableMemoryEstimate) String() string
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"` // 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"` // 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
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
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" )
func GetBackupCreationTypeEnumValues() []BackupCreationTypeEnum
GetBackupCreationTypeEnumValues Enumerates the set of values for BackupCreationTypeEnum
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
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"` }
func (m BackupPolicy) String() string
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"` // 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
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
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
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
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"` // 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
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
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
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
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"` }
func (m ChannelTargetDbSystem) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ChannelTargetDbSystem) String() string
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
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/CreateChannel.go.html to see an example of how to use CreateChannel API.
func (client ChannelsClient) DeleteChannel(ctx context.Context, request DeleteChannelRequest) (response DeleteChannelResponse, err error)
DeleteChannel Deletes the specified Channel.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/DeleteChannel.go.html to see an example of how to use DeleteChannel API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetChannel.go.html to see an example of how to use GetChannel API.
func (client ChannelsClient) ListChannels(ctx context.Context, request ListChannelsRequest) (response ListChannelsResponse, err error)
ListChannels Lists all the Channels that match the specified filters.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListChannels.go.html to see an example of how to use ListChannels API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ResetChannel.go.html to see an example of how to use ResetChannel API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ResumeChannel.go.html to see an example of how to use ResumeChannel API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateChannel.go.html to see an example of how to use UpdateChannel API.
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"` // 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
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
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
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
ConfigurationVariables User controllable service variables.
type ConfigurationVariables struct { // ("completion_type") CompletionType ConfigurationVariablesCompletionTypeEnum `mandatory:"false" json:"completionType,omitempty"` // ("default_authentication_plugin") DefaultAuthenticationPlugin ConfigurationVariablesDefaultAuthenticationPluginEnum `mandatory:"false" json:"defaultAuthenticationPlugin,omitempty"` // ("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"` // ("innodb_ft_enable_stopword") InnodbFtEnableStopword *bool `mandatory:"false" json:"innodbFtEnableStopword"` // ("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"` // ("binlog_expire_logs_seconds") DEPRECATED -- variable should not be settable and will be ignored BinlogExpireLogsSeconds *int `mandatory:"false" json:"binlogExpireLogsSeconds"` // ("innodb_buffer_pool_size") InnodbBufferPoolSize *int64 `mandatory:"false" json:"innodbBufferPoolSize"` // ("innodb_ft_result_cache_limit") InnodbFtResultCacheLimit *int `mandatory:"false" json:"innodbFtResultCacheLimit"` // ("max_connections") MaxConnections *int `mandatory:"false" json:"maxConnections"` // ("max_prepared_stmt_count") MaxPreparedStmtCount *int `mandatory:"false" json:"maxPreparedStmtCount"` // ("connect_timeout") ConnectTimeout *int `mandatory:"false" json:"connectTimeout"` // ("cte_max_recursion_depth") CteMaxRecursionDepth *int `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"` // ("innodb_buffer_pool_instances") InnodbBufferPoolInstances *int `mandatory:"false" json:"innodbBufferPoolInstances"` // ("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"` // ("innodb_max_purge_lag") InnodbMaxPurgeLag *int `mandatory:"false" json:"innodbMaxPurgeLag"` // ("innodb_max_purge_lag_delay") InnodbMaxPurgeLagDelay *int `mandatory:"false" json:"innodbMaxPurgeLagDelay"` // ("max_execution_time") MaxExecutionTime *int `mandatory:"false" json:"maxExecutionTime"` // ("mysqlx_connect_timeout") DEPRECATED -- variable should not be settable and will be ignored 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"` // ("mysqlx_interactive_timeout") DEPRECATED -- variable should not be settable and will be ignored MysqlxInteractiveTimeout *int `mandatory:"false" json:"mysqlxInteractiveTimeout"` // ("mysqlx_max_allowed_packet") DEPRECATED -- variable should not be settable and will be ignored 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"` // ("mysqlx_read_timeout") DEPRECATED -- variable should not be settable and will be ignored MysqlxReadTimeout *int `mandatory:"false" json:"mysqlxReadTimeout"` // ("mysqlx_wait_timeout") DEPRECATED -- variable should not be settable and will be ignored MysqlxWaitTimeout *int `mandatory:"false" json:"mysqlxWaitTimeout"` // ("mysqlx_write_timeout") DEPRECATED -- variable should not be settable and will be ignored MysqlxWriteTimeout *int `mandatory:"false" json:"mysqlxWriteTimeout"` // ("parser_max_mem_size") ParserMaxMemSize *int `mandatory:"false" json:"parserMaxMemSize"` // ("query_alloc_block_size") DEPRECATED -- variable should not be settable and will be ignored QueryAllocBlockSize *int `mandatory:"false" json:"queryAllocBlockSize"` // ("query_prealloc_size") DEPRECATED -- variable should not be settable and will be ignored QueryPreallocSize *int `mandatory:"false" json:"queryPreallocSize"` // ("sql_mode") SqlMode *string `mandatory:"false" json:"sqlMode"` // 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"` }
func (m ConfigurationVariables) String() string
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
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
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
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
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
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"` }
func (m CreateBackupPolicyDetails) String() string
CreateBackupRequest wrapper for the CreateBackup operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
CreateChannelRequest wrapper for the CreateChannel operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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"` // 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
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"` }
func (m CreateChannelTargetFromDbSystemDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateChannelTargetFromDbSystemDetails) String() string
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"` 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
CreateConfigurationRequest wrapper for the CreateConfiguration operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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 username for the administrative user. AdminUsername *string `mandatory:"true" 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:"true" json:"adminPassword"` // 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"` // The Availability Domain where the primary instance 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 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"` // 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"` }
func (m CreateDbSystemDetails) String() string
func (m *CreateDbSystemDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
CreateDbSystemRequest wrapper for the CreateDbSystem operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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" CreateDbSystemSourceDetailsSourceTypeImporturl CreateDbSystemSourceDetailsSourceTypeEnum = "IMPORTURL" )
func GetCreateDbSystemSourceDetailsSourceTypeEnumValues() []CreateDbSystemSourceDetailsSourceTypeEnum
GetCreateDbSystemSourceDetailsSourceTypeEnumValues Enumerates the set of values for CreateDbSystemSourceDetailsSourceTypeEnum
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
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
CreateDbSystemSourceImportFromUrlDetails An Object Storage PAR from which to import the DB System initial data.
type CreateDbSystemSourceImportFromUrlDetails struct { // The Pre-Authenticated Request (PAR) URL of the file you want to import from Object Storage. SourceUrl *string `mandatory:"true" json:"sourceUrl"` }
func (m CreateDbSystemSourceImportFromUrlDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDbSystemSourceImportFromUrlDetails) String() string
CreateMaintenanceDetails The Maintenance Policy for the DB System.
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. WindowStartTime *string `mandatory:"true" json:"windowStartTime"` }
func (m CreateMaintenanceDetails) String() string
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) 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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/CreateBackup.go.html to see an example of how to use CreateBackup API.
func (client DbBackupsClient) DeleteBackup(ctx context.Context, request DeleteBackupRequest) (response DeleteBackupResponse, err error)
DeleteBackup Delete a Backup.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/DeleteBackup.go.html to see an example of how to use DeleteBackup API.
func (client DbBackupsClient) GetBackup(ctx context.Context, request GetBackupRequest) (response GetBackupResponse, err error)
GetBackup Get information about the specified Backup
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetBackup.go.html to see an example of how to use GetBackup API.
func (client DbBackupsClient) ListBackups(ctx context.Context, request ListBackupsRequest) (response ListBackupsResponse, err error)
ListBackups Get a list of DB System backups.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListBackups.go.html to see an example of how to use ListBackups API.
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateBackup.go.html to see an example of how to use UpdateBackup API.
DbSystem A DB System is the core logical unit of MySQL Database Service. # NOTE: definitions/DbSystemSnapshot is a snapshot version of DbSystem which is stored during backup. Any # addition/deletion of properties should also consider snapshot's definition
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"` // 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"` // If the DB System has an Analytics Cluster attached. IsAnalyticsClusterAttached *bool `mandatory:"false" json:"isAnalyticsClusterAttached"` AnalyticsCluster *AnalyticsClusterSummary `mandatory:"false" json:"analyticsCluster"` // 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"` 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"` }
func (m DbSystem) String() string
func (m *DbSystem) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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) AddAnalyticsCluster(ctx context.Context, request AddAnalyticsClusterRequest) (response AddAnalyticsClusterResponse, err error)
AddAnalyticsCluster Adds an Analytics Cluster to the DB System.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/AddAnalyticsCluster.go.html to see an example of how to use AddAnalyticsCluster API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/CreateDbSystem.go.html to see an example of how to use CreateDbSystem API.
func (client DbSystemClient) DeleteAnalyticsCluster(ctx context.Context, request DeleteAnalyticsClusterRequest) (response DeleteAnalyticsClusterResponse, err error)
DeleteAnalyticsCluster Deletes the Analytics Cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/DeleteAnalyticsCluster.go.html to see an example of how to use DeleteAnalyticsCluster API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/DeleteDbSystem.go.html to see an example of how to use DeleteDbSystem API.
func (client DbSystemClient) GenerateAnalyticsClusterMemoryEstimate(ctx context.Context, request GenerateAnalyticsClusterMemoryEstimateRequest) (response GenerateAnalyticsClusterMemoryEstimateResponse, err error)
GenerateAnalyticsClusterMemoryEstimate Sends a request to estimate the memory footprints of user tables when loaded to Analytics Cluster memory.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GenerateAnalyticsClusterMemoryEstimate.go.html to see an example of how to use GenerateAnalyticsClusterMemoryEstimate API.
func (client DbSystemClient) GetAnalyticsCluster(ctx context.Context, request GetAnalyticsClusterRequest) (response GetAnalyticsClusterResponse, err error)
GetAnalyticsCluster Gets information about the Analytics Cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetAnalyticsCluster.go.html to see an example of how to use GetAnalyticsCluster API.
func (client DbSystemClient) GetAnalyticsClusterMemoryEstimate(ctx context.Context, request GetAnalyticsClusterMemoryEstimateRequest) (response GetAnalyticsClusterMemoryEstimateResponse, err error)
GetAnalyticsClusterMemoryEstimate Gets the most recent Analytics Cluster memory estimate that can be used to determine a suitable Analytics Cluster size.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetAnalyticsClusterMemoryEstimate.go.html to see an example of how to use GetAnalyticsClusterMemoryEstimate API.
func (client DbSystemClient) GetDbSystem(ctx context.Context, request GetDbSystemRequest) (response GetDbSystemResponse, err error)
GetDbSystem Get information about the specified DB System.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetDbSystem.go.html to see an example of how to use GetDbSystem API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListDbSystems.go.html to see an example of how to use ListDbSystems API.
func (client DbSystemClient) RestartAnalyticsCluster(ctx context.Context, request RestartAnalyticsClusterRequest) (response RestartAnalyticsClusterResponse, err error)
RestartAnalyticsCluster Restarts the Analytics Cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/RestartAnalyticsCluster.go.html to see an example of how to use RestartAnalyticsCluster API.
func (client DbSystemClient) RestartDbSystem(ctx context.Context, request RestartDbSystemRequest) (response RestartDbSystemResponse, err error)
RestartDbSystem Restarts the specified DB System.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/RestartDbSystem.go.html to see an example of how to use RestartDbSystem API.
func (client *DbSystemClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DbSystemClient) StartAnalyticsCluster(ctx context.Context, request StartAnalyticsClusterRequest) (response StartAnalyticsClusterResponse, err error)
StartAnalyticsCluster Starts the Analytics Cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/StartAnalyticsCluster.go.html to see an example of how to use StartAnalyticsCluster API.
func (client DbSystemClient) StartDbSystem(ctx context.Context, request StartDbSystemRequest) (response StartDbSystemResponse, err error)
StartDbSystem Start the specified DB System.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/StartDbSystem.go.html to see an example of how to use StartDbSystem API.
func (client DbSystemClient) StopAnalyticsCluster(ctx context.Context, request StopAnalyticsClusterRequest) (response StopAnalyticsClusterResponse, err error)
StopAnalyticsCluster Stops the Analytics Cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/StopAnalyticsCluster.go.html to see an example of how to use StopAnalyticsCluster API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/StopDbSystem.go.html to see an example of how to use StopDbSystem API.
func (client DbSystemClient) UpdateAnalyticsCluster(ctx context.Context, request UpdateAnalyticsClusterRequest) (response UpdateAnalyticsClusterResponse, err error)
UpdateAnalyticsCluster Updates the Analytics Cluster.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateAnalyticsCluster.go.html to see an example of how to use UpdateAnalyticsCluster API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateDbSystem.go.html to see an example of how to use UpdateDbSystem API.
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"` }
func (m DbSystemEndpoint) String() string
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
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
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
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"` // 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"` // 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"` }
func (m DbSystemSnapshot) String() string
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
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
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
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" DbSystemSourceSourceTypeImporturl DbSystemSourceSourceTypeEnum = "IMPORTURL" )
func GetDbSystemSourceSourceTypeEnumValues() []DbSystemSourceSourceTypeEnum
GetDbSystemSourceSourceTypeEnumValues Enumerates the set of values for DbSystemSourceSourceTypeEnum
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"` // If the DB System has an Analytics Cluster attached. IsAnalyticsClusterAttached *bool `mandatory:"false" json:"isAnalyticsClusterAttached"` AnalyticsCluster *AnalyticsClusterSummary `mandatory:"false" json:"analyticsCluster"` // 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 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"` }
func (m DbSystemSummary) String() string
DeleteAnalyticsClusterRequest wrapper for the DeleteAnalyticsCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/DeleteAnalyticsCluster.go.html to see an example of how to use DeleteAnalyticsClusterRequest.
type DeleteAnalyticsClusterRequest 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 DeleteAnalyticsClusterRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAnalyticsClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAnalyticsClusterRequest) String() string
DeleteAnalyticsClusterResponse wrapper for the DeleteAnalyticsCluster operation
type DeleteAnalyticsClusterResponse 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 DeleteAnalyticsClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAnalyticsClusterResponse) String() string
DeleteBackupRequest wrapper for the DeleteBackup operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
GenerateAnalyticsClusterMemoryEstimateRequest wrapper for the GenerateAnalyticsClusterMemoryEstimate operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GenerateAnalyticsClusterMemoryEstimate.go.html to see an example of how to use GenerateAnalyticsClusterMemoryEstimateRequest.
type GenerateAnalyticsClusterMemoryEstimateRequest 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 GenerateAnalyticsClusterMemoryEstimateRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateAnalyticsClusterMemoryEstimateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateAnalyticsClusterMemoryEstimateRequest) String() string
GenerateAnalyticsClusterMemoryEstimateResponse wrapper for the GenerateAnalyticsClusterMemoryEstimate operation
type GenerateAnalyticsClusterMemoryEstimateResponse struct { // The underlying http response RawResponse *http.Response // The AnalyticsClusterMemoryEstimate instance AnalyticsClusterMemoryEstimate `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 GenerateAnalyticsClusterMemoryEstimateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateAnalyticsClusterMemoryEstimateResponse) String() string
GetAnalyticsClusterMemoryEstimateRequest wrapper for the GetAnalyticsClusterMemoryEstimate operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetAnalyticsClusterMemoryEstimate.go.html to see an example of how to use GetAnalyticsClusterMemoryEstimateRequest.
type GetAnalyticsClusterMemoryEstimateRequest 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 GetAnalyticsClusterMemoryEstimateRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnalyticsClusterMemoryEstimateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnalyticsClusterMemoryEstimateRequest) String() string
GetAnalyticsClusterMemoryEstimateResponse wrapper for the GetAnalyticsClusterMemoryEstimate operation
type GetAnalyticsClusterMemoryEstimateResponse struct { // The underlying http response RawResponse *http.Response // The AnalyticsClusterMemoryEstimate instance AnalyticsClusterMemoryEstimate `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 GetAnalyticsClusterMemoryEstimateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnalyticsClusterMemoryEstimateResponse) String() string
GetAnalyticsClusterRequest wrapper for the GetAnalyticsCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetAnalyticsCluster.go.html to see an example of how to use GetAnalyticsClusterRequest.
type GetAnalyticsClusterRequest 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 GetAnalyticsClusterRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnalyticsClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnalyticsClusterRequest) String() string
GetAnalyticsClusterResponse wrapper for the GetAnalyticsCluster operation
type GetAnalyticsClusterResponse struct { // The underlying http response RawResponse *http.Response // The AnalyticsCluster instance AnalyticsCluster `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 GetAnalyticsClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnalyticsClusterResponse) String() string
GetBackupRequest wrapper for the GetBackup operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
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
ListBackupsRequest wrapper for the ListBackups operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
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
ListChannelsRequest wrapper for the ListChannels operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
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
ListConfigurationsRequest wrapper for the ListConfigurations operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
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
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
ListDbSystemsRequest wrapper for the ListDbSystems operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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 an Analytics Cluster attached, if false // return only DB Systems with no Analytics Cluster attached. If not // present, return all DB Systems. IsAnalyticsClusterAttached *bool `mandatory:"false" contributesTo:"query" name:"isAnalyticsClusterAttached"` // 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"` // 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) HTTPRequest(method, path 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
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
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
ListShapesIsSupportedForEnum Enum with underlying type: string
type ListShapesIsSupportedForEnum string
Set of constants representing the allowable values for ListShapesIsSupportedForEnum
const ( ListShapesIsSupportedForDbsystem ListShapesIsSupportedForEnum = "DBSYSTEM" ListShapesIsSupportedForAnalyticscluster ListShapesIsSupportedForEnum = "ANALYTICSCLUSTER" )
func GetListShapesIsSupportedForEnumValues() []ListShapesIsSupportedForEnum
GetListShapesIsSupportedForEnumValues Enumerates the set of values for ListShapesIsSupportedForEnum
ListShapesRequest wrapper for the ListShapes operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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) HTTPRequest(method, path 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
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
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
MaintenanceDetails The Maintenance Policy for the DB System.
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. WindowStartTime *string `mandatory:"false" json:"windowStartTime"` }
func (m MaintenanceDetails) String() string
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/DeleteConfiguration.go.html to see an example of how to use DeleteConfiguration API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetConfiguration.go.html to see an example of how to use GetConfiguration API.
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
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListConfigurations.go.html to see an example of how to use ListConfigurations API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListShapes.go.html to see an example of how to use ListShapes API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListVersions.go.html to see an example of how to use ListVersions API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateConfiguration.go.html to see an example of how to use UpdateConfiguration API.
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
ResetChannelRequest wrapper for the ResetChannel operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ResetChannel.go.html to see an example of how to use ResetChannelRequest.
type ResetChannelRequest 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"` // 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 ResetChannelRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResetChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResetChannelRequest) String() string
ResetChannelResponse wrapper for the ResetChannel operation
type ResetChannelResponse 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 ResetChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResetChannelResponse) String() string
RestartAnalyticsClusterRequest wrapper for the RestartAnalyticsCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/RestartAnalyticsCluster.go.html to see an example of how to use RestartAnalyticsClusterRequest.
type RestartAnalyticsClusterRequest 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"` // 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 RestartAnalyticsClusterRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestartAnalyticsClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestartAnalyticsClusterRequest) String() string
RestartAnalyticsClusterResponse wrapper for the RestartAnalyticsCluster operation
type RestartAnalyticsClusterResponse 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 RestartAnalyticsClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestartAnalyticsClusterResponse) String() string
RestartDbSystemDetails DB System restart parameters.
type RestartDbSystemDetails struct { // The InnoDB shutdown mode to use, following the option // "innodb_fast_shutdown (https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_fast_shutdown)". ShutdownType InnoDbShutdownModeEnum `mandatory:"true" json:"shutdownType"` }
func (m RestartDbSystemDetails) String() string
RestartDbSystemRequest wrapper for the RestartDbSystem operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/RestartDbSystem.go.html to see an example of how to use RestartDbSystemRequest.
type RestartDbSystemRequest struct { // The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"` // Optional parameters for the stop portion of the restart action. RestartDbSystemDetails `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 RestartDbSystemRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestartDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestartDbSystemRequest) String() string
RestartDbSystemResponse wrapper for the RestartDbSystem operation
type RestartDbSystemResponse 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 RestartDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestartDbSystemResponse) String() string
ResumeChannelRequest wrapper for the ResumeChannel operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ResumeChannel.go.html to see an example of how to use ResumeChannelRequest.
type ResumeChannelRequest 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"` // 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 ResumeChannelRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResumeChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResumeChannelRequest) String() string
ResumeChannelResponse wrapper for the ResumeChannel operation
type ResumeChannelResponse 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 ResumeChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResumeChannelResponse) String() string
ShapeSummary The shape of the DB System. The shape determines resources to allocate to the DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. For a description of shapes, see DB System Shape Options (https://docs.cloud.oracle.com/mysql-database/doc/shapes.htm).
type ShapeSummary struct { // The name of the shape used for the DB System. Name *string `mandatory:"true" json:"name"` // The number of CPU Cores the Instance provides. These are "OCPU"s. CpuCoreCount *int `mandatory:"true" json:"cpuCoreCount"` // The amount of RAM the Instance provides. This is an IEC base-2 number. MemorySizeInGBs *int `mandatory:"true" json:"memorySizeInGBs"` // What service features the shape is supported for. IsSupportedFor []ShapeSummaryIsSupportedForEnum `mandatory:"false" json:"isSupportedFor,omitempty"` }
func (m ShapeSummary) String() string
ShapeSummaryIsSupportedForEnum Enum with underlying type: string
type ShapeSummaryIsSupportedForEnum string
Set of constants representing the allowable values for ShapeSummaryIsSupportedForEnum
const ( ShapeSummaryIsSupportedForDbsystem ShapeSummaryIsSupportedForEnum = "DBSYSTEM" ShapeSummaryIsSupportedForAnalyticscluster ShapeSummaryIsSupportedForEnum = "ANALYTICSCLUSTER" )
func GetShapeSummaryIsSupportedForEnumValues() []ShapeSummaryIsSupportedForEnum
GetShapeSummaryIsSupportedForEnumValues Enumerates the set of values for ShapeSummaryIsSupportedForEnum
StartAnalyticsClusterRequest wrapper for the StartAnalyticsCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/StartAnalyticsCluster.go.html to see an example of how to use StartAnalyticsClusterRequest.
type StartAnalyticsClusterRequest 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"` // 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 StartAnalyticsClusterRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartAnalyticsClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartAnalyticsClusterRequest) String() string
StartAnalyticsClusterResponse wrapper for the StartAnalyticsCluster operation
type StartAnalyticsClusterResponse 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 StartAnalyticsClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartAnalyticsClusterResponse) String() string
StartDbSystemRequest wrapper for the StartDbSystem operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/StartDbSystem.go.html to see an example of how to use StartDbSystemRequest.
type StartDbSystemRequest 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"` // 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 StartDbSystemRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartDbSystemRequest) String() string
StartDbSystemResponse wrapper for the StartDbSystem operation
type StartDbSystemResponse 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 StartDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartDbSystemResponse) String() string
StopAnalyticsClusterRequest wrapper for the StopAnalyticsCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/StopAnalyticsCluster.go.html to see an example of how to use StopAnalyticsClusterRequest.
type StopAnalyticsClusterRequest 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"` // 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 StopAnalyticsClusterRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopAnalyticsClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopAnalyticsClusterRequest) String() string
StopAnalyticsClusterResponse wrapper for the StopAnalyticsCluster operation
type StopAnalyticsClusterResponse 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 StopAnalyticsClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopAnalyticsClusterResponse) String() string
StopDbSystemDetails DB System shutdown parameters.
type StopDbSystemDetails struct { // The InnoDB shutdown mode to use, following the option // "innodb_fast_shutdown (https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_fast_shutdown)". ShutdownType InnoDbShutdownModeEnum `mandatory:"true" json:"shutdownType"` }
func (m StopDbSystemDetails) String() string
StopDbSystemRequest wrapper for the StopDbSystem operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/StopDbSystem.go.html to see an example of how to use StopDbSystemRequest.
type StopDbSystemRequest struct { // The DB System OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"` // Optional parameters for the stop action. StopDbSystemDetails `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 StopDbSystemRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopDbSystemRequest) String() string
StopDbSystemResponse wrapper for the StopDbSystem operation
type StopDbSystemResponse 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 StopDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopDbSystemResponse) String() string
UpdateAnalyticsClusterDetails Details about the Analytics Cluster properties to be updated.
type UpdateAnalyticsClusterDetails struct { // A change to the shape of the nodes in the Analytics Cluster will // result in the entire cluster being torn down and re-created with // Compute instances of the new Shape. This may result in significant // downtime for the analytics capability while the Analytics Cluster is // re-provisioned. ShapeName *string `mandatory:"false" json:"shapeName"` // A change to the number of nodes in the Analytics Cluster will result // in the entire cluster being torn down and re-created with the new // cluster of nodes. This may result in a significant downtime for the // analytics capability while the Analytics Cluster is // re-provisioned. ClusterSize *int `mandatory:"false" json:"clusterSize"` }
func (m UpdateAnalyticsClusterDetails) String() string
UpdateAnalyticsClusterRequest wrapper for the UpdateAnalyticsCluster operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateAnalyticsCluster.go.html to see an example of how to use UpdateAnalyticsClusterRequest.
type UpdateAnalyticsClusterRequest 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 update an Analytics Cluster. UpdateAnalyticsClusterDetails `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"` // 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 UpdateAnalyticsClusterRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAnalyticsClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAnalyticsClusterRequest) String() string
UpdateAnalyticsClusterResponse wrapper for the UpdateAnalyticsCluster operation
type UpdateAnalyticsClusterResponse 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 UpdateAnalyticsClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAnalyticsClusterResponse) String() string
UpdateBackupDetails The Backup metadata which can be updated.
type UpdateBackupDetails struct { // 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 number of days backups are retained. 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 UpdateBackupDetails) String() string
UpdateBackupPolicyDetails Backup Policy as optionally used for DB System update.
type UpdateBackupPolicyDetails 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"` }
func (m UpdateBackupPolicyDetails) String() string
UpdateBackupRequest wrapper for the UpdateBackup operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateBackup.go.html to see an example of how to use UpdateBackupRequest.
type UpdateBackupRequest struct { // The OCID of the Backup BackupId *string `mandatory:"true" contributesTo:"path" name:"backupId"` // Request to update a Backup's metadata. UpdateBackupDetails `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"` // 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 UpdateBackupRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBackupRequest) String() string
UpdateBackupResponse wrapper for the UpdateBackup operation
type UpdateBackupResponse 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"` // 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 UpdateBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBackupResponse) String() string
UpdateChannelDetails Details required to update a Channel
type UpdateChannelDetails struct { Source UpdateChannelSourceDetails `mandatory:"false" json:"source"` Target UpdateChannelTargetDetails `mandatory:"false" json:"target"` // 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 or disabled. Enabling a previously // disabled Channel will cause the Channel to be started. Conversely, disabling // a previously enabled Channel will stop the Channel. Both operations are // executed asynchronously. IsEnabled *bool `mandatory:"false" json:"isEnabled"` // User provided description of 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 UpdateChannelDetails) String() string
func (m *UpdateChannelDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
UpdateChannelRequest wrapper for the UpdateChannel operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateChannel.go.html to see an example of how to use UpdateChannelRequest.
type UpdateChannelRequest struct { // The Channel OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"` // The parameters of the request to update the Channel. UpdateChannelDetails `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 UpdateChannelRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateChannelRequest) String() string
UpdateChannelResponse wrapper for the UpdateChannel operation
type UpdateChannelResponse 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 UpdateChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateChannelResponse) String() string
UpdateChannelSourceDetails Parameters detailing how to provision the source for the given Channel.
type UpdateChannelSourceDetails interface { }
UpdateChannelSourceFromMysqlDetails 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 UpdateChannelSourceFromMysqlDetails struct { // The network address of the MySQL instance. Hostname *string `mandatory:"false" json:"hostname"` // The port the source MySQL instance listens on. Port *int `mandatory:"false" 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:"false" 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:"false" json:"password"` SslCaCertificate CaCertificate `mandatory:"false" json:"sslCaCertificate"` // The SSL mode of the Channel. SslMode ChannelSourceMysqlSslModeEnum `mandatory:"false" json:"sslMode,omitempty"` }
func (m UpdateChannelSourceFromMysqlDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateChannelSourceFromMysqlDetails) String() string
func (m *UpdateChannelSourceFromMysqlDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
UpdateChannelTargetDetails Parameters detailing how to provision the target for the given Channel.
type UpdateChannelTargetDetails interface { }
UpdateChannelTargetFromDbSystemDetails Parameters detailing how to provision the target endpoint that is a DB System.
type UpdateChannelTargetFromDbSystemDetails struct { // 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"` }
func (m UpdateChannelTargetFromDbSystemDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateChannelTargetFromDbSystemDetails) String() string
UpdateConfigurationDetails The details required to update a Configuration.
type UpdateConfigurationDetails struct { // User-provided data about the Configuration. Description *string `mandatory:"false" json:"description"` // A new display name for the Configuration. DisplayName *string `mandatory:"false" json:"displayName"` // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. // Example: `{"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 UpdateConfigurationDetails) String() string
UpdateConfigurationRequest wrapper for the UpdateConfiguration operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateConfiguration.go.html to see an example of how to use UpdateConfigurationRequest.
type UpdateConfigurationRequest struct { // The OCID of the Configuration. ConfigurationId *string `mandatory:"true" contributesTo:"path" name:"configurationId"` // Request to update a Configuration. UpdateConfigurationDetails `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"` // 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 UpdateConfigurationRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateConfigurationRequest) String() string
UpdateConfigurationResponse wrapper for the UpdateConfiguration operation
type UpdateConfigurationResponse 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"` }
func (response UpdateConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateConfigurationResponse) String() string
UpdateDbSystemDetails Details required to update a DB System.
type UpdateDbSystemDetails struct { // 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"` // The OCID of the subnet the DB System is associated with. SubnetId *string `mandatory:"false" json:"subnetId"` // The Availability Domain where the primary instance 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 DB System. The shape determines 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. To get a list of shapes, use the // ListShapes // operation. // Changes in Shape will result in a downtime as the MySQL DB System is // migrated to the new Compute instance. ShapeName *string `mandatory:"false" json:"shapeName"` // The specific MySQL version identifier. MysqlVersion *string `mandatory:"false" json:"mysqlVersion"` // The OCID of the Configuration to be used for Instances in this DB System. ConfigurationId *string `mandatory:"false" json:"configurationId"` // The username for the administrative user for the MySQL Instance. 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"` // New size of the data volume in GBs that will be created and attached. // Increases in data storage size will happen asynchronously and will require DB System downtime. // Decreases in data storage size are not supported. 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 should be configured to listen on the provided subnet. // It must be a free private 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 *UpdateBackupPolicyDetails `mandatory:"false" json:"backupPolicy"` Maintenance *UpdateMaintenanceDetails `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"` }
func (m UpdateDbSystemDetails) String() string
UpdateDbSystemRequest wrapper for the UpdateDbSystem operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/UpdateDbSystem.go.html to see an example of how to use UpdateDbSystemRequest.
type UpdateDbSystemRequest 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 update a DB System. UpdateDbSystemDetails `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"` // 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 UpdateDbSystemRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDbSystemRequest) String() string
UpdateDbSystemResponse wrapper for the UpdateDbSystem operation
type UpdateDbSystemResponse 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 UpdateDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDbSystemResponse) String() string
UpdateMaintenanceDetails The Maintenance Policy for the DB System.
type UpdateMaintenanceDetails 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. WindowStartTime *string `mandatory:"false" json:"windowStartTime"` }
func (m UpdateMaintenanceDetails) String() string
Version A supported MySQL Version.
type Version struct { // The specific version identifier Version *string `mandatory:"false" json:"version"` // A link to a page describing the version. Description *string `mandatory:"false" json:"description"` }
func (m Version) String() string
VersionSummary A summary of the supported MySQL Versions families, and a list of their supported minor versions.
type VersionSummary struct { // The list of supported MySQL Versions. Versions []Version `mandatory:"true" json:"versions"` // A descriptive summary of a group of versions. VersionFamily *string `mandatory:"false" json:"versionFamily"` }
func (m VersionSummary) String() string
WorkRequest The status of an asynchronous task in the system.
type WorkRequest struct { // The id of the work request. Id *string `mandatory:"true" json:"id"` // the original operation ID requested OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"` // Current status of the work request Status WorkRequestOperationStatusEnum `mandatory:"true" json:"status"` // The ocid of the compartment that contains the work request. Work // requests should be scoped to the same compartment as the resource // the work request affects. If the work request affects multiple // resources, and those resources are not in the same compartment, it // is up to the service team to pick the primary resource whose // compartment should be used CompartmentId *string `mandatory:"true" json:"compartmentId"` // The resources affected by this work request. Resources []WorkRequestResource `mandatory:"true" json:"resources"` // Percentage of the request completed. PercentComplete *float32 `mandatory:"true" json:"percentComplete"` // The date and time the request was created, as described in // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"` // The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), // section 14.29. TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"` // The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` }
func (m WorkRequest) String() string
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct { // A machine-usable code for the error that occured. Error codes are listed on // (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) Code *string `mandatory:"true" json:"code"` // A human readable description of the issue encountered. Message *string `mandatory:"true" json:"message"` // The time the error occured. An RFC3339 formatted datetime string. Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"` }
func (m WorkRequestError) String() string
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct { // Human-readable log message. Message *string `mandatory:"true" json:"message"` // The time the log message was written. An RFC3339 formatted datetime string Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"` }
func (m WorkRequestLogEntry) String() string
WorkRequestOperationStatusEnum Enum with underlying type: string
type WorkRequestOperationStatusEnum string
Set of constants representing the allowable values for WorkRequestOperationStatusEnum
const ( WorkRequestOperationStatusAccepted WorkRequestOperationStatusEnum = "ACCEPTED" WorkRequestOperationStatusInProgress WorkRequestOperationStatusEnum = "IN_PROGRESS" WorkRequestOperationStatusFailed WorkRequestOperationStatusEnum = "FAILED" WorkRequestOperationStatusSucceeded WorkRequestOperationStatusEnum = "SUCCEEDED" WorkRequestOperationStatusCanceling WorkRequestOperationStatusEnum = "CANCELING" WorkRequestOperationStatusCanceled WorkRequestOperationStatusEnum = "CANCELED" )
func GetWorkRequestOperationStatusEnumValues() []WorkRequestOperationStatusEnum
GetWorkRequestOperationStatusEnumValues Enumerates the set of values for WorkRequestOperationStatusEnum
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const ( WorkRequestOperationTypeCreateDbsystem WorkRequestOperationTypeEnum = "CREATE_DBSYSTEM" WorkRequestOperationTypeUpdateDbsystem WorkRequestOperationTypeEnum = "UPDATE_DBSYSTEM" WorkRequestOperationTypeDeleteDbsystem WorkRequestOperationTypeEnum = "DELETE_DBSYSTEM" WorkRequestOperationTypeStartDbsystem WorkRequestOperationTypeEnum = "START_DBSYSTEM" WorkRequestOperationTypeStopDbsystem WorkRequestOperationTypeEnum = "STOP_DBSYSTEM" WorkRequestOperationTypeRestartDbsystem WorkRequestOperationTypeEnum = "RESTART_DBSYSTEM" WorkRequestOperationTypeAddAnalyticsCluster WorkRequestOperationTypeEnum = "ADD_ANALYTICS_CLUSTER" WorkRequestOperationTypeUpdateAnalyticsCluster WorkRequestOperationTypeEnum = "UPDATE_ANALYTICS_CLUSTER" WorkRequestOperationTypeDeleteAnalyticsCluster WorkRequestOperationTypeEnum = "DELETE_ANALYTICS_CLUSTER" WorkRequestOperationTypeStartAnalyticsCluster WorkRequestOperationTypeEnum = "START_ANALYTICS_CLUSTER" WorkRequestOperationTypeStopAnalyticsCluster WorkRequestOperationTypeEnum = "STOP_ANALYTICS_CLUSTER" WorkRequestOperationTypeRestartAnalyticsCluster WorkRequestOperationTypeEnum = "RESTART_ANALYTICS_CLUSTER" WorkRequestOperationTypeGenerateAnalyticsClusterMemoryEstimate WorkRequestOperationTypeEnum = "GENERATE_ANALYTICS_CLUSTER_MEMORY_ESTIMATE" )
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct { // The resource type the work request affects. EntityType *string `mandatory:"true" json:"entityType"` // The way in which this resource is affected by the work tracked in the work request. // A resource being created, updated, or deleted will remain in the IN_PROGRESS state until // work is complete for that resource at which point it will transition to CREATED, UPDATED, // or DELETED, respectively. ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"` // The identifier of the resource the work request affects. Identifier *string `mandatory:"true" json:"identifier"` // The URI path the user can do a GET on to access the resource. EntityUri *string `mandatory:"false" json:"entityUri"` }
func (m WorkRequestResource) String() string
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const ( WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED" WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED" WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED" WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS" WorkRequestResourceActionTypeRelated WorkRequestResourceActionTypeEnum = "RELATED" )
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestSummary The status of an asynchronous task in the system.
type WorkRequestSummary struct { // The id of the work request. Id *string `mandatory:"true" json:"id"` // the original operation ID requested OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"` // Current status of the work request Status WorkRequestOperationStatusEnum `mandatory:"true" json:"status"` // The ocid of the compartment that contains the work request. Work // requests should be scoped to the same compartment as the resource // the work request affects. If the work request affects multiple // resources, and those resources are not in the same compartment, it // is up to the service team to pick the primary resource whose // compartment should be used CompartmentId *string `mandatory:"true" json:"compartmentId"` // Percentage of the request completed. PercentComplete *float32 `mandatory:"true" json:"percentComplete"` // The date and time the request was created, as described in // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"` // The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), // section 14.29. TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"` // The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339). TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` }
func (m WorkRequestSummary) String() string
WorkRequestsClient a client for WorkRequests
type WorkRequestsClient struct { common.BaseClient // contains filtered or unexported fields }
func NewWorkRequestsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestsClient, err error)
NewWorkRequestsClientWithConfigurationProvider Creates a new default WorkRequests client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewWorkRequestsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestsClient, err error)
NewWorkRequestsClientWithOboToken Creates a new default WorkRequests 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 *WorkRequestsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client WorkRequestsClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client WorkRequestsClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client WorkRequestsClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client WorkRequestsClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a specified compartment.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/mysql/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *WorkRequestsClient) SetRegion(region string)
SetRegion overrides the region of this client.