func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetBackupLifecycleStateEnumStringValues() []string
GetBackupLifecycleStateEnumStringValues Enumerates the set of values in String for BackupLifecycleStateEnum
func GetBackupPolicyKindEnumStringValues() []string
GetBackupPolicyKindEnumStringValues Enumerates the set of values in String for BackupPolicyKindEnum
func GetBackupSourceTypeEnumStringValues() []string
GetBackupSourceTypeEnumStringValues Enumerates the set of values in String for BackupSourceTypeEnum
func GetConfigurationLifecycleStateEnumStringValues() []string
GetConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for ConfigurationLifecycleStateEnum
func GetDbInstanceLifecycleStateEnumStringValues() []string
GetDbInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for DbInstanceLifecycleStateEnum
func GetDbSystemLifecycleStateEnumStringValues() []string
GetDbSystemLifecycleStateEnumStringValues Enumerates the set of values in String for DbSystemLifecycleStateEnum
func GetDbSystemSystemTypeEnumStringValues() []string
GetDbSystemSystemTypeEnumStringValues Enumerates the set of values in String for DbSystemSystemTypeEnum
func GetDefaultConfigurationLifecycleStateEnumStringValues() []string
GetDefaultConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for DefaultConfigurationLifecycleStateEnum
func GetGetDbSystemExcludedFieldsEnumStringValues() []string
GetGetDbSystemExcludedFieldsEnumStringValues Enumerates the set of values in String for GetDbSystemExcludedFieldsEnum
func GetListBackupsSortByEnumStringValues() []string
GetListBackupsSortByEnumStringValues Enumerates the set of values in String for ListBackupsSortByEnum
func GetListBackupsSortOrderEnumStringValues() []string
GetListBackupsSortOrderEnumStringValues Enumerates the set of values in String for ListBackupsSortOrderEnum
func GetListConfigurationsSortByEnumStringValues() []string
GetListConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListConfigurationsSortByEnum
func GetListConfigurationsSortOrderEnumStringValues() []string
GetListConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListConfigurationsSortOrderEnum
func GetListDbSystemsSortByEnumStringValues() []string
GetListDbSystemsSortByEnumStringValues Enumerates the set of values in String for ListDbSystemsSortByEnum
func GetListDbSystemsSortOrderEnumStringValues() []string
GetListDbSystemsSortOrderEnumStringValues Enumerates the set of values in String for ListDbSystemsSortOrderEnum
func GetListDefaultConfigurationsSortByEnumStringValues() []string
GetListDefaultConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListDefaultConfigurationsSortByEnum
func GetListDefaultConfigurationsSortOrderEnumStringValues() []string
GetListDefaultConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListDefaultConfigurationsSortOrderEnum
func GetListShapesSortByEnumStringValues() []string
GetListShapesSortByEnumStringValues Enumerates the set of values in String for ListShapesSortByEnum
func GetListShapesSortOrderEnumStringValues() []string
GetListShapesSortOrderEnumStringValues Enumerates the set of values in String for ListShapesSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetPasswordDetailsPasswordTypeEnumStringValues() []string
GetPasswordDetailsPasswordTypeEnumStringValues Enumerates the set of values in String for PasswordDetailsPasswordTypeEnum
func GetPatchInsertInstructionPositionEnumStringValues() []string
GetPatchInsertInstructionPositionEnumStringValues Enumerates the set of values in String for PatchInsertInstructionPositionEnum
func GetPatchInstructionOperationEnumStringValues() []string
GetPatchInstructionOperationEnumStringValues Enumerates the set of values in String for PatchInstructionOperationEnum
func GetPatchMoveInstructionPositionEnumStringValues() []string
GetPatchMoveInstructionPositionEnumStringValues Enumerates the set of values in String for PatchMoveInstructionPositionEnum
func GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumStringValues() []string
GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumStringValues Enumerates the set of values in String for RestartDbInstanceInDbSystemDetailsRestartTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetSourceDetailsSourceTypeEnumStringValues() []string
GetSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for SourceDetailsSourceTypeEnum
func GetUpdateDbConfigParamsApplyConfigEnumStringValues() []string
GetUpdateDbConfigParamsApplyConfigEnumStringValues Enumerates the set of values in String for UpdateDbConfigParamsApplyConfigEnum
func GetWeeklyBackupPolicyDaysOfTheWeekEnumStringValues() []string
GetWeeklyBackupPolicyDaysOfTheWeekEnumStringValues Enumerates the set of values in String for WeeklyBackupPolicyDaysOfTheWeekEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Backup Database system backup information.
type Backup struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the backup.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the backup. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the backup.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the backup was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the backup.
LifecycleState BackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The size of the backup, in gigabytes.
BackupSize *int `mandatory:"true" json:"backupSize"`
DbSystemDetails *DbSystemDetails `mandatory:"true" json:"dbSystemDetails"`
// 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:"true" 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:"true" json:"definedTags"`
// A description for the backup.
Description *string `mandatory:"false" json:"description"`
// Specifies whether the backup was created manually, or by a management policy.
SourceType BackupSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// The date and time the backup was updated, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Backup retention period in days.
RetentionPeriod *int `mandatory:"false" json:"retentionPeriod"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the backup's source database system.
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// lastAcceptedRequestToken from MP.
LastAcceptedRequestToken *string `mandatory:"false" json:"lastAcceptedRequestToken"`
// lastCompletedRequestToken from MP.
LastCompletedRequestToken *string `mandatory:"false" json:"lastCompletedRequestToken"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Backup) String() string
func (m Backup) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupCollection Results of a backup search. Contains the BackupSummary items and other information, such as metadata.
type BackupCollection struct {
// List of backups.
Items []BackupSummary `mandatory:"true" json:"items"`
}
func (m BackupCollection) String() string
func (m BackupCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"
BackupLifecycleStateDeleting BackupLifecycleStateEnum = "DELETING"
BackupLifecycleStateDeleted BackupLifecycleStateEnum = "DELETED"
BackupLifecycleStateFailed BackupLifecycleStateEnum = "FAILED"
)
func GetBackupLifecycleStateEnumValues() []BackupLifecycleStateEnum
GetBackupLifecycleStateEnumValues Enumerates the set of values for BackupLifecycleStateEnum
func GetMappingBackupLifecycleStateEnum(val string) (BackupLifecycleStateEnum, bool)
GetMappingBackupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BackupPolicy PostgreSQL database system backup policy.
type BackupPolicy interface {
// How many days the data should be stored after the database system deletion.
GetRetentionDays() *int
}
BackupPolicyKindEnum Enum with underlying type: string
type BackupPolicyKindEnum string
Set of constants representing the allowable values for BackupPolicyKindEnum
const (
BackupPolicyKindDaily BackupPolicyKindEnum = "DAILY"
BackupPolicyKindWeekly BackupPolicyKindEnum = "WEEKLY"
BackupPolicyKindMonthly BackupPolicyKindEnum = "MONTHLY"
BackupPolicyKindNone BackupPolicyKindEnum = "NONE"
)
func GetBackupPolicyKindEnumValues() []BackupPolicyKindEnum
GetBackupPolicyKindEnumValues Enumerates the set of values for BackupPolicyKindEnum
func GetMappingBackupPolicyKindEnum(val string) (BackupPolicyKindEnum, bool)
GetMappingBackupPolicyKindEnum performs case Insensitive comparison on enum value and return the desired enum
BackupSourceDetails Restoring to a new database system from the backup. The database system details that are part of the CreateDbSystem request are not required, but if present will override the details from the backup's database system snapshot.
type BackupSourceDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database system backup.
BackupId *string `mandatory:"true" json:"backupId"`
// Deprecated. Don't use.
IsHavingRestoreConfigOverrides *bool `mandatory:"false" json:"isHavingRestoreConfigOverrides"`
}
func (m BackupSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BackupSourceDetails) String() string
func (m BackupSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupSourceTypeEnum Enum with underlying type: string
type BackupSourceTypeEnum string
Set of constants representing the allowable values for BackupSourceTypeEnum
const (
BackupSourceTypeScheduled BackupSourceTypeEnum = "SCHEDULED"
BackupSourceTypeManual BackupSourceTypeEnum = "MANUAL"
)
func GetBackupSourceTypeEnumValues() []BackupSourceTypeEnum
GetBackupSourceTypeEnumValues Enumerates the set of values for BackupSourceTypeEnum
func GetMappingBackupSourceTypeEnum(val string) (BackupSourceTypeEnum, bool)
GetMappingBackupSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BackupSummary Summary information for a backup.
type BackupSummary struct {
// A unique identifier for the backup. Immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the backup. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the backup.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the backup was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the backup.
LifecycleState BackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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:"true" 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:"true" json:"definedTags"`
// The date and time the backup was updated, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Specifies whether the backup was created manually, or by a management policy.
SourceType BackupSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// The size of the backup, in gigabytes.
BackupSize *int `mandatory:"false" json:"backupSize"`
// The backup's source database system's OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
DbSystemId *string `mandatory:"false" json:"dbSystemId"`
// Backup retention period in days.
RetentionPeriod *int `mandatory:"false" json:"retentionPeriod"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m BackupSummary) String() string
func (m BackupSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeBackupCompartmentDetails The information used to move a backup to a different compartment.
type ChangeBackupCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the backup will be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeBackupCompartmentDetails) String() string
func (m ChangeBackupCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeBackupCompartmentRequest wrapper for the ChangeBackupCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ChangeBackupCompartment.go.html to see an example of how to use ChangeBackupCompartmentRequest.
type ChangeBackupCompartmentRequest struct {
// A unique identifier for the backup.
BackupId *string `mandatory:"true" contributesTo:"path" name:"backupId"`
// The information to be updated.
ChangeBackupCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeBackupCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBackupCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBackupCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBackupCompartmentRequest) String() string
func (request ChangeBackupCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeBackupCompartmentResponse wrapper for the ChangeBackupCompartment operation
type ChangeBackupCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeBackupCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBackupCompartmentResponse) String() string
ChangeConfigurationCompartmentDetails The information to move a configuration to a different compartment.
type ChangeConfigurationCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment into which the configuration will be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeConfigurationCompartmentDetails) String() string
func (m ChangeConfigurationCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeConfigurationCompartmentRequest wrapper for the ChangeConfigurationCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ChangeConfigurationCompartment.go.html to see an example of how to use ChangeConfigurationCompartmentRequest.
type ChangeConfigurationCompartmentRequest struct {
// A unique identifier for the configuration.
ConfigurationId *string `mandatory:"true" contributesTo:"path" name:"configurationId"`
// The information to be updated.
ChangeConfigurationCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
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 ChangeConfigurationCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeConfigurationCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeConfigurationCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeConfigurationCompartmentRequest) String() string
func (request ChangeConfigurationCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeConfigurationCompartmentResponse wrapper for the ChangeConfigurationCompartment operation
type ChangeConfigurationCompartmentResponse 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 ChangeConfigurationCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeConfigurationCompartmentResponse) String() string
ChangeDbSystemCompartmentDetails Change database system compartment operation details.
type ChangeDbSystemCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
// into which the database system should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDbSystemCompartmentDetails) String() string
func (m ChangeDbSystemCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDbSystemCompartmentRequest wrapper for the ChangeDbSystemCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ChangeDbSystemCompartment.go.html to see an example of how to use ChangeDbSystemCompartmentRequest.
type ChangeDbSystemCompartmentRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// The information to be updated.
ChangeDbSystemCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
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 ChangeDbSystemCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDbSystemCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDbSystemCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDbSystemCompartmentRequest) String() string
func (request ChangeDbSystemCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeDbSystemCompartmentResponse wrapper for the ChangeDbSystemCompartment operation
type ChangeDbSystemCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeDbSystemCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDbSystemCompartmentResponse) String() string
ConfigOverrides Configuration overrides for a PostgreSQL instance.
type ConfigOverrides struct {
// Configuration variable name.
ConfigKey *string `mandatory:"true" json:"configKey"`
// User-selected variable value.
OverridenConfigValue *string `mandatory:"true" json:"overridenConfigValue"`
}
func (m ConfigOverrides) String() string
func (m ConfigOverrides) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConfigParams Database configuration.
type ConfigParams struct {
// The configuration variable name.
ConfigKey *string `mandatory:"true" json:"configKey"`
// Default value for the configuration variable.
DefaultConfigValue *string `mandatory:"true" json:"defaultConfigValue"`
// Range or list of allowed values.
AllowedValues *string `mandatory:"true" json:"allowedValues"`
// If true, modifying this configuration value will require a restart of the database.
IsRestartRequired *bool `mandatory:"true" json:"isRestartRequired"`
// Data type of the variable.
DataType *string `mandatory:"true" json:"dataType"`
// Whether the value can be overridden or not.
IsOverridable *bool `mandatory:"true" json:"isOverridable"`
// Details about the PostgreSQL parameter.
Description *string `mandatory:"true" json:"description"`
// User-selected configuration variable value.
OverridenConfigValue *string `mandatory:"false" json:"overridenConfigValue"`
}
func (m ConfigParams) String() string
func (m ConfigParams) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Configuration PostgreSQL configuration for a database system.
type Configuration struct {
// A unique identifier for the configuration. Immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the configuration. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the configuration.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the configuration was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the configuration.
LifecycleState ConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The name of the shape for the configuration.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"true" json:"shape"`
// CPU core count.
InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`
// Memory size in gigabytes with 1GB increment.
InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`
// Version of the PostgreSQL database.
DbVersion *string `mandatory:"true" json:"dbVersion"`
ConfigurationDetails *ConfigurationDetails `mandatory:"true" json:"configurationDetails"`
// A description for the configuration.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Configuration) String() string
func (m Configuration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConfigurationCollection Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata.
type ConfigurationCollection struct {
// List of configurations.
Items []ConfigurationSummary `mandatory:"true" json:"items"`
}
func (m ConfigurationCollection) String() string
func (m ConfigurationCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConfigurationDetails List of configuration details.
type ConfigurationDetails struct {
// List of ConfigParms object.
Items []ConfigParams `mandatory:"true" json:"items"`
}
func (m ConfigurationDetails) String() string
func (m ConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConfigurationLifecycleStateEnum Enum with underlying type: string
type ConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for ConfigurationLifecycleStateEnum
const (
ConfigurationLifecycleStateActive ConfigurationLifecycleStateEnum = "ACTIVE"
ConfigurationLifecycleStateDeleting ConfigurationLifecycleStateEnum = "DELETING"
ConfigurationLifecycleStateDeleted ConfigurationLifecycleStateEnum = "DELETED"
ConfigurationLifecycleStateFailed ConfigurationLifecycleStateEnum = "FAILED"
)
func GetConfigurationLifecycleStateEnumValues() []ConfigurationLifecycleStateEnum
GetConfigurationLifecycleStateEnumValues Enumerates the set of values for ConfigurationLifecycleStateEnum
func GetMappingConfigurationLifecycleStateEnum(val string) (ConfigurationLifecycleStateEnum, bool)
GetMappingConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigurationSummary Summary of the configuration.
type ConfigurationSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration. Immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the configuration. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the configuration.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the configuration was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the configuration.
LifecycleState ConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The name of the shape for the configuration.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"true" json:"shape"`
// Version of the PostgreSQL database.
DbVersion *string `mandatory:"true" json:"dbVersion"`
// CPU core count.
InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`
// Memory size in gigabytes with 1GB increment.
InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ConfigurationSummary) String() string
func (m ConfigurationSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConnectionDetails Database system connection information. Used to connect to PostgreSQL instance(s).
type ConnectionDetails struct {
// The CA certificate to be used by the PosgreSQL client to connect to the database.
// The CA certificate is used to authenticate the server identity.
// It is issued by PostgreSQL Service Private CA.
CaCertificate *string `mandatory:"true" json:"caCertificate"`
PrimaryDbEndpoint *Endpoint `mandatory:"true" json:"primaryDbEndpoint"`
// The list of database instance node endpoints in the database system.
InstanceEndpoints []DbInstanceEndpoint `mandatory:"true" json:"instanceEndpoints"`
}
func (m ConnectionDetails) String() string
func (m ConnectionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackupDetails The information to create a new backup.
type CreateBackupDetails struct {
// A user-friendly display name for the backup. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the backup.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The ID of the database system.
DbSystemId *string `mandatory:"true" json:"dbSystemId"`
// A description for the backup.
Description *string `mandatory:"false" json:"description"`
// Backup retention period in days.
RetentionPeriod *int `mandatory:"false" json:"retentionPeriod"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateBackupDetails) String() string
func (m CreateBackupDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackupRequest wrapper for the CreateBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/CreateBackup.go.html to see an example of how to use CreateBackupRequest.
type CreateBackupRequest struct {
// Details for the new backup.
CreateBackupDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, `retrytoken` could be expired or invalidated.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBackupRequest) String() string
func (request CreateBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBackupResponse wrapper for the CreateBackup operation
type CreateBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBackupResponse) String() string
CreateConfigurationDetails The information to create a new configuration.
type CreateConfigurationDetails struct {
// A user-friendly display name for the configuration. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the configuration.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the shape for the configuration.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"true" json:"shape"`
// Version of the PostgreSQL database.
DbVersion *string `mandatory:"true" json:"dbVersion"`
// CPU core count.
InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`
// Memory size in gigabytes with 1GB increment.
InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`
DbConfigurationOverrides *DbConfigurationOverrideCollection `mandatory:"true" json:"dbConfigurationOverrides"`
// Details about the configuration set.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m CreateConfigurationDetails) String() string
func (m CreateConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateConfigurationRequest wrapper for the CreateConfiguration operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/CreateConfiguration.go.html to see an example of how to use CreateConfigurationRequest.
type CreateConfigurationRequest struct {
// Details for the new configuration.
CreateConfigurationDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, `retrytoken` could be expired or invalidated.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateConfigurationRequest) String() string
func (request CreateConfigurationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateConfigurationResponse wrapper for the CreateConfiguration operation
type CreateConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Configuration instance
Configuration `presentIn:"body"`
// 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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateConfigurationResponse) String() string
CreateDbInstanceDetails Information about the new database instance node.
type CreateDbInstanceDetails struct {
// Display name of the database instance node. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user-provided description of the database instance node.
Description *string `mandatory:"false" json:"description"`
// Private IP in customer subnet that will be assigned to the database instance node. This value is optional.
// If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
PrivateIp *string `mandatory:"false" json:"privateIp"`
}
func (m CreateDbInstanceDetails) String() string
func (m CreateDbInstanceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDbSystemDetails The information about new database system.
type CreateDbSystemDetails struct {
// A user-friendly display name for the database system. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the database system.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Version of database system software.
DbVersion *string `mandatory:"true" json:"dbVersion"`
StorageDetails StorageDetails `mandatory:"true" json:"storageDetails"`
// The name of the shape for the database instance node. Use the /shapes API for accepted shapes.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"true" json:"shape"`
NetworkDetails *NetworkDetails `mandatory:"true" json:"networkDetails"`
// A user-provided description of a database system.
Description *string `mandatory:"false" json:"description"`
// Type of the database system.
SystemType DbSystemSystemTypeEnum `mandatory:"false" json:"systemType,omitempty"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system.
ConfigId *string `mandatory:"false" json:"configId"`
// The total number of OCPUs available to each database instance node.
InstanceOcpuCount *int `mandatory:"false" json:"instanceOcpuCount"`
// The total amount of memory available to each database instance node, in gigabytes.
InstanceMemorySizeInGBs *int `mandatory:"false" json:"instanceMemorySizeInGBs"`
// Count of database instances nodes to be created in the database system.
InstanceCount *int `mandatory:"false" json:"instanceCount"`
// Details of database instances nodes to be created. This parameter is optional.
// If specified, its size must match `instanceCount`.
InstancesDetails []CreateDbInstanceDetails `mandatory:"false" json:"instancesDetails"`
Credentials *Credentials `mandatory:"false" json:"credentials"`
ManagementPolicy *ManagementPolicyDetails `mandatory:"false" json:"managementPolicy"`
Source SourceDetails `mandatory:"false" json:"source"`
// 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 CreateDbSystemDetails) String() string
func (m *CreateDbSystemDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateDbSystemDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDbSystemRequest wrapper for the CreateDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/CreateDbSystem.go.html to see an example of how to use CreateDbSystemRequest.
type CreateDbSystemRequest struct {
// Details for the new database system.
CreateDbSystemDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, `retrytoken` could be expired or invalidated.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDbSystemRequest) String() string
func (request CreateDbSystemRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDbSystemResponse wrapper for the CreateDbSystem operation
type CreateDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// The DbSystem instance
DbSystem `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDbSystemResponse) String() string
Credentials Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
type Credentials struct {
// The database system administrator username.
Username *string `mandatory:"true" json:"username"`
PasswordDetails PasswordDetails `mandatory:"true" json:"passwordDetails"`
}
func (m Credentials) String() string
func (m *Credentials) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Credentials) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DailyBackupPolicy Daily backup policy.
type DailyBackupPolicy struct {
// Hour of the day when the backup starts.
BackupStart *string `mandatory:"true" json:"backupStart"`
// How many days the data should be stored after the database system deletion.
RetentionDays *int `mandatory:"false" json:"retentionDays"`
}
func (m DailyBackupPolicy) GetRetentionDays() *int
GetRetentionDays returns RetentionDays
func (m DailyBackupPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DailyBackupPolicy) String() string
func (m DailyBackupPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DbConfigurationOverrideCollection Configuration overrides for a PostgreSQL instance.
type DbConfigurationOverrideCollection struct {
// List of configuration overridden values.
Items []ConfigOverrides `mandatory:"true" json:"items"`
}
func (m DbConfigurationOverrideCollection) String() string
func (m DbConfigurationOverrideCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DbInstance Information about a database instance node.
type DbInstance struct {
// A unique identifier for the database instance node. Immutable on creation.
Id *string `mandatory:"true" json:"id"`
// The availability domain in which the database instance node is located.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The current state of the database instance node.
LifecycleState DbInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time that the database instance node was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly display name for the database instance node. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the database instance node.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The date and time that the database instance node was updated, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DbInstance) String() string
func (m DbInstance) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DbInstanceEndpoint The database instance node endpoint information.
type DbInstanceEndpoint struct {
// Unique identifier of the database instance node.
DbInstanceId *string `mandatory:"true" json:"dbInstanceId"`
Endpoint *Endpoint `mandatory:"true" json:"endpoint"`
}
func (m DbInstanceEndpoint) String() string
func (m DbInstanceEndpoint) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DbInstanceLifecycleStateEnum Enum with underlying type: string
type DbInstanceLifecycleStateEnum string
Set of constants representing the allowable values for DbInstanceLifecycleStateEnum
const (
DbInstanceLifecycleStateCreating DbInstanceLifecycleStateEnum = "CREATING"
DbInstanceLifecycleStateUpdating DbInstanceLifecycleStateEnum = "UPDATING"
DbInstanceLifecycleStateActive DbInstanceLifecycleStateEnum = "ACTIVE"
DbInstanceLifecycleStateInactive DbInstanceLifecycleStateEnum = "INACTIVE"
DbInstanceLifecycleStateDeleting DbInstanceLifecycleStateEnum = "DELETING"
DbInstanceLifecycleStateDeleted DbInstanceLifecycleStateEnum = "DELETED"
DbInstanceLifecycleStateFailed DbInstanceLifecycleStateEnum = "FAILED"
)
func GetDbInstanceLifecycleStateEnumValues() []DbInstanceLifecycleStateEnum
GetDbInstanceLifecycleStateEnumValues Enumerates the set of values for DbInstanceLifecycleStateEnum
func GetMappingDbInstanceLifecycleStateEnum(val string) (DbInstanceLifecycleStateEnum, bool)
GetMappingDbInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DbSystem Information about a database system.
type DbSystem struct {
// A unique identifier for the database system. Immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the database system. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the database system.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the database system was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the database system.
LifecycleState DbSystemLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Type of the database system.
SystemType DbSystemSystemTypeEnum `mandatory:"true" json:"systemType"`
// The major and minor versions of the database system software.
DbVersion *string `mandatory:"true" json:"dbVersion"`
// The name of the shape for the database instance.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"true" json:"shape"`
// The total number of OCPUs available to each database instance node.
InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`
// The total amount of memory available to each database instance node, in gigabytes.
InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`
StorageDetails StorageDetails `mandatory:"true" json:"storageDetails"`
NetworkDetails *NetworkDetails `mandatory:"true" json:"networkDetails"`
ManagementPolicy *ManagementPolicy `mandatory:"true" json:"managementPolicy"`
// A description of the database system.
Description *string `mandatory:"false" json:"description"`
// The date and time that the database system was updated, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The database system administrator username.
AdminUsername *string `mandatory:"false" json:"adminUsername"`
// 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"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system.
ConfigId *string `mandatory:"false" json:"configId"`
// Count of instances, or nodes, in the database system.
InstanceCount *int `mandatory:"false" json:"instanceCount"`
// The list of instances, or nodes, in the database system.
Instances []DbInstance `mandatory:"false" json:"instances"`
Source SourceDetails `mandatory:"false" json:"source"`
}
func (m DbSystem) String() string
func (m *DbSystem) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DbSystem) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DbSystemCollection Results of a database system search. Contains both DbSystemSummary items and other information, such as metadata.
type DbSystemCollection struct {
// List of database systems.
Items []DbSystemSummary `mandatory:"true" json:"items"`
}
func (m DbSystemCollection) String() string
func (m DbSystemCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DbSystemDetails Information about the database system associated with a backup.
type DbSystemDetails struct {
// Type of the database system.
SystemType DbSystemSystemTypeEnum `mandatory:"true" json:"systemType"`
// The major and minor versions of the database system software.
DbVersion *string `mandatory:"true" json:"dbVersion"`
}
func (m DbSystemDetails) String() string
func (m DbSystemDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DbSystemLifecycleStateEnum Enum with underlying type: string
type DbSystemLifecycleStateEnum string
Set of constants representing the allowable values for DbSystemLifecycleStateEnum
const (
DbSystemLifecycleStateCreating DbSystemLifecycleStateEnum = "CREATING"
DbSystemLifecycleStateUpdating DbSystemLifecycleStateEnum = "UPDATING"
DbSystemLifecycleStateActive DbSystemLifecycleStateEnum = "ACTIVE"
DbSystemLifecycleStateInactive DbSystemLifecycleStateEnum = "INACTIVE"
DbSystemLifecycleStateDeleting DbSystemLifecycleStateEnum = "DELETING"
DbSystemLifecycleStateDeleted DbSystemLifecycleStateEnum = "DELETED"
DbSystemLifecycleStateFailed DbSystemLifecycleStateEnum = "FAILED"
DbSystemLifecycleStateNeedsAttention DbSystemLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetDbSystemLifecycleStateEnumValues() []DbSystemLifecycleStateEnum
GetDbSystemLifecycleStateEnumValues Enumerates the set of values for DbSystemLifecycleStateEnum
func GetMappingDbSystemLifecycleStateEnum(val string) (DbSystemLifecycleStateEnum, bool)
GetMappingDbSystemLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DbSystemSummary Summary information about a database system.
type DbSystemSummary struct {
// A unique identifier for the database system. Immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the database system. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the database system.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the database system was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the database system.
LifecycleState DbSystemLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Type of the database system.
SystemType DbSystemSystemTypeEnum `mandatory:"true" json:"systemType"`
// Count of database instances, or nodes, in the database system.
InstanceCount *int `mandatory:"true" json:"instanceCount"`
// The total number of OCPUs available to each database instance node.
InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`
// The total amount of memory available to each database instance node, in gigabytes.
InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`
// Version of database system software.
DbVersion *string `mandatory:"true" json:"dbVersion"`
// 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:"true" 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:"true" json:"definedTags"`
// The date and time that the database system was updated, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The name of the shape for the database instance node.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"false" json:"shape"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system.
ConfigId *string `mandatory:"false" json:"configId"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DbSystemSummary) String() string
func (m DbSystemSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DbSystemSystemTypeEnum Enum with underlying type: string
type DbSystemSystemTypeEnum string
Set of constants representing the allowable values for DbSystemSystemTypeEnum
const (
DbSystemSystemTypeOciOptimizedStorage DbSystemSystemTypeEnum = "OCI_OPTIMIZED_STORAGE"
)
func GetDbSystemSystemTypeEnumValues() []DbSystemSystemTypeEnum
GetDbSystemSystemTypeEnumValues Enumerates the set of values for DbSystemSystemTypeEnum
func GetMappingDbSystemSystemTypeEnum(val string) (DbSystemSystemTypeEnum, bool)
GetMappingDbSystemSystemTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DefaultConfigParams Default database configuration.
type DefaultConfigParams struct {
// The configuration variable name.
ConfigKey *string `mandatory:"true" json:"configKey"`
// Default value for the variable.
DefaultConfigValue *string `mandatory:"true" json:"defaultConfigValue"`
// Range or list of allowed values.
AllowedValues *string `mandatory:"true" json:"allowedValues"`
// If true, modifying this configuration value will require a restart.
IsRestartRequired *bool `mandatory:"true" json:"isRestartRequired"`
// Data type of the variable.
DataType *string `mandatory:"true" json:"dataType"`
// Whether the value can be overridden or not.
IsOverridable *bool `mandatory:"true" json:"isOverridable"`
// Details about the PostgreSQL variable.
Description *string `mandatory:"true" json:"description"`
}
func (m DefaultConfigParams) String() string
func (m DefaultConfigParams) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultConfiguration Default configurations for PostgreSQL database systems.
type DefaultConfiguration struct {
// A unique identifier for the configuration.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the configuration.
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time that the configuration was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the configuration.
LifecycleState DefaultConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The name of the shape for the configuration.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"true" json:"shape"`
// CPU core count. Minimum value is 1.
InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`
// Memory size in gigabytes with 1GB increment.
InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`
// Version of the PostgreSQL database.
DbVersion *string `mandatory:"true" json:"dbVersion"`
ConfigurationDetails *DefaultConfigurationDetails `mandatory:"true" json:"configurationDetails"`
// A description for the configuration.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m DefaultConfiguration) String() string
func (m DefaultConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultConfigurationCollection Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata.
type DefaultConfigurationCollection struct {
// List of configurations.
Items []DefaultConfigurationSummary `mandatory:"true" json:"items"`
}
func (m DefaultConfigurationCollection) String() string
func (m DefaultConfigurationCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultConfigurationDetails List of default configuration values for databases.
type DefaultConfigurationDetails struct {
// List of ConfigParms object.
Items []DefaultConfigParams `mandatory:"true" json:"items"`
}
func (m DefaultConfigurationDetails) String() string
func (m DefaultConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DefaultConfigurationLifecycleStateEnum Enum with underlying type: string
type DefaultConfigurationLifecycleStateEnum string
Set of constants representing the allowable values for DefaultConfigurationLifecycleStateEnum
const (
DefaultConfigurationLifecycleStateActive DefaultConfigurationLifecycleStateEnum = "ACTIVE"
DefaultConfigurationLifecycleStateInactive DefaultConfigurationLifecycleStateEnum = "INACTIVE"
DefaultConfigurationLifecycleStateDeleting DefaultConfigurationLifecycleStateEnum = "DELETING"
DefaultConfigurationLifecycleStateDeleted DefaultConfigurationLifecycleStateEnum = "DELETED"
DefaultConfigurationLifecycleStateFailed DefaultConfigurationLifecycleStateEnum = "FAILED"
)
func GetDefaultConfigurationLifecycleStateEnumValues() []DefaultConfigurationLifecycleStateEnum
GetDefaultConfigurationLifecycleStateEnumValues Enumerates the set of values for DefaultConfigurationLifecycleStateEnum
func GetMappingDefaultConfigurationLifecycleStateEnum(val string) (DefaultConfigurationLifecycleStateEnum, bool)
GetMappingDefaultConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DefaultConfigurationSummary Summary of the configuration.
type DefaultConfigurationSummary struct {
// A unique identifier for the configuration.
Id *string `mandatory:"true" json:"id"`
// A user-friendly display name for the configuration.
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time that the configuration was created, expressed in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the configuration.
LifecycleState DefaultConfigurationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The name of the shape for the configuration.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"true" json:"shape"`
// Version of the PostgreSQL database.
DbVersion *string `mandatory:"true" json:"dbVersion"`
// CPU core count. Minimum value is 1.
InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`
// Memory size in gigabytes with 1GB increment.
InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m DefaultConfigurationSummary) String() string
func (m DefaultConfigurationSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteBackupRequest wrapper for the DeleteBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/DeleteBackup.go.html to see an example of how to use DeleteBackupRequest.
type DeleteBackupRequest struct {
// A unique identifier for 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` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBackupRequest) String() string
func (request DeleteBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteBackupResponse wrapper for the DeleteBackup operation
type DeleteBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBackupResponse) String() string
DeleteConfigurationRequest wrapper for the DeleteConfiguration operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/DeleteConfiguration.go.html to see an example of how to use DeleteConfigurationRequest.
type DeleteConfigurationRequest struct {
// A unique identifier for 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` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteConfigurationRequest) String() string
func (request DeleteConfigurationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteConfigurationResponse wrapper for the DeleteConfiguration operation
type DeleteConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteConfigurationResponse) String() string
DeleteDbSystemRequest wrapper for the DeleteDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/DeleteDbSystem.go.html to see an example of how to use DeleteDbSystemRequest.
type DeleteDbSystemRequest struct {
// A unique identifier for the database system.
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` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDbSystemRequest) String() string
func (request DeleteDbSystemRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteDbSystemResponse wrapper for the DeleteDbSystem operation
type DeleteDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDbSystemResponse) String() string
Endpoint Information about the database instance node endpoint.
type Endpoint struct {
// The FQDN of the endpoint.
Fqdn *string `mandatory:"true" json:"fqdn"`
// The IP address of the endpoint.
IpAddress *string `mandatory:"true" json:"ipAddress"`
// The port address of the endpoint.
Port *int `mandatory:"true" json:"port"`
}
func (m Endpoint) String() string
func (m Endpoint) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FailoverDbSystemDetails Database system failover information.
type FailoverDbSystemDetails struct {
// The preferred AD for regions with three availability domains. This parameter is optional.
// If not set, the AD will be chosen based on availability.
Ad *string `mandatory:"false" json:"ad"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database instance node. This parameter is optional.
// If not set, an existing database instance node will be chosen based on availability.
DbInstanceId *string `mandatory:"false" json:"dbInstanceId"`
}
func (m FailoverDbSystemDetails) String() string
func (m FailoverDbSystemDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FailoverDbSystemRequest wrapper for the FailoverDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/FailoverDbSystem.go.html to see an example of how to use FailoverDbSystemRequest.
type FailoverDbSystemRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// The information to be updated.
FailoverDbSystemDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
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 FailoverDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request FailoverDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request FailoverDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request FailoverDbSystemRequest) String() string
func (request FailoverDbSystemRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FailoverDbSystemResponse wrapper for the FailoverDbSystem operation
type FailoverDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response FailoverDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response FailoverDbSystemResponse) String() string
GetBackupRequest wrapper for the GetBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetBackup.go.html to see an example of how to use GetBackupRequest.
type GetBackupRequest struct {
// A unique identifier for the backup.
BackupId *string `mandatory:"true" contributesTo:"path" name:"backupId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBackupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBackupRequest) String() string
func (request GetBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetBackupResponse wrapper for the GetBackup operation
type GetBackupResponse struct {
// The underlying http response
RawResponse *http.Response
// The Backup instance
Backup `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBackupResponse) String() string
GetConfigurationRequest wrapper for the GetConfiguration operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetConfiguration.go.html to see an example of how to use GetConfigurationRequest.
type GetConfigurationRequest struct {
// A unique identifier for the configuration.
ConfigurationId *string `mandatory:"true" contributesTo:"path" name:"configurationId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConfigurationRequest) String() string
func (request GetConfigurationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetConfigurationResponse wrapper for the GetConfiguration operation
type GetConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Configuration instance
Configuration `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConfigurationResponse) String() string
GetConnectionDetailsRequest wrapper for the GetConnectionDetails operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetConnectionDetails.go.html to see an example of how to use GetConnectionDetailsRequest.
type GetConnectionDetailsRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetConnectionDetailsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConnectionDetailsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConnectionDetailsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConnectionDetailsRequest) String() string
func (request GetConnectionDetailsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetConnectionDetailsResponse wrapper for the GetConnectionDetails operation
type GetConnectionDetailsResponse struct {
// The underlying http response
RawResponse *http.Response
// The ConnectionDetails instance
ConnectionDetails `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 GetConnectionDetailsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConnectionDetailsResponse) String() string
GetDbSystemExcludedFieldsEnum Enum with underlying type: string
type GetDbSystemExcludedFieldsEnum string
Set of constants representing the allowable values for GetDbSystemExcludedFieldsEnum
const (
GetDbSystemExcludedFieldsDbconfigurationparams GetDbSystemExcludedFieldsEnum = "dbConfigurationParams"
)
func GetGetDbSystemExcludedFieldsEnumValues() []GetDbSystemExcludedFieldsEnum
GetGetDbSystemExcludedFieldsEnumValues Enumerates the set of values for GetDbSystemExcludedFieldsEnum
func GetMappingGetDbSystemExcludedFieldsEnum(val string) (GetDbSystemExcludedFieldsEnum, bool)
GetMappingGetDbSystemExcludedFieldsEnum performs case Insensitive comparison on enum value and return the desired enum
GetDbSystemRequest wrapper for the GetDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetDbSystem.go.html to see an example of how to use GetDbSystemRequest.
type GetDbSystemRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to exclude database configuration when this query parameter is set to OverrideDbConfig.
ExcludedFields []GetDbSystemExcludedFieldsEnum `contributesTo:"query" name:"excludedFields" omitEmpty:"true" collectionFormat:"multi"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDbSystemRequest) String() string
func (request GetDbSystemRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDbSystemResponse wrapper for the GetDbSystem operation
type GetDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// The DbSystem instance
DbSystem `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDbSystemResponse) String() string
GetDefaultConfigurationRequest wrapper for the GetDefaultConfiguration operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetDefaultConfiguration.go.html to see an example of how to use GetDefaultConfigurationRequest.
type GetDefaultConfigurationRequest struct {
// A unique identifier for the configuration.
DefaultConfigurationId *string `mandatory:"true" contributesTo:"path" name:"defaultConfigurationId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetDefaultConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDefaultConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDefaultConfigurationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDefaultConfigurationRequest) String() string
func (request GetDefaultConfigurationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetDefaultConfigurationResponse wrapper for the GetDefaultConfiguration operation
type GetDefaultConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The DefaultConfiguration instance
DefaultConfiguration `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 GetDefaultConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDefaultConfigurationResponse) String() string
GetPrimaryDbInstanceRequest wrapper for the GetPrimaryDbInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetPrimaryDbInstance.go.html to see an example of how to use GetPrimaryDbInstanceRequest.
type GetPrimaryDbInstanceRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetPrimaryDbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPrimaryDbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPrimaryDbInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPrimaryDbInstanceRequest) String() string
func (request GetPrimaryDbInstanceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPrimaryDbInstanceResponse wrapper for the GetPrimaryDbInstance operation
type GetPrimaryDbInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The PrimaryDbInstanceDetails instance
PrimaryDbInstanceDetails `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 GetPrimaryDbInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPrimaryDbInstanceResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. 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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
ListBackupsRequest wrapper for the ListBackups operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListBackups.go.html to see an example of how to use ListBackupsRequest.
type ListBackupsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The start date for getting backups. An RFC 3339 (https://tools.ietf.org/rfc/rfc3339) formatted datetime string.
TimeStarted *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeStarted"`
// The end date for getting backups. An RFC 3339 (https://tools.ietf.org/rfc/rfc3339) formatted datetime string.
TimeEnded *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeEnded"`
// A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`.
LifecycleState BackupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A unique identifier for the backup.
BackupId *string `mandatory:"false" contributesTo:"query" name:"backupId"`
// A unique identifier for the database system.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListBackupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListBackupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListBackupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBackupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBackupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBackupsRequest) String() string
func (request ListBackupsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListBackupsResponse wrapper for the ListBackups operation
type ListBackupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of BackupCollection instances
BackupCollection `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.
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"
ListBackupsSortByDisplayname ListBackupsSortByEnum = "displayName"
)
func GetListBackupsSortByEnumValues() []ListBackupsSortByEnum
GetListBackupsSortByEnumValues Enumerates the set of values for ListBackupsSortByEnum
func GetMappingListBackupsSortByEnum(val string) (ListBackupsSortByEnum, bool)
GetMappingListBackupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBackupsSortOrderEnum Enum with underlying type: string
type ListBackupsSortOrderEnum string
Set of constants representing the allowable values for ListBackupsSortOrderEnum
const (
ListBackupsSortOrderAsc ListBackupsSortOrderEnum = "ASC"
ListBackupsSortOrderDesc ListBackupsSortOrderEnum = "DESC"
)
func GetListBackupsSortOrderEnumValues() []ListBackupsSortOrderEnum
GetListBackupsSortOrderEnumValues Enumerates the set of values for ListBackupsSortOrderEnum
func GetMappingListBackupsSortOrderEnum(val string) (ListBackupsSortOrderEnum, bool)
GetMappingListBackupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListConfigurationsRequest wrapper for the ListConfigurations operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListConfigurations.go.html to see an example of how to use ListConfigurationsRequest.
type ListConfigurationsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`.
LifecycleState ConfigurationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Verison of the PostgreSQL database, such as 14.9.
DbVersion *string `mandatory:"false" contributesTo:"query" name:"dbVersion"`
// The name of the shape for the configuration.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"false" contributesTo:"query" name:"shape"`
// A unique identifier for the configuration.
ConfigurationId *string `mandatory:"false" contributesTo:"query" name:"configurationId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListConfigurationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListConfigurationsRequest) String() string
func (request ListConfigurationsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListConfigurationsResponse wrapper for the ListConfigurations operation
type ListConfigurationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ConfigurationCollection instances
ConfigurationCollection `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.
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 (
ListConfigurationsSortByTimecreated ListConfigurationsSortByEnum = "timeCreated"
ListConfigurationsSortByDisplayname ListConfigurationsSortByEnum = "displayName"
)
func GetListConfigurationsSortByEnumValues() []ListConfigurationsSortByEnum
GetListConfigurationsSortByEnumValues Enumerates the set of values for ListConfigurationsSortByEnum
func GetMappingListConfigurationsSortByEnum(val string) (ListConfigurationsSortByEnum, bool)
GetMappingListConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListConfigurationsSortOrderEnum Enum with underlying type: string
type ListConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListConfigurationsSortOrderEnum
const (
ListConfigurationsSortOrderAsc ListConfigurationsSortOrderEnum = "ASC"
ListConfigurationsSortOrderDesc ListConfigurationsSortOrderEnum = "DESC"
)
func GetListConfigurationsSortOrderEnumValues() []ListConfigurationsSortOrderEnum
GetListConfigurationsSortOrderEnumValues Enumerates the set of values for ListConfigurationsSortOrderEnum
func GetMappingListConfigurationsSortOrderEnum(val string) (ListConfigurationsSortOrderEnum, bool)
GetMappingListConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDbSystemsRequest wrapper for the ListDbSystems operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListDbSystems.go.html to see an example of how to use ListDbSystemsRequest.
type ListDbSystemsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`.
LifecycleState DbSystemLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A unique identifier for the database system.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListDbSystemsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListDbSystemsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDbSystemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDbSystemsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDbSystemsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDbSystemsRequest) String() string
func (request ListDbSystemsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDbSystemsResponse wrapper for the ListDbSystems operation
type ListDbSystemsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DbSystemCollection instances
DbSystemCollection `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.
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 (
ListDbSystemsSortByTimecreated ListDbSystemsSortByEnum = "timeCreated"
ListDbSystemsSortByDisplayname ListDbSystemsSortByEnum = "displayName"
)
func GetListDbSystemsSortByEnumValues() []ListDbSystemsSortByEnum
GetListDbSystemsSortByEnumValues Enumerates the set of values for ListDbSystemsSortByEnum
func GetMappingListDbSystemsSortByEnum(val string) (ListDbSystemsSortByEnum, bool)
GetMappingListDbSystemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDbSystemsSortOrderEnum Enum with underlying type: string
type ListDbSystemsSortOrderEnum string
Set of constants representing the allowable values for ListDbSystemsSortOrderEnum
const (
ListDbSystemsSortOrderAsc ListDbSystemsSortOrderEnum = "ASC"
ListDbSystemsSortOrderDesc ListDbSystemsSortOrderEnum = "DESC"
)
func GetListDbSystemsSortOrderEnumValues() []ListDbSystemsSortOrderEnum
GetListDbSystemsSortOrderEnumValues Enumerates the set of values for ListDbSystemsSortOrderEnum
func GetMappingListDbSystemsSortOrderEnum(val string) (ListDbSystemsSortOrderEnum, bool)
GetMappingListDbSystemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDefaultConfigurationsRequest wrapper for the ListDefaultConfigurations operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListDefaultConfigurations.go.html to see an example of how to use ListDefaultConfigurationsRequest.
type ListDefaultConfigurationsRequest struct {
// A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`.
LifecycleState ConfigurationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Verison of the PostgreSQL database, such as 14.9.
DbVersion *string `mandatory:"false" contributesTo:"query" name:"dbVersion"`
// The name of the shape for the configuration.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"false" contributesTo:"query" name:"shape"`
// A unique identifier for the configuration.
ConfigurationId *string `mandatory:"false" contributesTo:"query" name:"configurationId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListDefaultConfigurationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListDefaultConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListDefaultConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDefaultConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDefaultConfigurationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDefaultConfigurationsRequest) String() string
func (request ListDefaultConfigurationsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListDefaultConfigurationsResponse wrapper for the ListDefaultConfigurations operation
type ListDefaultConfigurationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DefaultConfigurationCollection instances
DefaultConfigurationCollection `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.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDefaultConfigurationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDefaultConfigurationsResponse) String() string
ListDefaultConfigurationsSortByEnum Enum with underlying type: string
type ListDefaultConfigurationsSortByEnum string
Set of constants representing the allowable values for ListDefaultConfigurationsSortByEnum
const (
ListDefaultConfigurationsSortByTimecreated ListDefaultConfigurationsSortByEnum = "timeCreated"
ListDefaultConfigurationsSortByDisplayname ListDefaultConfigurationsSortByEnum = "displayName"
)
func GetListDefaultConfigurationsSortByEnumValues() []ListDefaultConfigurationsSortByEnum
GetListDefaultConfigurationsSortByEnumValues Enumerates the set of values for ListDefaultConfigurationsSortByEnum
func GetMappingListDefaultConfigurationsSortByEnum(val string) (ListDefaultConfigurationsSortByEnum, bool)
GetMappingListDefaultConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDefaultConfigurationsSortOrderEnum Enum with underlying type: string
type ListDefaultConfigurationsSortOrderEnum string
Set of constants representing the allowable values for ListDefaultConfigurationsSortOrderEnum
const (
ListDefaultConfigurationsSortOrderAsc ListDefaultConfigurationsSortOrderEnum = "ASC"
ListDefaultConfigurationsSortOrderDesc ListDefaultConfigurationsSortOrderEnum = "DESC"
)
func GetListDefaultConfigurationsSortOrderEnumValues() []ListDefaultConfigurationsSortOrderEnum
GetListDefaultConfigurationsSortOrderEnumValues Enumerates the set of values for ListDefaultConfigurationsSortOrderEnum
func GetMappingListDefaultConfigurationsSortOrderEnum(val string) (ListDefaultConfigurationsSortOrderEnum, bool)
GetMappingListDefaultConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListShapesRequest wrapper for the ListShapes operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListShapes.go.html to see an example of how to use ListShapesRequest.
type ListShapesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return the feature by the shape name.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListShapesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListShapesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListShapesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListShapesRequest) String() string
func (request ListShapesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListShapesResponse wrapper for the ListShapes operation
type ListShapesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ShapeCollection instances
ShapeCollection `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.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListShapesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListShapesResponse) String() string
ListShapesSortByEnum Enum with underlying type: string
type ListShapesSortByEnum string
Set of constants representing the allowable values for ListShapesSortByEnum
const (
ListShapesSortByTimecreated ListShapesSortByEnum = "timeCreated"
ListShapesSortByDisplayname ListShapesSortByEnum = "displayName"
)
func GetListShapesSortByEnumValues() []ListShapesSortByEnum
GetListShapesSortByEnumValues Enumerates the set of values for ListShapesSortByEnum
func GetMappingListShapesSortByEnum(val string) (ListShapesSortByEnum, bool)
GetMappingListShapesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListShapesSortOrderEnum Enum with underlying type: string
type ListShapesSortOrderEnum string
Set of constants representing the allowable values for ListShapesSortOrderEnum
const (
ListShapesSortOrderAsc ListShapesSortOrderEnum = "ASC"
ListShapesSortOrderDesc ListShapesSortOrderEnum = "DESC"
)
func GetListShapesSortOrderEnumValues() []ListShapesSortOrderEnum
GetListShapesSortOrderEnumValues Enumerates the set of values for ListShapesSortOrderEnum
func GetMappingListShapesSortOrderEnum(val string) (ListShapesSortOrderEnum, bool)
GetMappingListShapesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination of a list of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only resources if their `lifecycleState` matches the given OperationStatus.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID of the resource affected by the request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ManagementPolicy PostgreSQL database system management policy.
type ManagementPolicy struct {
// The start of the maintenance window.
MaintenanceWindowStart *string `mandatory:"true" json:"maintenanceWindowStart"`
BackupPolicy BackupPolicy `mandatory:"true" json:"backupPolicy"`
}
func (m ManagementPolicy) String() string
func (m *ManagementPolicy) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ManagementPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementPolicyDetails PostgreSQL database system management policy update details.
type ManagementPolicyDetails struct {
// The start of the maintenance window.
MaintenanceWindowStart *string `mandatory:"false" json:"maintenanceWindowStart"`
BackupPolicy BackupPolicy `mandatory:"false" json:"backupPolicy"`
}
func (m ManagementPolicyDetails) String() string
func (m *ManagementPolicyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ManagementPolicyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
MonthlyBackupPolicy Monthly backup policy.
type MonthlyBackupPolicy struct {
// Hour of the day when backup starts.
BackupStart *string `mandatory:"true" json:"backupStart"`
// Day of the month when the backup should start.
// To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.
DaysOfTheMonth []int `mandatory:"true" json:"daysOfTheMonth"`
// How many days the data should be stored after the database system deletion.
RetentionDays *int `mandatory:"false" json:"retentionDays"`
}
func (m MonthlyBackupPolicy) GetRetentionDays() *int
GetRetentionDays returns RetentionDays
func (m MonthlyBackupPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MonthlyBackupPolicy) String() string
func (m MonthlyBackupPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NetworkDetails Network details for the database system.
type NetworkDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the customer subnet associated with the database system.
SubnetId *string `mandatory:"true" json:"subnetId"`
// Private IP in customer subnet. The value is optional.
// If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.
PrimaryDbEndpointPrivateIp *string `mandatory:"false" json:"primaryDbEndpointPrivateIp"`
// List of customer Network Security Group OCIDs (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) associated with the database system.
NsgIds []string `mandatory:"false" json:"nsgIds"`
}
func (m NetworkDetails) String() string
func (m NetworkDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NoneBackupPolicy No backup policy.
type NoneBackupPolicy struct {
// How many days the data should be stored after the database system deletion.
RetentionDays *int `mandatory:"false" json:"retentionDays"`
}
func (m NoneBackupPolicy) GetRetentionDays() *int
GetRetentionDays returns RetentionDays
func (m NoneBackupPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NoneBackupPolicy) String() string
func (m NoneBackupPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NoneSourceDetails This is used to create new database system or update without restoring from backup.
type NoneSourceDetails struct {
}
func (m NoneSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NoneSourceDetails) String() string
func (m NoneSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OciOptimizedStorageDetails Storage details of the database system.
type OciOptimizedStorageDetails struct {
// Specifies if the block volume used for the database system is regional or AD-local.
// If not specified, it will be set to false.
// If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified.
// If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified.
IsRegionallyDurable *bool `mandatory:"true" json:"isRegionallyDurable"`
// Specifies the availability domain of AD-local storage.
// If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified.
// If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified.
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Guaranteed input/output storage requests per second (IOPS) available to the database system.
Iops *int64 `mandatory:"false" json:"iops"`
}
func (m OciOptimizedStorageDetails) GetAvailabilityDomain() *string
GetAvailabilityDomain returns AvailabilityDomain
func (m OciOptimizedStorageDetails) GetIsRegionallyDurable() *bool
GetIsRegionallyDurable returns IsRegionallyDurable
func (m OciOptimizedStorageDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciOptimizedStorageDetails) String() string
func (m OciOptimizedStorageDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreatePostgresqlDbSystem OperationTypeEnum = "CREATE_POSTGRESQL_DB_SYSTEM"
OperationTypeUpdatePostgresqlDbSystem OperationTypeEnum = "UPDATE_POSTGRESQL_DB_SYSTEM"
OperationTypeDeletePostgresqlDbSystem OperationTypeEnum = "DELETE_POSTGRESQL_DB_SYSTEM"
OperationTypeMovePostgresqlDbSystem OperationTypeEnum = "MOVE_POSTGRESQL_DB_SYSTEM"
OperationTypeCreatePostgresqlDbSystemBackup OperationTypeEnum = "CREATE_POSTGRESQL_DB_SYSTEM_BACKUP"
OperationTypeUpdatePostgresqlDbSystemBackup OperationTypeEnum = "UPDATE_POSTGRESQL_DB_SYSTEM_BACKUP"
OperationTypeDeletePostgresqlDbSystemBackup OperationTypeEnum = "DELETE_POSTGRESQL_DB_SYSTEM_BACKUP"
OperationTypeMovePostgresqlDbSystemBackup OperationTypeEnum = "MOVE_POSTGRESQL_DB_SYSTEM_BACKUP"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PasswordDetails Details for the database system password. Password can be passed as `VaultSecretPasswordDetails` or `PlainTextPasswordDetails`.
type PasswordDetails interface {
}
PasswordDetailsPasswordTypeEnum Enum with underlying type: string
type PasswordDetailsPasswordTypeEnum string
Set of constants representing the allowable values for PasswordDetailsPasswordTypeEnum
const (
PasswordDetailsPasswordTypePlainText PasswordDetailsPasswordTypeEnum = "PLAIN_TEXT"
PasswordDetailsPasswordTypeVaultSecret PasswordDetailsPasswordTypeEnum = "VAULT_SECRET"
)
func GetMappingPasswordDetailsPasswordTypeEnum(val string) (PasswordDetailsPasswordTypeEnum, bool)
GetMappingPasswordDetailsPasswordTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPasswordDetailsPasswordTypeEnumValues() []PasswordDetailsPasswordTypeEnum
GetPasswordDetailsPasswordTypeEnumValues Enumerates the set of values for PasswordDetailsPasswordTypeEnum
PatchDbSystemDetails For adding read replica database instances, the operation is INSERT and value object to specify is #/definitions/CreateDbInstanceDetails. For removing read replica database instances, the operation is REMOVE and value object needs to be an array of dbInstanceId's.
type PatchDbSystemDetails struct {
// List of patch instructions.
Items []PatchInstruction `mandatory:"false" json:"items"`
}
func (m PatchDbSystemDetails) String() string
func (m *PatchDbSystemDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PatchDbSystemDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchDbSystemRequest wrapper for the PatchDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/PatchDbSystem.go.html to see an example of how to use PatchDbSystemRequest.
type PatchDbSystemRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// The information to be modified.
PatchDbSystemDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request PatchDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PatchDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PatchDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PatchDbSystemRequest) String() string
func (request PatchDbSystemRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchDbSystemResponse wrapper for the PatchDbSystem operation
type PatchDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response PatchDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PatchDbSystemResponse) String() string
PatchInsertInstruction An operation that inserts a value into an array, shifting array items as necessary and handling NOT_FOUND exceptions by creating the implied containing structure.
type PatchInsertInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be inserted into the target.
Value *interface{} `mandatory:"true" json:"value"`
// A selection to be evaluated against the array for identifying a particular reference item within it, with the same format and semantics as `selection`.
SelectedItem *string `mandatory:"false" json:"selectedItem"`
// Where to insert the value, relative to the first item matched by `selectedItem`.
// If `selectedItem` is unspecified, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position.
// If `selectedItem` is specified but results in an empty selection, then both values specify insertion at the last position.
Position PatchInsertInstructionPositionEnum `mandatory:"false" json:"position,omitempty"`
}
func (m PatchInsertInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchInsertInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchInsertInstruction) String() string
func (m PatchInsertInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchInsertInstructionPositionEnum Enum with underlying type: string
type PatchInsertInstructionPositionEnum string
Set of constants representing the allowable values for PatchInsertInstructionPositionEnum
const (
PatchInsertInstructionPositionBefore PatchInsertInstructionPositionEnum = "BEFORE"
PatchInsertInstructionPositionAfter PatchInsertInstructionPositionEnum = "AFTER"
)
func GetMappingPatchInsertInstructionPositionEnum(val string) (PatchInsertInstructionPositionEnum, bool)
GetMappingPatchInsertInstructionPositionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchInsertInstructionPositionEnumValues() []PatchInsertInstructionPositionEnum
GetPatchInsertInstructionPositionEnumValues Enumerates the set of values for PatchInsertInstructionPositionEnum
PatchInstruction A single instruction to be included as part of Patch request content.
type PatchInstruction interface {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
GetSelection() *string
}
PatchInstructionOperationEnum Enum with underlying type: string
type PatchInstructionOperationEnum string
Set of constants representing the allowable values for PatchInstructionOperationEnum
const (
PatchInstructionOperationRequire PatchInstructionOperationEnum = "REQUIRE"
PatchInstructionOperationProhibit PatchInstructionOperationEnum = "PROHIBIT"
PatchInstructionOperationReplace PatchInstructionOperationEnum = "REPLACE"
PatchInstructionOperationInsert PatchInstructionOperationEnum = "INSERT"
PatchInstructionOperationRemove PatchInstructionOperationEnum = "REMOVE"
PatchInstructionOperationMove PatchInstructionOperationEnum = "MOVE"
PatchInstructionOperationMerge PatchInstructionOperationEnum = "MERGE"
)
func GetMappingPatchInstructionOperationEnum(val string) (PatchInstructionOperationEnum, bool)
GetMappingPatchInstructionOperationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchInstructionOperationEnumValues() []PatchInstructionOperationEnum
GetPatchInstructionOperationEnumValues Enumerates the set of values for PatchInstructionOperationEnum
PatchMergeInstruction An operation that recursively updates items of the selection, or adding the value if the selection is empty. If the value is not an object, it is used directly, otherwise each key-value member is used to create or update a member of the same name in the target and the same process is applied recursively for each object-typed value (similar to RFC 7396 (https://tools.ietf.org/html/rfc7396#section-2) JSON Merge Patch, except that null values are copied rather than transformed into deletions). NOT_FOUND exceptions are handled by creating the implied containing structure. To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.
type PatchMergeInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be merged into the target.
Value *interface{} `mandatory:"false" json:"value"`
}
func (m PatchMergeInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchMergeInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchMergeInstruction) String() string
func (m PatchMergeInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchMoveInstruction An operation that "puts" values from elsewhere in the target, functionally equivalent to a single add and then a remove. The first item of the selection is replaced, or created if the selection is empty. NOT_FOUND exceptions in the selection are handled by creating the implied containing structure. This operation fails if the `from` selection yields any exceptions, or if an item is moved to any of its descendants.
type PatchMoveInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// The selection that is to be moved, with the same format and semantics as `selection`.
From *string `mandatory:"true" json:"from"`
// Where to insert the value in an array, relative to the first item in the selection.
// If there is no such item, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position.
// If the first item in the selection is not the child of an array, then this field has no effect.
Position PatchMoveInstructionPositionEnum `mandatory:"false" json:"position,omitempty"`
}
func (m PatchMoveInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchMoveInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchMoveInstruction) String() string
func (m PatchMoveInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchMoveInstructionPositionEnum Enum with underlying type: string
type PatchMoveInstructionPositionEnum string
Set of constants representing the allowable values for PatchMoveInstructionPositionEnum
const (
PatchMoveInstructionPositionAt PatchMoveInstructionPositionEnum = "AT"
PatchMoveInstructionPositionBefore PatchMoveInstructionPositionEnum = "BEFORE"
PatchMoveInstructionPositionAfter PatchMoveInstructionPositionEnum = "AFTER"
)
func GetMappingPatchMoveInstructionPositionEnum(val string) (PatchMoveInstructionPositionEnum, bool)
GetMappingPatchMoveInstructionPositionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPatchMoveInstructionPositionEnumValues() []PatchMoveInstructionPositionEnum
GetPatchMoveInstructionPositionEnumValues Enumerates the set of values for PatchMoveInstructionPositionEnum
PatchProhibitInstruction A precondition operation that requires a selection to be empty, or optionally to be non-empty but include no item with a specified value (useful for asserting that a value does not exist before attempting to create it, avoiding accidental update). It fails if value is provided and the selection includes an item matching it, or if value is not provided and the selection is not empty, but ignores NOT_FOUND exceptions.
type PatchProhibitInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be compared against each item of the selection.
// If this value is an object, then it matches any item that would be unaffected by applying this value as a merge operation.
// Otherwise, it matches any item to which it is equal according to the rules of JSON Schema (https://tools.ietf.org/html/draft-handrews-json-schema-00#section-4.2.3).
Value *interface{} `mandatory:"false" json:"value"`
}
func (m PatchProhibitInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchProhibitInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchProhibitInstruction) String() string
func (m PatchProhibitInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchRemoveInstruction An operation that deletes items, ignoring NOT_FOUND exceptions. To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.
type PatchRemoveInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
}
func (m PatchRemoveInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchRemoveInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchRemoveInstruction) String() string
func (m PatchRemoveInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchReplaceInstruction An operation that "puts" a value, replacing every item of the selection with it, or creating it if the selection is empty. NOT_FOUND exceptions are handled by creating the implied containing structure (but note that this may put the target in an invalid state, which can be prevented by use of precondition operations). To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.
type PatchReplaceInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be added into the target.
Value *interface{} `mandatory:"true" json:"value"`
}
func (m PatchReplaceInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchReplaceInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchReplaceInstruction) String() string
func (m PatchReplaceInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PatchRequireInstruction A precondition operation that requires a selection to be non-empty, and optionally to include an item with a specified value (useful for asserting that a value exists before attempting to update it, avoiding accidental creation). It fails if the selection is empty, or if value is provided and no item of the selection matches it.
type PatchRequireInstruction struct {
// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
// An operation fails if the selection yields an exception, except as otherwise specified.
// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
Selection *string `mandatory:"true" json:"selection"`
// A value to be compared against each item of the selection.
// If this value is an object, then it matches any item that would be unaffected by applying this value as a merge operation.
// Otherwise, it matches any item to which it is equal according to the rules of JSON Schema (https://tools.ietf.org/html/draft-handrews-json-schema-00#section-4.2.3).
Value *interface{} `mandatory:"false" json:"value"`
}
func (m PatchRequireInstruction) GetSelection() *string
GetSelection returns Selection
func (m PatchRequireInstruction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PatchRequireInstruction) String() string
func (m PatchRequireInstruction) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PlainTextPasswordDetails Details for in-line database system password.
type PlainTextPasswordDetails struct {
// The database system password.
Password *string `mandatory:"true" json:"password"`
}
func (m PlainTextPasswordDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PlainTextPasswordDetails) String() string
func (m PlainTextPasswordDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PostgresqlClient a client for Postgresql
type PostgresqlClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewPostgresqlClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PostgresqlClient, err error)
NewPostgresqlClientWithConfigurationProvider Creates a new default Postgresql client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewPostgresqlClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PostgresqlClient, err error)
NewPostgresqlClientWithOboToken Creates a new default Postgresql 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 PostgresqlClient) ChangeBackupCompartment(ctx context.Context, request ChangeBackupCompartmentRequest) (response ChangeBackupCompartmentResponse, err error)
ChangeBackupCompartment Moves a backup from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ChangeBackupCompartment.go.html to see an example of how to use ChangeBackupCompartment API. A default retry strategy applies to this operation ChangeBackupCompartment()
func (client PostgresqlClient) ChangeConfigurationCompartment(ctx context.Context, request ChangeConfigurationCompartmentRequest) (response ChangeConfigurationCompartmentResponse, err error)
ChangeConfigurationCompartment Moves a configuration from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ChangeConfigurationCompartment.go.html to see an example of how to use ChangeConfigurationCompartment API. A default retry strategy applies to this operation ChangeConfigurationCompartment()
func (client PostgresqlClient) ChangeDbSystemCompartment(ctx context.Context, request ChangeDbSystemCompartmentRequest) (response ChangeDbSystemCompartmentResponse, err error)
ChangeDbSystemCompartment Moves a database system from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ChangeDbSystemCompartment.go.html to see an example of how to use ChangeDbSystemCompartment API. A default retry strategy applies to this operation ChangeDbSystemCompartment()
func (client *PostgresqlClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client PostgresqlClient) CreateBackup(ctx context.Context, request CreateBackupRequest) (response CreateBackupResponse, err error)
CreateBackup Creates a new backup.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/CreateBackup.go.html to see an example of how to use CreateBackup API. A default retry strategy applies to this operation CreateBackup()
func (client PostgresqlClient) CreateConfiguration(ctx context.Context, request CreateConfigurationRequest) (response CreateConfigurationResponse, err error)
CreateConfiguration Creates a new configuration.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/CreateConfiguration.go.html to see an example of how to use CreateConfiguration API. A default retry strategy applies to this operation CreateConfiguration()
func (client PostgresqlClient) CreateDbSystem(ctx context.Context, request CreateDbSystemRequest) (response CreateDbSystemResponse, err error)
CreateDbSystem Creates a new database system.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/CreateDbSystem.go.html to see an example of how to use CreateDbSystem API. A default retry strategy applies to this operation CreateDbSystem()
func (client PostgresqlClient) DeleteBackup(ctx context.Context, request DeleteBackupRequest) (response DeleteBackupResponse, err error)
DeleteBackup Deletes a backup by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/DeleteBackup.go.html to see an example of how to use DeleteBackup API. A default retry strategy applies to this operation DeleteBackup()
func (client PostgresqlClient) DeleteConfiguration(ctx context.Context, request DeleteConfigurationRequest) (response DeleteConfigurationResponse, err error)
DeleteConfiguration Deletes a configuration by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/DeleteConfiguration.go.html to see an example of how to use DeleteConfiguration API. A default retry strategy applies to this operation DeleteConfiguration()
func (client PostgresqlClient) DeleteDbSystem(ctx context.Context, request DeleteDbSystemRequest) (response DeleteDbSystemResponse, err error)
DeleteDbSystem Deletes a database system by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/DeleteDbSystem.go.html to see an example of how to use DeleteDbSystem API. A default retry strategy applies to this operation DeleteDbSystem()
func (client PostgresqlClient) FailoverDbSystem(ctx context.Context, request FailoverDbSystemRequest) (response FailoverDbSystemResponse, err error)
FailoverDbSystem Runs a failover operation. Optionally, specify the desired AD for regions with three ADs.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/FailoverDbSystem.go.html to see an example of how to use FailoverDbSystem API. A default retry strategy applies to this operation FailoverDbSystem()
func (client PostgresqlClient) GetBackup(ctx context.Context, request GetBackupRequest) (response GetBackupResponse, err error)
GetBackup Gets a backup by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetBackup.go.html to see an example of how to use GetBackup API. A default retry strategy applies to this operation GetBackup()
func (client PostgresqlClient) GetConfiguration(ctx context.Context, request GetConfigurationRequest) (response GetConfigurationResponse, err error)
GetConfiguration Gets a configuration by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetConfiguration.go.html to see an example of how to use GetConfiguration API. A default retry strategy applies to this operation GetConfiguration()
func (client PostgresqlClient) GetConnectionDetails(ctx context.Context, request GetConnectionDetailsRequest) (response GetConnectionDetailsResponse, err error)
GetConnectionDetails Gets the database system connection details.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetConnectionDetails.go.html to see an example of how to use GetConnectionDetails API. A default retry strategy applies to this operation GetConnectionDetails()
func (client PostgresqlClient) GetDbSystem(ctx context.Context, request GetDbSystemRequest) (response GetDbSystemResponse, err error)
GetDbSystem Gets a database system by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetDbSystem.go.html to see an example of how to use GetDbSystem API. A default retry strategy applies to this operation GetDbSystem()
func (client PostgresqlClient) GetDefaultConfiguration(ctx context.Context, request GetDefaultConfigurationRequest) (response GetDefaultConfigurationResponse, err error)
GetDefaultConfiguration Gets a default configuration by identifier.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetDefaultConfiguration.go.html to see an example of how to use GetDefaultConfiguration API. A default retry strategy applies to this operation GetDefaultConfiguration()
func (client PostgresqlClient) GetPrimaryDbInstance(ctx context.Context, request GetPrimaryDbInstanceRequest) (response GetPrimaryDbInstanceResponse, err error)
GetPrimaryDbInstance Gets the primary database instance node details.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetPrimaryDbInstance.go.html to see an example of how to use GetPrimaryDbInstance API. A default retry strategy applies to this operation GetPrimaryDbInstance()
func (client PostgresqlClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets details of the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client PostgresqlClient) ListBackups(ctx context.Context, request ListBackupsRequest) (response ListBackupsResponse, err error)
ListBackups Returns a list of backups.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListBackups.go.html to see an example of how to use ListBackups API. A default retry strategy applies to this operation ListBackups()
func (client PostgresqlClient) ListConfigurations(ctx context.Context, request ListConfigurationsRequest) (response ListConfigurationsResponse, err error)
ListConfigurations Returns a list of configurations.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListConfigurations.go.html to see an example of how to use ListConfigurations API. A default retry strategy applies to this operation ListConfigurations()
func (client PostgresqlClient) ListDbSystems(ctx context.Context, request ListDbSystemsRequest) (response ListDbSystemsResponse, err error)
ListDbSystems Returns a list of database systems.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListDbSystems.go.html to see an example of how to use ListDbSystems API. A default retry strategy applies to this operation ListDbSystems()
func (client PostgresqlClient) ListDefaultConfigurations(ctx context.Context, request ListDefaultConfigurationsRequest) (response ListDefaultConfigurationsResponse, err error)
ListDefaultConfigurations Returns a list of default configurations.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListDefaultConfigurations.go.html to see an example of how to use ListDefaultConfigurations API. A default retry strategy applies to this operation ListDefaultConfigurations()
func (client PostgresqlClient) ListShapes(ctx context.Context, request ListShapesRequest) (response ListShapesResponse, err error)
ListShapes Returns the list of shapes allowed in the region.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListShapes.go.html to see an example of how to use ListShapes API. A default retry strategy applies to this operation ListShapes()
func (client PostgresqlClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client PostgresqlClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client PostgresqlClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client PostgresqlClient) PatchDbSystem(ctx context.Context, request PatchDbSystemRequest) (response PatchDbSystemResponse, err error)
PatchDbSystem Modifies the database system by adding or removing database instance nodes.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/PatchDbSystem.go.html to see an example of how to use PatchDbSystem API. A default retry strategy applies to this operation PatchDbSystem()
func (client PostgresqlClient) ResetMasterUserPassword(ctx context.Context, request ResetMasterUserPasswordRequest) (response ResetMasterUserPasswordResponse, err error)
ResetMasterUserPassword Resets the database system's master password.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ResetMasterUserPassword.go.html to see an example of how to use ResetMasterUserPassword API. A default retry strategy applies to this operation ResetMasterUserPassword()
func (client PostgresqlClient) RestartDbInstanceInDbSystem(ctx context.Context, request RestartDbInstanceInDbSystemRequest) (response RestartDbInstanceInDbSystemResponse, err error)
RestartDbInstanceInDbSystem Restarts the running database instance node.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/RestartDbInstanceInDbSystem.go.html to see an example of how to use RestartDbInstanceInDbSystem API. A default retry strategy applies to this operation RestartDbInstanceInDbSystem()
func (client PostgresqlClient) RestoreDbSystem(ctx context.Context, request RestoreDbSystemRequest) (response RestoreDbSystemResponse, err error)
RestoreDbSystem Restore the database system.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/RestoreDbSystem.go.html to see an example of how to use RestoreDbSystem API. A default retry strategy applies to this operation RestoreDbSystem()
func (client *PostgresqlClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client PostgresqlClient) UpdateBackup(ctx context.Context, request UpdateBackupRequest) (response UpdateBackupResponse, err error)
UpdateBackup Updates the backup.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/UpdateBackup.go.html to see an example of how to use UpdateBackup API. A default retry strategy applies to this operation UpdateBackup()
func (client PostgresqlClient) UpdateConfiguration(ctx context.Context, request UpdateConfigurationRequest) (response UpdateConfigurationResponse, err error)
UpdateConfiguration Updates a display name or description of the configuration.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/UpdateConfiguration.go.html to see an example of how to use UpdateConfiguration API. A default retry strategy applies to this operation UpdateConfiguration()
func (client PostgresqlClient) UpdateDbSystem(ctx context.Context, request UpdateDbSystemRequest) (response UpdateDbSystemResponse, err error)
UpdateDbSystem Updates the database system.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/UpdateDbSystem.go.html to see an example of how to use UpdateDbSystem API. A default retry strategy applies to this operation UpdateDbSystem()
func (client PostgresqlClient) UpdateDbSystemDbInstance(ctx context.Context, request UpdateDbSystemDbInstanceRequest) (response UpdateDbSystemDbInstanceResponse, err error)
UpdateDbSystemDbInstance Updates the database instance node.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/UpdateDbSystemDbInstance.go.html to see an example of how to use UpdateDbSystemDbInstance API. A default retry strategy applies to this operation UpdateDbSystemDbInstance()
PrimaryDbInstanceDetails The primary database instance node details.
type PrimaryDbInstanceDetails struct {
// A unique identifier for the primary database instance node.
DbInstanceId *string `mandatory:"true" json:"dbInstanceId"`
}
func (m PrimaryDbInstanceDetails) String() string
func (m PrimaryDbInstanceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResetMasterUserPasswordDetails Password detail that will be used to reset the database system's master user. These details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
type ResetMasterUserPasswordDetails struct {
PasswordDetails PasswordDetails `mandatory:"true" json:"passwordDetails"`
}
func (m ResetMasterUserPasswordDetails) String() string
func (m *ResetMasterUserPasswordDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ResetMasterUserPasswordDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResetMasterUserPasswordRequest wrapper for the ResetMasterUserPassword operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/ResetMasterUserPassword.go.html to see an example of how to use ResetMasterUserPasswordRequest.
type ResetMasterUserPasswordRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// The information to be updated.
ResetMasterUserPasswordDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
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 ResetMasterUserPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ResetMasterUserPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResetMasterUserPasswordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResetMasterUserPasswordRequest) String() string
func (request ResetMasterUserPasswordRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResetMasterUserPasswordResponse wrapper for the ResetMasterUserPassword operation
type ResetMasterUserPasswordResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ResetMasterUserPasswordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResetMasterUserPasswordResponse) String() string
RestartDbInstanceInDbSystemDetails Database instance node restart parameters.
type RestartDbInstanceInDbSystemDetails struct {
// A unique identifier for the database instance, or node.
DbInstanceId *string `mandatory:"true" json:"dbInstanceId"`
// The restart type for the database instance.
RestartType RestartDbInstanceInDbSystemDetailsRestartTypeEnum `mandatory:"true" json:"restartType"`
}
func (m RestartDbInstanceInDbSystemDetails) String() string
func (m RestartDbInstanceInDbSystemDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestartDbInstanceInDbSystemDetailsRestartTypeEnum Enum with underlying type: string
type RestartDbInstanceInDbSystemDetailsRestartTypeEnum string
Set of constants representing the allowable values for RestartDbInstanceInDbSystemDetailsRestartTypeEnum
const (
RestartDbInstanceInDbSystemDetailsRestartTypeNormal RestartDbInstanceInDbSystemDetailsRestartTypeEnum = "NORMAL"
RestartDbInstanceInDbSystemDetailsRestartTypeNodeReboot RestartDbInstanceInDbSystemDetailsRestartTypeEnum = "NODE_REBOOT"
)
func GetMappingRestartDbInstanceInDbSystemDetailsRestartTypeEnum(val string) (RestartDbInstanceInDbSystemDetailsRestartTypeEnum, bool)
GetMappingRestartDbInstanceInDbSystemDetailsRestartTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumValues() []RestartDbInstanceInDbSystemDetailsRestartTypeEnum
GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumValues Enumerates the set of values for RestartDbInstanceInDbSystemDetailsRestartTypeEnum
RestartDbInstanceInDbSystemRequest wrapper for the RestartDbInstanceInDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/RestartDbInstanceInDbSystem.go.html to see an example of how to use RestartDbInstanceInDbSystemRequest.
type RestartDbInstanceInDbSystemRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// Database instance node restart parameters.
RestartDbInstanceInDbSystemDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
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 RestartDbInstanceInDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestartDbInstanceInDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestartDbInstanceInDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestartDbInstanceInDbSystemRequest) String() string
func (request RestartDbInstanceInDbSystemRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestartDbInstanceInDbSystemResponse wrapper for the RestartDbInstanceInDbSystem operation
type RestartDbInstanceInDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RestartDbInstanceInDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestartDbInstanceInDbSystemResponse) String() string
RestoreDbSystemDetails Backup details to restore the database system.
type RestoreDbSystemDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the database system backup.
BackupId *string `mandatory:"true" json:"backupId"`
// The desired AD for regions with three ADs. This parameter is optional.
// If not set, the AD is chosen based on the database system's current AD.
Ad *string `mandatory:"false" json:"ad"`
}
func (m RestoreDbSystemDetails) String() string
func (m RestoreDbSystemDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreDbSystemRequest wrapper for the RestoreDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/RestoreDbSystem.go.html to see an example of how to use RestoreDbSystemRequest.
type RestoreDbSystemRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// Database system restore parameters.
RestoreDbSystemDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
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 RestoreDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestoreDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreDbSystemRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreDbSystemRequest) String() string
func (request RestoreDbSystemRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreDbSystemResponse wrapper for the RestoreDbSystem operation
type RestoreDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RestoreDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreDbSystemResponse) String() string
ShapeCollection The list of shapes that can be used to create a database system.
type ShapeCollection struct {
// List of supported shapes.
Items []ShapeSummary `mandatory:"true" json:"items"`
}
func (m ShapeCollection) String() string
func (m ShapeCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShapeSummary Summary of the database system shape.
type ShapeSummary struct {
// The name of the Compute VM shape.
// Example: `VM.Standard.E4.Flex`
Shape *string `mandatory:"true" json:"shape"`
// The number of OCPUs.
OcpuCount *int `mandatory:"true" json:"ocpuCount"`
// The amount of memory in gigabytes.
MemorySizeInGBs *int `mandatory:"true" json:"memorySizeInGBs"`
// A unique identifier for the shape.
Id *string `mandatory:"false" json:"id"`
}
func (m ShapeSummary) String() string
func (m ShapeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
SourceDetails The source used to restore the database system.
type SourceDetails interface {
}
SourceDetailsSourceTypeEnum Enum with underlying type: string
type SourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for SourceDetailsSourceTypeEnum
const (
SourceDetailsSourceTypeBackup SourceDetailsSourceTypeEnum = "BACKUP"
SourceDetailsSourceTypeNone SourceDetailsSourceTypeEnum = "NONE"
)
func GetMappingSourceDetailsSourceTypeEnum(val string) (SourceDetailsSourceTypeEnum, bool)
GetMappingSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSourceDetailsSourceTypeEnumValues() []SourceDetailsSourceTypeEnum
GetSourceDetailsSourceTypeEnumValues Enumerates the set of values for SourceDetailsSourceTypeEnum
StorageDetails Storage details of the database system.
type StorageDetails interface {
// Specifies if the block volume used for the database system is regional or AD-local.
// If not specified, it will be set to false.
// If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified.
// If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified.
GetIsRegionallyDurable() *bool
// Specifies the availability domain of AD-local storage.
// If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified.
// If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified.
GetAvailabilityDomain() *string
}
UpdateBackupDetails The backup information to be updated.
type UpdateBackupDetails struct {
// A user-friendly display name for the backup. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A description for the backup.
Description *string `mandatory:"false" json:"description"`
// Backup retention period in days.
RetentionPeriod *int `mandatory:"false" json:"retentionPeriod"`
// 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
func (m UpdateBackupDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBackupRequest wrapper for the UpdateBackup operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/UpdateBackup.go.html to see an example of how to use UpdateBackupRequest.
type UpdateBackupRequest struct {
// A unique identifier for the backup.
BackupId *string `mandatory:"true" contributesTo:"path" name:"backupId"`
// The information to be updated.
UpdateBackupDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request UpdateBackupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBackupResponse wrapper for the UpdateBackup operation
type UpdateBackupResponse 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"`
}
func (response UpdateBackupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBackupResponse) String() string
UpdateConfigurationDetails The information to update a configuration.
type UpdateConfigurationDetails struct {
// A user-friendly display name for the configuration. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Details about the configuration set.
Description *string `mandatory:"false" json:"description"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateConfigurationDetails) String() string
func (m UpdateConfigurationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateConfigurationRequest wrapper for the UpdateConfiguration operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/UpdateConfiguration.go.html to see an example of how to use UpdateConfigurationRequest.
type UpdateConfigurationRequest struct {
// A unique identifier for the configuration.
ConfigurationId *string `mandatory:"true" contributesTo:"path" name:"configurationId"`
// Details for updating display name or description for a configuration.
UpdateConfigurationDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, `retrytoken` could be expired or invalidated.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request UpdateConfigurationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateConfigurationResponse wrapper for the UpdateConfiguration operation
type UpdateConfigurationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Configuration instance
Configuration `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateConfigurationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateConfigurationResponse) String() string
UpdateDbConfigParams Configuration for the PostgreSQL database instance.
type UpdateDbConfigParams struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the configuration.
ConfigId *string `mandatory:"true" json:"configId"`
// Whether a configuration update requires a restart of the database instance or a reload of the configuration.
// Some configuration changes require a restart of database instances to be applied.
ApplyConfig UpdateDbConfigParamsApplyConfigEnum `mandatory:"false" json:"applyConfig,omitempty"`
}
func (m UpdateDbConfigParams) String() string
func (m UpdateDbConfigParams) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDbConfigParamsApplyConfigEnum Enum with underlying type: string
type UpdateDbConfigParamsApplyConfigEnum string
Set of constants representing the allowable values for UpdateDbConfigParamsApplyConfigEnum
const (
UpdateDbConfigParamsApplyConfigRestart UpdateDbConfigParamsApplyConfigEnum = "RESTART"
UpdateDbConfigParamsApplyConfigReload UpdateDbConfigParamsApplyConfigEnum = "RELOAD"
)
func GetMappingUpdateDbConfigParamsApplyConfigEnum(val string) (UpdateDbConfigParamsApplyConfigEnum, bool)
GetMappingUpdateDbConfigParamsApplyConfigEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateDbConfigParamsApplyConfigEnumValues() []UpdateDbConfigParamsApplyConfigEnum
GetUpdateDbConfigParamsApplyConfigEnumValues Enumerates the set of values for UpdateDbConfigParamsApplyConfigEnum
UpdateDbSystemDbInstanceDetails Database instance node update parameters.
type UpdateDbSystemDbInstanceDetails struct {
// A user-friendly display name of the database instance node. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user-provided description of the database instance node.
Description *string `mandatory:"false" json:"description"`
}
func (m UpdateDbSystemDbInstanceDetails) String() string
func (m UpdateDbSystemDbInstanceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDbSystemDbInstanceRequest wrapper for the UpdateDbSystemDbInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/UpdateDbSystemDbInstance.go.html to see an example of how to use UpdateDbSystemDbInstanceRequest.
type UpdateDbSystemDbInstanceRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// A unique identifier for the database instance node.
DbInstanceId *string `mandatory:"true" contributesTo:"path" name:"dbInstanceId"`
// Database instance node update parameters.
UpdateDbSystemDbInstanceDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
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 UpdateDbSystemDbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDbSystemDbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDbSystemDbInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDbSystemDbInstanceRequest) String() string
func (request UpdateDbSystemDbInstanceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDbSystemDbInstanceResponse wrapper for the UpdateDbSystemDbInstance operation
type UpdateDbSystemDbInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateDbSystemDbInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDbSystemDbInstanceResponse) String() string
UpdateDbSystemDetails The information to be updated.
type UpdateDbSystemDetails struct {
// A user-friendly display name for the database system. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user-provided description of the database system.
Description *string `mandatory:"false" json:"description"`
DbConfigurationParams *UpdateDbConfigParams `mandatory:"false" json:"dbConfigurationParams"`
ManagementPolicy *ManagementPolicyDetails `mandatory:"false" json:"managementPolicy"`
StorageDetails *UpdateStorageDetailsParams `mandatory:"false" json:"storageDetails"`
// 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 UpdateDbSystemDetails) String() string
func (m UpdateDbSystemDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDbSystemRequest wrapper for the UpdateDbSystem operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.65.0/psql/UpdateDbSystem.go.html to see an example of how to use UpdateDbSystemRequest.
type UpdateDbSystemRequest struct {
// A unique identifier for the database system.
DbSystemId *string `mandatory:"true" contributesTo:"path" name:"dbSystemId"`
// The information to be updated.
UpdateDbSystemDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
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, `retrytoken` could be expired or invalidated.
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 UpdateDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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
func (request UpdateDbSystemRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDbSystemResponse wrapper for the UpdateDbSystem operation
type UpdateDbSystemResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateDbSystemResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDbSystemResponse) String() string
UpdateStorageDetailsParams Storage details of the database system.
type UpdateStorageDetailsParams struct {
// Guaranteed input/output storage requests per second (IOPS) available to the database system.
// Only valid for `OCI_OPTIMIZED_STORAGE` database system type.
Iops *int64 `mandatory:"false" json:"iops"`
}
func (m UpdateStorageDetailsParams) String() string
func (m UpdateStorageDetailsParams) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VaultSecretPasswordDetails Secret details for the database system password.
type VaultSecretPasswordDetails struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the secret where the password is stored.
SecretId *string `mandatory:"true" json:"secretId"`
// The secret version of the stored password.
SecretVersion *string `mandatory:"true" json:"secretVersion"`
}
func (m VaultSecretPasswordDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VaultSecretPasswordDetails) String() string
func (m VaultSecretPasswordDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WeeklyBackupPolicy Weekly backup policy.
type WeeklyBackupPolicy struct {
// Hour of the day when the backup starts.
BackupStart *string `mandatory:"true" json:"backupStart"`
// How many days the data should be stored after the database system deletion.
RetentionDays *int `mandatory:"false" json:"retentionDays"`
// The day of the week that the backup starts.
DaysOfTheWeek []WeeklyBackupPolicyDaysOfTheWeekEnum `mandatory:"true" json:"daysOfTheWeek"`
}
func (m WeeklyBackupPolicy) GetRetentionDays() *int
GetRetentionDays returns RetentionDays
func (m WeeklyBackupPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m WeeklyBackupPolicy) String() string
func (m WeeklyBackupPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WeeklyBackupPolicyDaysOfTheWeekEnum Enum with underlying type: string
type WeeklyBackupPolicyDaysOfTheWeekEnum string
Set of constants representing the allowable values for WeeklyBackupPolicyDaysOfTheWeekEnum
const (
WeeklyBackupPolicyDaysOfTheWeekSunday WeeklyBackupPolicyDaysOfTheWeekEnum = "SUNDAY"
WeeklyBackupPolicyDaysOfTheWeekMonday WeeklyBackupPolicyDaysOfTheWeekEnum = "MONDAY"
WeeklyBackupPolicyDaysOfTheWeekTuesday WeeklyBackupPolicyDaysOfTheWeekEnum = "TUESDAY"
WeeklyBackupPolicyDaysOfTheWeekWednesday WeeklyBackupPolicyDaysOfTheWeekEnum = "WEDNESDAY"
WeeklyBackupPolicyDaysOfTheWeekThursday WeeklyBackupPolicyDaysOfTheWeekEnum = "THURSDAY"
WeeklyBackupPolicyDaysOfTheWeekFriday WeeklyBackupPolicyDaysOfTheWeekEnum = "FRIDAY"
WeeklyBackupPolicyDaysOfTheWeekSaturday WeeklyBackupPolicyDaysOfTheWeekEnum = "SATURDAY"
)
func GetMappingWeeklyBackupPolicyDaysOfTheWeekEnum(val string) (WeeklyBackupPolicyDaysOfTheWeekEnum, bool)
GetMappingWeeklyBackupPolicyDaysOfTheWeekEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWeeklyBackupPolicyDaysOfTheWeekEnumValues() []WeeklyBackupPolicyDaysOfTheWeekEnum
GetWeeklyBackupPolicyDaysOfTheWeekEnumValues Enumerates the set of values for WeeklyBackupPolicyDaysOfTheWeekEnum
WorkRequest An asynchronous work request.
type WorkRequest struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) 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 request 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
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) for the error that occured.
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, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message 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, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type that 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.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) 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 request 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
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly