psql

package
v65.78.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 5, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetBackupLifecycleStateEnumStringValues

func GetBackupLifecycleStateEnumStringValues() []string

GetBackupLifecycleStateEnumStringValues Enumerates the set of values in String for BackupLifecycleStateEnum

func GetBackupPolicyKindEnumStringValues

func GetBackupPolicyKindEnumStringValues() []string

GetBackupPolicyKindEnumStringValues Enumerates the set of values in String for BackupPolicyKindEnum

func GetBackupSourceTypeEnumStringValues

func GetBackupSourceTypeEnumStringValues() []string

GetBackupSourceTypeEnumStringValues Enumerates the set of values in String for BackupSourceTypeEnum

func GetConfigurationConfigTypeEnumStringValues added in v65.71.0

func GetConfigurationConfigTypeEnumStringValues() []string

GetConfigurationConfigTypeEnumStringValues Enumerates the set of values in String for ConfigurationConfigTypeEnum

func GetConfigurationLifecycleStateEnumStringValues

func GetConfigurationLifecycleStateEnumStringValues() []string

GetConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for ConfigurationLifecycleStateEnum

func GetDbInstanceLifecycleStateEnumStringValues

func GetDbInstanceLifecycleStateEnumStringValues() []string

GetDbInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for DbInstanceLifecycleStateEnum

func GetDbSystemLifecycleStateEnumStringValues

func GetDbSystemLifecycleStateEnumStringValues() []string

GetDbSystemLifecycleStateEnumStringValues Enumerates the set of values in String for DbSystemLifecycleStateEnum

func GetDbSystemSystemTypeEnumStringValues

func GetDbSystemSystemTypeEnumStringValues() []string

GetDbSystemSystemTypeEnumStringValues Enumerates the set of values in String for DbSystemSystemTypeEnum

func GetDefaultConfigurationLifecycleStateEnumStringValues

func GetDefaultConfigurationLifecycleStateEnumStringValues() []string

GetDefaultConfigurationLifecycleStateEnumStringValues Enumerates the set of values in String for DefaultConfigurationLifecycleStateEnum

func GetGetDbSystemExcludedFieldsEnumStringValues

func GetGetDbSystemExcludedFieldsEnumStringValues() []string

GetGetDbSystemExcludedFieldsEnumStringValues Enumerates the set of values in String for GetDbSystemExcludedFieldsEnum

func GetListBackupsSortByEnumStringValues

func GetListBackupsSortByEnumStringValues() []string

GetListBackupsSortByEnumStringValues Enumerates the set of values in String for ListBackupsSortByEnum

func GetListBackupsSortOrderEnumStringValues

func GetListBackupsSortOrderEnumStringValues() []string

GetListBackupsSortOrderEnumStringValues Enumerates the set of values in String for ListBackupsSortOrderEnum

func GetListConfigurationsSortByEnumStringValues

func GetListConfigurationsSortByEnumStringValues() []string

GetListConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListConfigurationsSortByEnum

func GetListConfigurationsSortOrderEnumStringValues

func GetListConfigurationsSortOrderEnumStringValues() []string

GetListConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListConfigurationsSortOrderEnum

func GetListDbSystemsSortByEnumStringValues

func GetListDbSystemsSortByEnumStringValues() []string

GetListDbSystemsSortByEnumStringValues Enumerates the set of values in String for ListDbSystemsSortByEnum

func GetListDbSystemsSortOrderEnumStringValues

func GetListDbSystemsSortOrderEnumStringValues() []string

GetListDbSystemsSortOrderEnumStringValues Enumerates the set of values in String for ListDbSystemsSortOrderEnum

func GetListDefaultConfigurationsSortByEnumStringValues

func GetListDefaultConfigurationsSortByEnumStringValues() []string

GetListDefaultConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListDefaultConfigurationsSortByEnum

func GetListDefaultConfigurationsSortOrderEnumStringValues

func GetListDefaultConfigurationsSortOrderEnumStringValues() []string

GetListDefaultConfigurationsSortOrderEnumStringValues Enumerates the set of values in String for ListDefaultConfigurationsSortOrderEnum

func GetListShapesSortByEnumStringValues

func GetListShapesSortByEnumStringValues() []string

GetListShapesSortByEnumStringValues Enumerates the set of values in String for ListShapesSortByEnum

func GetListShapesSortOrderEnumStringValues

func GetListShapesSortOrderEnumStringValues() []string

GetListShapesSortOrderEnumStringValues Enumerates the set of values in String for ListShapesSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetPasswordDetailsPasswordTypeEnumStringValues

func GetPasswordDetailsPasswordTypeEnumStringValues() []string

GetPasswordDetailsPasswordTypeEnumStringValues Enumerates the set of values in String for PasswordDetailsPasswordTypeEnum

func GetPatchInsertInstructionPositionEnumStringValues

func GetPatchInsertInstructionPositionEnumStringValues() []string

GetPatchInsertInstructionPositionEnumStringValues Enumerates the set of values in String for PatchInsertInstructionPositionEnum

func GetPatchInstructionOperationEnumStringValues

func GetPatchInstructionOperationEnumStringValues() []string

GetPatchInstructionOperationEnumStringValues Enumerates the set of values in String for PatchInstructionOperationEnum

func GetPatchMoveInstructionPositionEnumStringValues

func GetPatchMoveInstructionPositionEnumStringValues() []string

GetPatchMoveInstructionPositionEnumStringValues Enumerates the set of values in String for PatchMoveInstructionPositionEnum

func GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumStringValues

func GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumStringValues() []string

GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumStringValues Enumerates the set of values in String for RestartDbInstanceInDbSystemDetailsRestartTypeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetSourceDetailsSourceTypeEnumStringValues

func GetSourceDetailsSourceTypeEnumStringValues() []string

GetSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for SourceDetailsSourceTypeEnum

func GetUpdateDbConfigParamsApplyConfigEnumStringValues

func GetUpdateDbConfigParamsApplyConfigEnumStringValues() []string

GetUpdateDbConfigParamsApplyConfigEnumStringValues Enumerates the set of values in String for UpdateDbConfigParamsApplyConfigEnum

func GetWeeklyBackupPolicyDaysOfTheWeekEnumStringValues

func GetWeeklyBackupPolicyDaysOfTheWeekEnumStringValues() []string

GetWeeklyBackupPolicyDaysOfTheWeekEnumStringValues Enumerates the set of values in String for WeeklyBackupPolicyDaysOfTheWeekEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
	ActionTypeFailed     ActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type Backup

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 request was received, 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"`
}

Backup Database system backup information.

func (Backup) String

func (m Backup) String() string

func (Backup) ValidateEnumValue

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

type BackupCollection

type BackupCollection struct {

	// List of backups.
	Items []BackupSummary `mandatory:"true" json:"items"`
}

BackupCollection Results of a backup search. Contains the BackupSummary items and other information, such as metadata.

func (BackupCollection) String

func (m BackupCollection) String() string

func (BackupCollection) ValidateEnumValue

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

type BackupLifecycleStateEnum

type BackupLifecycleStateEnum string

BackupLifecycleStateEnum Enum with underlying type: string

const (
	BackupLifecycleStateCreating BackupLifecycleStateEnum = "CREATING"
	BackupLifecycleStateActive   BackupLifecycleStateEnum = "ACTIVE"
	BackupLifecycleStateDeleting BackupLifecycleStateEnum = "DELETING"
	BackupLifecycleStateDeleted  BackupLifecycleStateEnum = "DELETED"
	BackupLifecycleStateFailed   BackupLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for BackupLifecycleStateEnum

func GetBackupLifecycleStateEnumValues

func GetBackupLifecycleStateEnumValues() []BackupLifecycleStateEnum

GetBackupLifecycleStateEnumValues Enumerates the set of values for BackupLifecycleStateEnum

func GetMappingBackupLifecycleStateEnum

func GetMappingBackupLifecycleStateEnum(val string) (BackupLifecycleStateEnum, bool)

GetMappingBackupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type BackupPolicy

type BackupPolicy interface {

	// How many days the data should be stored after the database system deletion.
	GetRetentionDays() *int
}

BackupPolicy PostgreSQL database system backup policy.

type BackupPolicyKindEnum

type BackupPolicyKindEnum string

BackupPolicyKindEnum Enum with underlying type: string

const (
	BackupPolicyKindDaily   BackupPolicyKindEnum = "DAILY"
	BackupPolicyKindWeekly  BackupPolicyKindEnum = "WEEKLY"
	BackupPolicyKindMonthly BackupPolicyKindEnum = "MONTHLY"
	BackupPolicyKindNone    BackupPolicyKindEnum = "NONE"
)

Set of constants representing the allowable values for BackupPolicyKindEnum

func GetBackupPolicyKindEnumValues

func GetBackupPolicyKindEnumValues() []BackupPolicyKindEnum

GetBackupPolicyKindEnumValues Enumerates the set of values for BackupPolicyKindEnum

func GetMappingBackupPolicyKindEnum

func GetMappingBackupPolicyKindEnum(val string) (BackupPolicyKindEnum, bool)

GetMappingBackupPolicyKindEnum performs case Insensitive comparison on enum value and return the desired enum

type BackupSourceDetails

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"`
}

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.

func (BackupSourceDetails) MarshalJSON

func (m BackupSourceDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (BackupSourceDetails) String

func (m BackupSourceDetails) String() string

func (BackupSourceDetails) ValidateEnumValue

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

type BackupSourceTypeEnum

type BackupSourceTypeEnum string

BackupSourceTypeEnum Enum with underlying type: string

const (
	BackupSourceTypeScheduled BackupSourceTypeEnum = "SCHEDULED"
	BackupSourceTypeManual    BackupSourceTypeEnum = "MANUAL"
)

Set of constants representing the allowable values for BackupSourceTypeEnum

func GetBackupSourceTypeEnumValues

func GetBackupSourceTypeEnumValues() []BackupSourceTypeEnum

GetBackupSourceTypeEnumValues Enumerates the set of values for BackupSourceTypeEnum

func GetMappingBackupSourceTypeEnum

func GetMappingBackupSourceTypeEnum(val string) (BackupSourceTypeEnum, bool)

GetMappingBackupSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BackupSummary

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, taken on schedule defined in the a backup policy, or copied from the remote location.
	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"`
}

BackupSummary Summary information for a backup.

func (BackupSummary) String

func (m BackupSummary) String() string

func (BackupSummary) ValidateEnumValue

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

type ChangeBackupCompartmentDetails

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"`
}

ChangeBackupCompartmentDetails The information used to move a backup to a different compartment.

func (ChangeBackupCompartmentDetails) String

func (ChangeBackupCompartmentDetails) ValidateEnumValue

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

type 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
}

ChangeBackupCompartmentRequest wrapper for the ChangeBackupCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ChangeBackupCompartment.go.html to see an example of how to use ChangeBackupCompartmentRequest.

func (ChangeBackupCompartmentRequest) BinaryRequestBody

func (request ChangeBackupCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeBackupCompartmentRequest) HTTPRequest

func (request ChangeBackupCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeBackupCompartmentRequest) RetryPolicy

func (request ChangeBackupCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeBackupCompartmentRequest) String

func (request ChangeBackupCompartmentRequest) String() string

func (ChangeBackupCompartmentRequest) ValidateEnumValue

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

type ChangeBackupCompartmentResponse

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"`
}

ChangeBackupCompartmentResponse wrapper for the ChangeBackupCompartment operation

func (ChangeBackupCompartmentResponse) HTTPResponse

func (response ChangeBackupCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeBackupCompartmentResponse) String

func (response ChangeBackupCompartmentResponse) String() string

type ChangeConfigurationCompartmentDetails

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"`
}

ChangeConfigurationCompartmentDetails The information to move a configuration to a different compartment.

func (ChangeConfigurationCompartmentDetails) String

func (ChangeConfigurationCompartmentDetails) ValidateEnumValue

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

type 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
}

ChangeConfigurationCompartmentRequest wrapper for the ChangeConfigurationCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ChangeConfigurationCompartment.go.html to see an example of how to use ChangeConfigurationCompartmentRequest.

func (ChangeConfigurationCompartmentRequest) BinaryRequestBody

func (request ChangeConfigurationCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeConfigurationCompartmentRequest) HTTPRequest

func (request ChangeConfigurationCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeConfigurationCompartmentRequest) RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeConfigurationCompartmentRequest) String

func (ChangeConfigurationCompartmentRequest) ValidateEnumValue

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

type ChangeConfigurationCompartmentResponse

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"`
}

ChangeConfigurationCompartmentResponse wrapper for the ChangeConfigurationCompartment operation

func (ChangeConfigurationCompartmentResponse) HTTPResponse

func (response ChangeConfigurationCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeConfigurationCompartmentResponse) String

type ChangeDbSystemCompartmentDetails

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"`
}

ChangeDbSystemCompartmentDetails Change database system compartment operation details.

func (ChangeDbSystemCompartmentDetails) String

func (ChangeDbSystemCompartmentDetails) ValidateEnumValue

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

type 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
}

ChangeDbSystemCompartmentRequest wrapper for the ChangeDbSystemCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ChangeDbSystemCompartment.go.html to see an example of how to use ChangeDbSystemCompartmentRequest.

func (ChangeDbSystemCompartmentRequest) BinaryRequestBody

func (request ChangeDbSystemCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeDbSystemCompartmentRequest) HTTPRequest

func (request ChangeDbSystemCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeDbSystemCompartmentRequest) RetryPolicy

func (request ChangeDbSystemCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeDbSystemCompartmentRequest) String

func (request ChangeDbSystemCompartmentRequest) String() string

func (ChangeDbSystemCompartmentRequest) ValidateEnumValue

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

type ChangeDbSystemCompartmentResponse

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"`
}

ChangeDbSystemCompartmentResponse wrapper for the ChangeDbSystemCompartment operation

func (ChangeDbSystemCompartmentResponse) HTTPResponse

func (response ChangeDbSystemCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeDbSystemCompartmentResponse) String

func (response ChangeDbSystemCompartmentResponse) String() string

type ConfigOverrides

type ConfigOverrides struct {

	// Configuration variable name.
	ConfigKey *string `mandatory:"true" json:"configKey"`

	// User-selected variable value.
	OverridenConfigValue *string `mandatory:"true" json:"overridenConfigValue"`
}

ConfigOverrides Configuration overrides for a PostgreSQL instance.

func (ConfigOverrides) String

func (m ConfigOverrides) String() string

func (ConfigOverrides) ValidateEnumValue

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

type ConfigParams

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"`
}

ConfigParams Database configuration.

func (ConfigParams) String

func (m ConfigParams) String() string

func (ConfigParams) ValidateEnumValue

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

type Configuration

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"`

	// Version of the PostgreSQL database.
	DbVersion *string `mandatory:"true" json:"dbVersion"`

	// The name of the shape for the configuration.
	// Example: `VM.Standard.E4.Flex`
	Shape *string `mandatory:"true" json:"shape"`

	// CPU core count.
	// It's value is set to 0 if configuration is for a flexible shape.
	InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`

	// Memory size in gigabytes with 1GB increment.
	// It's value is set to 0 if configuration is for a flexible shape.
	InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`

	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"`

	// The type of configuration. Either user-created or a default configuration.
	ConfigType ConfigurationConfigTypeEnum `mandatory:"false" json:"configType,omitempty"`

	// Whether the configuration supports flexible shapes.
	IsFlexible *bool `mandatory:"false" json:"isFlexible"`

	// 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"`
}

Configuration PostgreSQL configuration for a database system.

func (Configuration) String

func (m Configuration) String() string

func (Configuration) ValidateEnumValue

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

type ConfigurationCollection

type ConfigurationCollection struct {

	// List of configurations.
	Items []ConfigurationSummary `mandatory:"true" json:"items"`
}

ConfigurationCollection Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata.

func (ConfigurationCollection) String

func (m ConfigurationCollection) String() string

func (ConfigurationCollection) ValidateEnumValue

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

type ConfigurationConfigTypeEnum added in v65.71.0

type ConfigurationConfigTypeEnum string

ConfigurationConfigTypeEnum Enum with underlying type: string

const (
	ConfigurationConfigTypeDefault ConfigurationConfigTypeEnum = "DEFAULT"
	ConfigurationConfigTypeCustom  ConfigurationConfigTypeEnum = "CUSTOM"
)

Set of constants representing the allowable values for ConfigurationConfigTypeEnum

func GetConfigurationConfigTypeEnumValues added in v65.71.0

func GetConfigurationConfigTypeEnumValues() []ConfigurationConfigTypeEnum

GetConfigurationConfigTypeEnumValues Enumerates the set of values for ConfigurationConfigTypeEnum

func GetMappingConfigurationConfigTypeEnum added in v65.71.0

func GetMappingConfigurationConfigTypeEnum(val string) (ConfigurationConfigTypeEnum, bool)

GetMappingConfigurationConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ConfigurationDetails

type ConfigurationDetails struct {

	// List of ConfigParms object.
	Items []ConfigParams `mandatory:"true" json:"items"`
}

ConfigurationDetails List of configuration details.

func (ConfigurationDetails) String

func (m ConfigurationDetails) String() string

func (ConfigurationDetails) ValidateEnumValue

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

type ConfigurationLifecycleStateEnum

type ConfigurationLifecycleStateEnum string

ConfigurationLifecycleStateEnum Enum with underlying type: string

const (
	ConfigurationLifecycleStateActive   ConfigurationLifecycleStateEnum = "ACTIVE"
	ConfigurationLifecycleStateDeleting ConfigurationLifecycleStateEnum = "DELETING"
	ConfigurationLifecycleStateDeleted  ConfigurationLifecycleStateEnum = "DELETED"
	ConfigurationLifecycleStateFailed   ConfigurationLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ConfigurationLifecycleStateEnum

func GetConfigurationLifecycleStateEnumValues

func GetConfigurationLifecycleStateEnumValues() []ConfigurationLifecycleStateEnum

GetConfigurationLifecycleStateEnumValues Enumerates the set of values for ConfigurationLifecycleStateEnum

func GetMappingConfigurationLifecycleStateEnum

func GetMappingConfigurationLifecycleStateEnum(val string) (ConfigurationLifecycleStateEnum, bool)

GetMappingConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ConfigurationSummary

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"`

	// Version of the PostgreSQL database.
	DbVersion *string `mandatory:"true" json:"dbVersion"`

	// The name of the shape for the configuration.
	// Example: `VM.Standard.E4.Flex`
	Shape *string `mandatory:"true" json:"shape"`

	// CPU core count.
	// It's value is set to 0 if configuration is for a flexible shape.
	InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`

	// Memory size in gigabytes with 1GB increment.
	// It's value is set to 0 if configuration is for a flexible shape.
	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"`

	// Whether the configuration supports flexible shapes.
	IsFlexible *bool `mandatory:"false" json:"isFlexible"`

	// 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"`
}

ConfigurationSummary Summary of the configuration.

func (ConfigurationSummary) String

func (m ConfigurationSummary) String() string

func (ConfigurationSummary) ValidateEnumValue

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

type ConnectionDetails

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"`
}

ConnectionDetails Database system connection information. Used to connect to PostgreSQL instance(s).

func (ConnectionDetails) String

func (m ConnectionDetails) String() string

func (ConnectionDetails) ValidateEnumValue

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

type CreateBackupDetails

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"`
}

CreateBackupDetails The information to create a new backup.

func (CreateBackupDetails) String

func (m CreateBackupDetails) String() string

func (CreateBackupDetails) ValidateEnumValue

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

type 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
}

CreateBackupRequest wrapper for the CreateBackup operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/CreateBackup.go.html to see an example of how to use CreateBackupRequest.

func (CreateBackupRequest) BinaryRequestBody

func (request CreateBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateBackupRequest) HTTPRequest

func (request CreateBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBackupRequest) RetryPolicy

func (request CreateBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBackupRequest) String

func (request CreateBackupRequest) String() string

func (CreateBackupRequest) ValidateEnumValue

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

type CreateBackupResponse

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"`
}

CreateBackupResponse wrapper for the CreateBackup operation

func (CreateBackupResponse) HTTPResponse

func (response CreateBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBackupResponse) String

func (response CreateBackupResponse) String() string

type CreateConfigurationDetails

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"`

	// Version of the PostgreSQL database.
	DbVersion *string `mandatory:"true" json:"dbVersion"`

	// The name of the shape for the configuration.
	// Example: `VM.Standard.E4.Flex`
	Shape *string `mandatory:"true" json:"shape"`

	DbConfigurationOverrides *DbConfigurationOverrideCollection `mandatory:"true" json:"dbConfigurationOverrides"`

	// Details about the configuration set.
	Description *string `mandatory:"false" json:"description"`

	// Whether the configuration supports flexible shapes.
	IsFlexible *bool `mandatory:"false" json:"isFlexible"`

	// CPU core count.
	// Skip or set it's value to 0 if configuration is for a flexible shape.
	InstanceOcpuCount *int `mandatory:"false" json:"instanceOcpuCount"`

	// Memory size in gigabytes with 1GB increment.
	// Skip or set it's value to 0 if configuration is for a flexible shape.
	InstanceMemorySizeInGBs *int `mandatory:"false" json:"instanceMemorySizeInGBs"`

	// 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"`
}

CreateConfigurationDetails The information to create a new configuration.

func (CreateConfigurationDetails) String

func (CreateConfigurationDetails) ValidateEnumValue

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

type 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
}

CreateConfigurationRequest wrapper for the CreateConfiguration operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/CreateConfiguration.go.html to see an example of how to use CreateConfigurationRequest.

func (CreateConfigurationRequest) BinaryRequestBody

func (request CreateConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateConfigurationRequest) HTTPRequest

func (request CreateConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateConfigurationRequest) RetryPolicy

func (request CreateConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateConfigurationRequest) String

func (request CreateConfigurationRequest) String() string

func (CreateConfigurationRequest) ValidateEnumValue

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

type CreateConfigurationResponse

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"`
}

CreateConfigurationResponse wrapper for the CreateConfiguration operation

func (CreateConfigurationResponse) HTTPResponse

func (response CreateConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateConfigurationResponse) String

func (response CreateConfigurationResponse) String() string

type CreateDbInstanceDetails

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"`
}

CreateDbInstanceDetails Information about the new database instance node.

func (CreateDbInstanceDetails) String

func (m CreateDbInstanceDetails) String() string

func (CreateDbInstanceDetails) ValidateEnumValue

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

type CreateDbSystemDetails

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"`

	Credentials *Credentials `mandatory:"true" json:"credentials"`

	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"`

	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"`
}

CreateDbSystemDetails The information about new database system.

func (CreateDbSystemDetails) String

func (m CreateDbSystemDetails) String() string

func (*CreateDbSystemDetails) UnmarshalJSON

func (m *CreateDbSystemDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateDbSystemDetails) ValidateEnumValue

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

type 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
}

CreateDbSystemRequest wrapper for the CreateDbSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/CreateDbSystem.go.html to see an example of how to use CreateDbSystemRequest.

func (CreateDbSystemRequest) BinaryRequestBody

func (request CreateDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDbSystemRequest) HTTPRequest

func (request CreateDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDbSystemRequest) RetryPolicy

func (request CreateDbSystemRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDbSystemRequest) String

func (request CreateDbSystemRequest) String() string

func (CreateDbSystemRequest) ValidateEnumValue

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

type CreateDbSystemResponse

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"`
}

CreateDbSystemResponse wrapper for the CreateDbSystem operation

func (CreateDbSystemResponse) HTTPResponse

func (response CreateDbSystemResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDbSystemResponse) String

func (response CreateDbSystemResponse) String() string

type Credentials

type Credentials struct {

	// The database system administrator username.
	Username *string `mandatory:"true" json:"username"`

	PasswordDetails PasswordDetails `mandatory:"true" json:"passwordDetails"`
}

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}.

func (Credentials) String

func (m Credentials) String() string

func (*Credentials) UnmarshalJSON

func (m *Credentials) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Credentials) ValidateEnumValue

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

type DailyBackupPolicy

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"`
}

DailyBackupPolicy Daily backup policy.

func (DailyBackupPolicy) GetRetentionDays

func (m DailyBackupPolicy) GetRetentionDays() *int

GetRetentionDays returns RetentionDays

func (DailyBackupPolicy) MarshalJSON

func (m DailyBackupPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DailyBackupPolicy) String

func (m DailyBackupPolicy) String() string

func (DailyBackupPolicy) ValidateEnumValue

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

type DbConfigurationOverrideCollection

type DbConfigurationOverrideCollection struct {

	// List of configuration overridden values.
	Items []ConfigOverrides `mandatory:"true" json:"items"`
}

DbConfigurationOverrideCollection Configuration overrides for a PostgreSQL instance.

func (DbConfigurationOverrideCollection) String

func (DbConfigurationOverrideCollection) ValidateEnumValue

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

type DbInstance

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"`
}

DbInstance Information about a database instance node.

func (DbInstance) String

func (m DbInstance) String() string

func (DbInstance) ValidateEnumValue

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

type DbInstanceEndpoint

type DbInstanceEndpoint struct {

	// Unique identifier of the database instance node.
	DbInstanceId *string `mandatory:"true" json:"dbInstanceId"`

	Endpoint *Endpoint `mandatory:"true" json:"endpoint"`
}

DbInstanceEndpoint The database instance node endpoint information.

func (DbInstanceEndpoint) String

func (m DbInstanceEndpoint) String() string

func (DbInstanceEndpoint) ValidateEnumValue

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

type DbInstanceLifecycleStateEnum

type DbInstanceLifecycleStateEnum string

DbInstanceLifecycleStateEnum Enum with underlying type: string

const (
	DbInstanceLifecycleStateCreating DbInstanceLifecycleStateEnum = "CREATING"
	DbInstanceLifecycleStateUpdating DbInstanceLifecycleStateEnum = "UPDATING"
	DbInstanceLifecycleStateActive   DbInstanceLifecycleStateEnum = "ACTIVE"
	DbInstanceLifecycleStateInactive DbInstanceLifecycleStateEnum = "INACTIVE"
	DbInstanceLifecycleStateDeleting DbInstanceLifecycleStateEnum = "DELETING"
	DbInstanceLifecycleStateDeleted  DbInstanceLifecycleStateEnum = "DELETED"
	DbInstanceLifecycleStateFailed   DbInstanceLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DbInstanceLifecycleStateEnum

func GetDbInstanceLifecycleStateEnumValues

func GetDbInstanceLifecycleStateEnumValues() []DbInstanceLifecycleStateEnum

GetDbInstanceLifecycleStateEnumValues Enumerates the set of values for DbInstanceLifecycleStateEnum

func GetMappingDbInstanceLifecycleStateEnum

func GetMappingDbInstanceLifecycleStateEnum(val string) (DbInstanceLifecycleStateEnum, bool)

GetMappingDbInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DbSystem

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"`
}

DbSystem Information about a database system.

func (DbSystem) String

func (m DbSystem) String() string

func (*DbSystem) UnmarshalJSON

func (m *DbSystem) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (DbSystem) ValidateEnumValue

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

type DbSystemCollection

type DbSystemCollection struct {

	// List of database systems.
	Items []DbSystemSummary `mandatory:"true" json:"items"`
}

DbSystemCollection Results of a database system search. Contains both DbSystemSummary items and other information, such as metadata.

func (DbSystemCollection) String

func (m DbSystemCollection) String() string

func (DbSystemCollection) ValidateEnumValue

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

type DbSystemDetails

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"`
}

DbSystemDetails Information about the database system associated with a backup.

func (DbSystemDetails) String

func (m DbSystemDetails) String() string

func (DbSystemDetails) ValidateEnumValue

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

type DbSystemLifecycleStateEnum

type DbSystemLifecycleStateEnum string

DbSystemLifecycleStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for DbSystemLifecycleStateEnum

func GetDbSystemLifecycleStateEnumValues

func GetDbSystemLifecycleStateEnumValues() []DbSystemLifecycleStateEnum

GetDbSystemLifecycleStateEnumValues Enumerates the set of values for DbSystemLifecycleStateEnum

func GetMappingDbSystemLifecycleStateEnum

func GetMappingDbSystemLifecycleStateEnum(val string) (DbSystemLifecycleStateEnum, bool)

GetMappingDbSystemLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DbSystemSummary

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"`
}

DbSystemSummary Summary information about a database system.

func (DbSystemSummary) String

func (m DbSystemSummary) String() string

func (DbSystemSummary) ValidateEnumValue

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

type DbSystemSystemTypeEnum

type DbSystemSystemTypeEnum string

DbSystemSystemTypeEnum Enum with underlying type: string

const (
	DbSystemSystemTypeOciOptimizedStorage DbSystemSystemTypeEnum = "OCI_OPTIMIZED_STORAGE"
)

Set of constants representing the allowable values for DbSystemSystemTypeEnum

func GetDbSystemSystemTypeEnumValues

func GetDbSystemSystemTypeEnumValues() []DbSystemSystemTypeEnum

GetDbSystemSystemTypeEnumValues Enumerates the set of values for DbSystemSystemTypeEnum

func GetMappingDbSystemSystemTypeEnum

func GetMappingDbSystemSystemTypeEnum(val string) (DbSystemSystemTypeEnum, bool)

GetMappingDbSystemSystemTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type DefaultConfigParams

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"`
}

DefaultConfigParams Default database configuration.

func (DefaultConfigParams) String

func (m DefaultConfigParams) String() string

func (DefaultConfigParams) ValidateEnumValue

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

type DefaultConfiguration

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"`

	// Version of the PostgreSQL database.
	DbVersion *string `mandatory:"true" json:"dbVersion"`

	// The name of the shape for the configuration.
	// Example: `VM.Standard.E4.Flex`
	Shape *string `mandatory:"true" json:"shape"`

	// CPU core count.
	// Its value is set to 0 if configuration is for a flexible shape.
	InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`

	// Memory size in gigabytes with 1GB increment.
	// Its value is set to 0 if configuration is for a flexible shape.
	InstanceMemorySizeInGBs *int `mandatory:"true" json:"instanceMemorySizeInGBs"`

	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"`

	// True if the configuration supports flexible shapes, false otherwise.
	IsFlexible *bool `mandatory:"false" json:"isFlexible"`
}

DefaultConfiguration Default configurations for PostgreSQL database systems.

func (DefaultConfiguration) String

func (m DefaultConfiguration) String() string

func (DefaultConfiguration) ValidateEnumValue

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

type DefaultConfigurationCollection

type DefaultConfigurationCollection struct {

	// List of configurations.
	Items []DefaultConfigurationSummary `mandatory:"true" json:"items"`
}

DefaultConfigurationCollection Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata.

func (DefaultConfigurationCollection) String

func (DefaultConfigurationCollection) ValidateEnumValue

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

type DefaultConfigurationDetails

type DefaultConfigurationDetails struct {

	// List of ConfigParms object.
	Items []DefaultConfigParams `mandatory:"true" json:"items"`
}

DefaultConfigurationDetails List of default configuration values for databases.

func (DefaultConfigurationDetails) String

func (DefaultConfigurationDetails) ValidateEnumValue

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

type DefaultConfigurationLifecycleStateEnum

type DefaultConfigurationLifecycleStateEnum string

DefaultConfigurationLifecycleStateEnum Enum with underlying type: string

const (
	DefaultConfigurationLifecycleStateActive   DefaultConfigurationLifecycleStateEnum = "ACTIVE"
	DefaultConfigurationLifecycleStateInactive DefaultConfigurationLifecycleStateEnum = "INACTIVE"
	DefaultConfigurationLifecycleStateDeleting DefaultConfigurationLifecycleStateEnum = "DELETING"
	DefaultConfigurationLifecycleStateDeleted  DefaultConfigurationLifecycleStateEnum = "DELETED"
	DefaultConfigurationLifecycleStateFailed   DefaultConfigurationLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DefaultConfigurationLifecycleStateEnum

func GetDefaultConfigurationLifecycleStateEnumValues

func GetDefaultConfigurationLifecycleStateEnumValues() []DefaultConfigurationLifecycleStateEnum

GetDefaultConfigurationLifecycleStateEnumValues Enumerates the set of values for DefaultConfigurationLifecycleStateEnum

func GetMappingDefaultConfigurationLifecycleStateEnum

func GetMappingDefaultConfigurationLifecycleStateEnum(val string) (DefaultConfigurationLifecycleStateEnum, bool)

GetMappingDefaultConfigurationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DefaultConfigurationSummary

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"`

	// Version of the PostgreSQL database.
	DbVersion *string `mandatory:"true" json:"dbVersion"`

	// The name of the shape for the configuration.
	// Example: `VM.Standard.E4.Flex`
	Shape *string `mandatory:"true" json:"shape"`

	// CPU core count.
	// It's value is set to 0 if configuration is for a flexible shape.
	InstanceOcpuCount *int `mandatory:"true" json:"instanceOcpuCount"`

	// Memory size in gigabytes with 1GB increment.
	// It's value is set to 0 if configuration is for a flexible shape.
	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"`

	// True if the configuration supports flexible shapes, false otherwise.
	IsFlexible *bool `mandatory:"false" json:"isFlexible"`
}

DefaultConfigurationSummary Summary of the configuration.

func (DefaultConfigurationSummary) String

func (DefaultConfigurationSummary) ValidateEnumValue

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

type 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
}

DeleteBackupRequest wrapper for the DeleteBackup operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/DeleteBackup.go.html to see an example of how to use DeleteBackupRequest.

func (DeleteBackupRequest) BinaryRequestBody

func (request DeleteBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteBackupRequest) HTTPRequest

func (request DeleteBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBackupRequest) RetryPolicy

func (request DeleteBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBackupRequest) String

func (request DeleteBackupRequest) String() string

func (DeleteBackupRequest) ValidateEnumValue

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

type DeleteBackupResponse

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"`
}

DeleteBackupResponse wrapper for the DeleteBackup operation

func (DeleteBackupResponse) HTTPResponse

func (response DeleteBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBackupResponse) String

func (response DeleteBackupResponse) String() string

type 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
}

DeleteConfigurationRequest wrapper for the DeleteConfiguration operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/DeleteConfiguration.go.html to see an example of how to use DeleteConfigurationRequest.

func (DeleteConfigurationRequest) BinaryRequestBody

func (request DeleteConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteConfigurationRequest) HTTPRequest

func (request DeleteConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteConfigurationRequest) RetryPolicy

func (request DeleteConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteConfigurationRequest) String

func (request DeleteConfigurationRequest) String() string

func (DeleteConfigurationRequest) ValidateEnumValue

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

type DeleteConfigurationResponse

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"`
}

DeleteConfigurationResponse wrapper for the DeleteConfiguration operation

func (DeleteConfigurationResponse) HTTPResponse

func (response DeleteConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteConfigurationResponse) String

func (response DeleteConfigurationResponse) String() string

type 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
}

DeleteDbSystemRequest wrapper for the DeleteDbSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/DeleteDbSystem.go.html to see an example of how to use DeleteDbSystemRequest.

func (DeleteDbSystemRequest) BinaryRequestBody

func (request DeleteDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDbSystemRequest) HTTPRequest

func (request DeleteDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDbSystemRequest) RetryPolicy

func (request DeleteDbSystemRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDbSystemRequest) String

func (request DeleteDbSystemRequest) String() string

func (DeleteDbSystemRequest) ValidateEnumValue

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

type DeleteDbSystemResponse

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"`
}

DeleteDbSystemResponse wrapper for the DeleteDbSystem operation

func (DeleteDbSystemResponse) HTTPResponse

func (response DeleteDbSystemResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDbSystemResponse) String

func (response DeleteDbSystemResponse) String() string

type 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"`
}

Endpoint Information about the database instance node endpoint.

func (Endpoint) String

func (m Endpoint) String() string

func (Endpoint) ValidateEnumValue

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

type FailoverDbSystemDetails

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"`
}

FailoverDbSystemDetails Database system failover information.

func (FailoverDbSystemDetails) String

func (m FailoverDbSystemDetails) String() string

func (FailoverDbSystemDetails) ValidateEnumValue

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

type 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
}

FailoverDbSystemRequest wrapper for the FailoverDbSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/FailoverDbSystem.go.html to see an example of how to use FailoverDbSystemRequest.

func (FailoverDbSystemRequest) BinaryRequestBody

func (request FailoverDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (FailoverDbSystemRequest) HTTPRequest

func (request FailoverDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (FailoverDbSystemRequest) RetryPolicy

func (request FailoverDbSystemRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (FailoverDbSystemRequest) String

func (request FailoverDbSystemRequest) String() string

func (FailoverDbSystemRequest) ValidateEnumValue

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

type FailoverDbSystemResponse

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"`
}

FailoverDbSystemResponse wrapper for the FailoverDbSystem operation

func (FailoverDbSystemResponse) HTTPResponse

func (response FailoverDbSystemResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (FailoverDbSystemResponse) String

func (response FailoverDbSystemResponse) String() string

type 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
}

GetBackupRequest wrapper for the GetBackup operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/GetBackup.go.html to see an example of how to use GetBackupRequest.

func (GetBackupRequest) BinaryRequestBody

func (request GetBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetBackupRequest) HTTPRequest

func (request GetBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBackupRequest) RetryPolicy

func (request GetBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBackupRequest) String

func (request GetBackupRequest) String() string

func (GetBackupRequest) ValidateEnumValue

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

type GetBackupResponse

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"`
}

GetBackupResponse wrapper for the GetBackup operation

func (GetBackupResponse) HTTPResponse

func (response GetBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBackupResponse) String

func (response GetBackupResponse) String() string

type 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
}

GetConfigurationRequest wrapper for the GetConfiguration operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/GetConfiguration.go.html to see an example of how to use GetConfigurationRequest.

func (GetConfigurationRequest) BinaryRequestBody

func (request GetConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetConfigurationRequest) HTTPRequest

func (request GetConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetConfigurationRequest) RetryPolicy

func (request GetConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetConfigurationRequest) String

func (request GetConfigurationRequest) String() string

func (GetConfigurationRequest) ValidateEnumValue

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

type GetConfigurationResponse

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"`
}

GetConfigurationResponse wrapper for the GetConfiguration operation

func (GetConfigurationResponse) HTTPResponse

func (response GetConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetConfigurationResponse) String

func (response GetConfigurationResponse) String() string

type 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
}

GetConnectionDetailsRequest wrapper for the GetConnectionDetails operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/GetConnectionDetails.go.html to see an example of how to use GetConnectionDetailsRequest.

func (GetConnectionDetailsRequest) BinaryRequestBody

func (request GetConnectionDetailsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetConnectionDetailsRequest) HTTPRequest

func (request GetConnectionDetailsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetConnectionDetailsRequest) RetryPolicy

func (request GetConnectionDetailsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetConnectionDetailsRequest) String

func (request GetConnectionDetailsRequest) String() string

func (GetConnectionDetailsRequest) ValidateEnumValue

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

type GetConnectionDetailsResponse

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"`
}

GetConnectionDetailsResponse wrapper for the GetConnectionDetails operation

func (GetConnectionDetailsResponse) HTTPResponse

func (response GetConnectionDetailsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetConnectionDetailsResponse) String

func (response GetConnectionDetailsResponse) String() string

type GetDbSystemExcludedFieldsEnum

type GetDbSystemExcludedFieldsEnum string

GetDbSystemExcludedFieldsEnum Enum with underlying type: string

const (
	GetDbSystemExcludedFieldsDbconfigurationparams GetDbSystemExcludedFieldsEnum = "dbConfigurationParams"
)

Set of constants representing the allowable values for GetDbSystemExcludedFieldsEnum

func GetGetDbSystemExcludedFieldsEnumValues

func GetGetDbSystemExcludedFieldsEnumValues() []GetDbSystemExcludedFieldsEnum

GetGetDbSystemExcludedFieldsEnumValues Enumerates the set of values for GetDbSystemExcludedFieldsEnum

func GetMappingGetDbSystemExcludedFieldsEnum

func GetMappingGetDbSystemExcludedFieldsEnum(val string) (GetDbSystemExcludedFieldsEnum, bool)

GetMappingGetDbSystemExcludedFieldsEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

GetDbSystemRequest wrapper for the GetDbSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/GetDbSystem.go.html to see an example of how to use GetDbSystemRequest.

func (GetDbSystemRequest) BinaryRequestBody

func (request GetDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDbSystemRequest) HTTPRequest

func (request GetDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDbSystemRequest) RetryPolicy

func (request GetDbSystemRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDbSystemRequest) String

func (request GetDbSystemRequest) String() string

func (GetDbSystemRequest) ValidateEnumValue

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

type GetDbSystemResponse

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"`
}

GetDbSystemResponse wrapper for the GetDbSystem operation

func (GetDbSystemResponse) HTTPResponse

func (response GetDbSystemResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDbSystemResponse) String

func (response GetDbSystemResponse) String() string

type 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
}

GetDefaultConfigurationRequest wrapper for the GetDefaultConfiguration operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/GetDefaultConfiguration.go.html to see an example of how to use GetDefaultConfigurationRequest.

func (GetDefaultConfigurationRequest) BinaryRequestBody

func (request GetDefaultConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDefaultConfigurationRequest) HTTPRequest

func (request GetDefaultConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDefaultConfigurationRequest) RetryPolicy

func (request GetDefaultConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDefaultConfigurationRequest) String

func (request GetDefaultConfigurationRequest) String() string

func (GetDefaultConfigurationRequest) ValidateEnumValue

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

type GetDefaultConfigurationResponse

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"`
}

GetDefaultConfigurationResponse wrapper for the GetDefaultConfiguration operation

func (GetDefaultConfigurationResponse) HTTPResponse

func (response GetDefaultConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDefaultConfigurationResponse) String

func (response GetDefaultConfigurationResponse) String() string

type 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
}

GetPrimaryDbInstanceRequest wrapper for the GetPrimaryDbInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/GetPrimaryDbInstance.go.html to see an example of how to use GetPrimaryDbInstanceRequest.

func (GetPrimaryDbInstanceRequest) BinaryRequestBody

func (request GetPrimaryDbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetPrimaryDbInstanceRequest) HTTPRequest

func (request GetPrimaryDbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPrimaryDbInstanceRequest) RetryPolicy

func (request GetPrimaryDbInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPrimaryDbInstanceRequest) String

func (request GetPrimaryDbInstanceRequest) String() string

func (GetPrimaryDbInstanceRequest) ValidateEnumValue

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

type GetPrimaryDbInstanceResponse

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"`
}

GetPrimaryDbInstanceResponse wrapper for the GetPrimaryDbInstance operation

func (GetPrimaryDbInstanceResponse) HTTPResponse

func (response GetPrimaryDbInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPrimaryDbInstanceResponse) String

func (response GetPrimaryDbInstanceResponse) String() string

type 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

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

type GetWorkRequestResponse

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"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type 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
}

ListBackupsRequest wrapper for the ListBackups operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ListBackups.go.html to see an example of how to use ListBackupsRequest.

func (ListBackupsRequest) BinaryRequestBody

func (request ListBackupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBackupsRequest) HTTPRequest

func (request ListBackupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBackupsRequest) RetryPolicy

func (request ListBackupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBackupsRequest) String

func (request ListBackupsRequest) String() string

func (ListBackupsRequest) ValidateEnumValue

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

type ListBackupsResponse

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"`
}

ListBackupsResponse wrapper for the ListBackups operation

func (ListBackupsResponse) HTTPResponse

func (response ListBackupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBackupsResponse) String

func (response ListBackupsResponse) String() string

type ListBackupsSortByEnum

type ListBackupsSortByEnum string

ListBackupsSortByEnum Enum with underlying type: string

const (
	ListBackupsSortByTimecreated ListBackupsSortByEnum = "timeCreated"
	ListBackupsSortByDisplayname ListBackupsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBackupsSortByEnum

func GetListBackupsSortByEnumValues

func GetListBackupsSortByEnumValues() []ListBackupsSortByEnum

GetListBackupsSortByEnumValues Enumerates the set of values for ListBackupsSortByEnum

func GetMappingListBackupsSortByEnum

func GetMappingListBackupsSortByEnum(val string) (ListBackupsSortByEnum, bool)

GetMappingListBackupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBackupsSortOrderEnum

type ListBackupsSortOrderEnum string

ListBackupsSortOrderEnum Enum with underlying type: string

const (
	ListBackupsSortOrderAsc  ListBackupsSortOrderEnum = "ASC"
	ListBackupsSortOrderDesc ListBackupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBackupsSortOrderEnum

func GetListBackupsSortOrderEnumValues

func GetListBackupsSortOrderEnumValues() []ListBackupsSortOrderEnum

GetListBackupsSortOrderEnumValues Enumerates the set of values for ListBackupsSortOrderEnum

func GetMappingListBackupsSortOrderEnum

func GetMappingListBackupsSortOrderEnum(val string) (ListBackupsSortOrderEnum, bool)

GetMappingListBackupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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"`

	// Version 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
}

ListConfigurationsRequest wrapper for the ListConfigurations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ListConfigurations.go.html to see an example of how to use ListConfigurationsRequest.

func (ListConfigurationsRequest) BinaryRequestBody

func (request ListConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListConfigurationsRequest) HTTPRequest

func (request ListConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListConfigurationsRequest) RetryPolicy

func (request ListConfigurationsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListConfigurationsRequest) String

func (request ListConfigurationsRequest) String() string

func (ListConfigurationsRequest) ValidateEnumValue

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

type ListConfigurationsResponse

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"`
}

ListConfigurationsResponse wrapper for the ListConfigurations operation

func (ListConfigurationsResponse) HTTPResponse

func (response ListConfigurationsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListConfigurationsResponse) String

func (response ListConfigurationsResponse) String() string

type ListConfigurationsSortByEnum

type ListConfigurationsSortByEnum string

ListConfigurationsSortByEnum Enum with underlying type: string

const (
	ListConfigurationsSortByTimecreated ListConfigurationsSortByEnum = "timeCreated"
	ListConfigurationsSortByDisplayname ListConfigurationsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListConfigurationsSortByEnum

func GetListConfigurationsSortByEnumValues

func GetListConfigurationsSortByEnumValues() []ListConfigurationsSortByEnum

GetListConfigurationsSortByEnumValues Enumerates the set of values for ListConfigurationsSortByEnum

func GetMappingListConfigurationsSortByEnum

func GetMappingListConfigurationsSortByEnum(val string) (ListConfigurationsSortByEnum, bool)

GetMappingListConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListConfigurationsSortOrderEnum

type ListConfigurationsSortOrderEnum string

ListConfigurationsSortOrderEnum Enum with underlying type: string

const (
	ListConfigurationsSortOrderAsc  ListConfigurationsSortOrderEnum = "ASC"
	ListConfigurationsSortOrderDesc ListConfigurationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListConfigurationsSortOrderEnum

func GetListConfigurationsSortOrderEnumValues

func GetListConfigurationsSortOrderEnumValues() []ListConfigurationsSortOrderEnum

GetListConfigurationsSortOrderEnumValues Enumerates the set of values for ListConfigurationsSortOrderEnum

func GetMappingListConfigurationsSortOrderEnum

func GetMappingListConfigurationsSortOrderEnum(val string) (ListConfigurationsSortOrderEnum, bool)

GetMappingListConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDbSystemsRequest wrapper for the ListDbSystems operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ListDbSystems.go.html to see an example of how to use ListDbSystemsRequest.

func (ListDbSystemsRequest) BinaryRequestBody

func (request ListDbSystemsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDbSystemsRequest) HTTPRequest

func (request ListDbSystemsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDbSystemsRequest) RetryPolicy

func (request ListDbSystemsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDbSystemsRequest) String

func (request ListDbSystemsRequest) String() string

func (ListDbSystemsRequest) ValidateEnumValue

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

type ListDbSystemsResponse

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"`
}

ListDbSystemsResponse wrapper for the ListDbSystems operation

func (ListDbSystemsResponse) HTTPResponse

func (response ListDbSystemsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDbSystemsResponse) String

func (response ListDbSystemsResponse) String() string

type ListDbSystemsSortByEnum

type ListDbSystemsSortByEnum string

ListDbSystemsSortByEnum Enum with underlying type: string

const (
	ListDbSystemsSortByTimecreated ListDbSystemsSortByEnum = "timeCreated"
	ListDbSystemsSortByDisplayname ListDbSystemsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDbSystemsSortByEnum

func GetListDbSystemsSortByEnumValues

func GetListDbSystemsSortByEnumValues() []ListDbSystemsSortByEnum

GetListDbSystemsSortByEnumValues Enumerates the set of values for ListDbSystemsSortByEnum

func GetMappingListDbSystemsSortByEnum

func GetMappingListDbSystemsSortByEnum(val string) (ListDbSystemsSortByEnum, bool)

GetMappingListDbSystemsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDbSystemsSortOrderEnum

type ListDbSystemsSortOrderEnum string

ListDbSystemsSortOrderEnum Enum with underlying type: string

const (
	ListDbSystemsSortOrderAsc  ListDbSystemsSortOrderEnum = "ASC"
	ListDbSystemsSortOrderDesc ListDbSystemsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDbSystemsSortOrderEnum

func GetListDbSystemsSortOrderEnumValues

func GetListDbSystemsSortOrderEnumValues() []ListDbSystemsSortOrderEnum

GetListDbSystemsSortOrderEnumValues Enumerates the set of values for ListDbSystemsSortOrderEnum

func GetMappingListDbSystemsSortOrderEnum

func GetMappingListDbSystemsSortOrderEnum(val string) (ListDbSystemsSortOrderEnum, bool)

GetMappingListDbSystemsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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"`

	// Version 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
}

ListDefaultConfigurationsRequest wrapper for the ListDefaultConfigurations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ListDefaultConfigurations.go.html to see an example of how to use ListDefaultConfigurationsRequest.

func (ListDefaultConfigurationsRequest) BinaryRequestBody

func (request ListDefaultConfigurationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDefaultConfigurationsRequest) HTTPRequest

func (request ListDefaultConfigurationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDefaultConfigurationsRequest) RetryPolicy

func (request ListDefaultConfigurationsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDefaultConfigurationsRequest) String

func (request ListDefaultConfigurationsRequest) String() string

func (ListDefaultConfigurationsRequest) ValidateEnumValue

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

type ListDefaultConfigurationsResponse

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"`
}

ListDefaultConfigurationsResponse wrapper for the ListDefaultConfigurations operation

func (ListDefaultConfigurationsResponse) HTTPResponse

func (response ListDefaultConfigurationsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDefaultConfigurationsResponse) String

func (response ListDefaultConfigurationsResponse) String() string

type ListDefaultConfigurationsSortByEnum

type ListDefaultConfigurationsSortByEnum string

ListDefaultConfigurationsSortByEnum Enum with underlying type: string

const (
	ListDefaultConfigurationsSortByTimecreated ListDefaultConfigurationsSortByEnum = "timeCreated"
	ListDefaultConfigurationsSortByDisplayname ListDefaultConfigurationsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDefaultConfigurationsSortByEnum

func GetListDefaultConfigurationsSortByEnumValues

func GetListDefaultConfigurationsSortByEnumValues() []ListDefaultConfigurationsSortByEnum

GetListDefaultConfigurationsSortByEnumValues Enumerates the set of values for ListDefaultConfigurationsSortByEnum

func GetMappingListDefaultConfigurationsSortByEnum

func GetMappingListDefaultConfigurationsSortByEnum(val string) (ListDefaultConfigurationsSortByEnum, bool)

GetMappingListDefaultConfigurationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDefaultConfigurationsSortOrderEnum

type ListDefaultConfigurationsSortOrderEnum string

ListDefaultConfigurationsSortOrderEnum Enum with underlying type: string

const (
	ListDefaultConfigurationsSortOrderAsc  ListDefaultConfigurationsSortOrderEnum = "ASC"
	ListDefaultConfigurationsSortOrderDesc ListDefaultConfigurationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDefaultConfigurationsSortOrderEnum

func GetListDefaultConfigurationsSortOrderEnumValues

func GetListDefaultConfigurationsSortOrderEnumValues() []ListDefaultConfigurationsSortOrderEnum

GetListDefaultConfigurationsSortOrderEnumValues Enumerates the set of values for ListDefaultConfigurationsSortOrderEnum

func GetMappingListDefaultConfigurationsSortOrderEnum

func GetMappingListDefaultConfigurationsSortOrderEnum(val string) (ListDefaultConfigurationsSortOrderEnum, bool)

GetMappingListDefaultConfigurationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListShapesRequest wrapper for the ListShapes operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ListShapes.go.html to see an example of how to use ListShapesRequest.

func (ListShapesRequest) BinaryRequestBody

func (request ListShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListShapesRequest) HTTPRequest

func (request ListShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListShapesRequest) RetryPolicy

func (request ListShapesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListShapesRequest) String

func (request ListShapesRequest) String() string

func (ListShapesRequest) ValidateEnumValue

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

type ListShapesResponse

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"`
}

ListShapesResponse wrapper for the ListShapes operation

func (ListShapesResponse) HTTPResponse

func (response ListShapesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListShapesResponse) String

func (response ListShapesResponse) String() string

type ListShapesSortByEnum

type ListShapesSortByEnum string

ListShapesSortByEnum Enum with underlying type: string

const (
	ListShapesSortByTimecreated ListShapesSortByEnum = "timeCreated"
	ListShapesSortByDisplayname ListShapesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListShapesSortByEnum

func GetListShapesSortByEnumValues

func GetListShapesSortByEnumValues() []ListShapesSortByEnum

GetListShapesSortByEnumValues Enumerates the set of values for ListShapesSortByEnum

func GetMappingListShapesSortByEnum

func GetMappingListShapesSortByEnum(val string) (ListShapesSortByEnum, bool)

GetMappingListShapesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListShapesSortOrderEnum

type ListShapesSortOrderEnum string

ListShapesSortOrderEnum Enum with underlying type: string

const (
	ListShapesSortOrderAsc  ListShapesSortOrderEnum = "ASC"
	ListShapesSortOrderDesc ListShapesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListShapesSortOrderEnum

func GetListShapesSortOrderEnumValues

func GetListShapesSortOrderEnumValues() []ListShapesSortOrderEnum

GetListShapesSortOrderEnumValues Enumerates the set of values for ListShapesSortOrderEnum

func GetMappingListShapesSortOrderEnum

func GetMappingListShapesSortOrderEnum(val string) (ListShapesSortOrderEnum, bool)

GetMappingListShapesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

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

type ListWorkRequestErrorsResponse

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"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

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

type ListWorkRequestLogsResponse

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"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

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

type ListWorkRequestsResponse

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"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsStatusEnum

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

const (
	ListWorkRequestsStatusAccepted   ListWorkRequestsStatusEnum = "ACCEPTED"
	ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
	ListWorkRequestsStatusWaiting    ListWorkRequestsStatusEnum = "WAITING"
	ListWorkRequestsStatusFailed     ListWorkRequestsStatusEnum = "FAILED"
	ListWorkRequestsStatusSucceeded  ListWorkRequestsStatusEnum = "SUCCEEDED"
	ListWorkRequestsStatusCanceling  ListWorkRequestsStatusEnum = "CANCELING"
	ListWorkRequestsStatusCanceled   ListWorkRequestsStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type ManagementPolicy

type ManagementPolicy struct {

	// The start of the maintenance window.
	MaintenanceWindowStart *string `mandatory:"true" json:"maintenanceWindowStart"`

	BackupPolicy BackupPolicy `mandatory:"true" json:"backupPolicy"`
}

ManagementPolicy PostgreSQL database system management policy.

func (ManagementPolicy) String

func (m ManagementPolicy) String() string

func (*ManagementPolicy) UnmarshalJSON

func (m *ManagementPolicy) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ManagementPolicy) ValidateEnumValue

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

type ManagementPolicyDetails

type ManagementPolicyDetails struct {

	// The start of the maintenance window in UTC.
	// This string is of the format: "{day-of-week} {time-of-day}".
	// "{day-of-week}" is a case-insensitive string like "mon", "tue", &c.
	// "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero.
	MaintenanceWindowStart *string `mandatory:"false" json:"maintenanceWindowStart"`

	BackupPolicy BackupPolicy `mandatory:"false" json:"backupPolicy"`
}

ManagementPolicyDetails PostgreSQL database system management policy update details.

func (ManagementPolicyDetails) String

func (m ManagementPolicyDetails) String() string

func (*ManagementPolicyDetails) UnmarshalJSON

func (m *ManagementPolicyDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ManagementPolicyDetails) ValidateEnumValue

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

type MonthlyBackupPolicy

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"`
}

MonthlyBackupPolicy Monthly backup policy.

func (MonthlyBackupPolicy) GetRetentionDays

func (m MonthlyBackupPolicy) GetRetentionDays() *int

GetRetentionDays returns RetentionDays

func (MonthlyBackupPolicy) MarshalJSON

func (m MonthlyBackupPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (MonthlyBackupPolicy) String

func (m MonthlyBackupPolicy) String() string

func (MonthlyBackupPolicy) ValidateEnumValue

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

type NetworkDetails

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"`
}

NetworkDetails Network details for the database system.

func (NetworkDetails) String

func (m NetworkDetails) String() string

func (NetworkDetails) ValidateEnumValue

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

type NoneBackupPolicy

type NoneBackupPolicy struct {

	// How many days the data should be stored after the database system deletion.
	RetentionDays *int `mandatory:"false" json:"retentionDays"`
}

NoneBackupPolicy No backup policy.

func (NoneBackupPolicy) GetRetentionDays

func (m NoneBackupPolicy) GetRetentionDays() *int

GetRetentionDays returns RetentionDays

func (NoneBackupPolicy) MarshalJSON

func (m NoneBackupPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (NoneBackupPolicy) String

func (m NoneBackupPolicy) String() string

func (NoneBackupPolicy) ValidateEnumValue

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

type NoneSourceDetails

type NoneSourceDetails struct {
}

NoneSourceDetails This is used to create new database system or update without restoring from backup.

func (NoneSourceDetails) MarshalJSON

func (m NoneSourceDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (NoneSourceDetails) String

func (m NoneSourceDetails) String() string

func (NoneSourceDetails) ValidateEnumValue

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

type OciOptimizedStorageDetails

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"`
}

OciOptimizedStorageDetails Storage details of the database system.

func (OciOptimizedStorageDetails) GetAvailabilityDomain

func (m OciOptimizedStorageDetails) GetAvailabilityDomain() *string

GetAvailabilityDomain returns AvailabilityDomain

func (OciOptimizedStorageDetails) GetIsRegionallyDurable

func (m OciOptimizedStorageDetails) GetIsRegionallyDurable() *bool

GetIsRegionallyDurable returns IsRegionallyDurable

func (OciOptimizedStorageDetails) MarshalJSON

func (m OciOptimizedStorageDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OciOptimizedStorageDetails) String

func (OciOptimizedStorageDetails) ValidateEnumValue

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

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

const (
	OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
	OperationStatusWaiting    OperationStatusEnum = "WAITING"
	OperationStatusFailed     OperationStatusEnum = "FAILED"
	OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling  OperationStatusEnum = "CANCELING"
	OperationStatusCanceled   OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type PasswordDetails

type PasswordDetails interface {
}

PasswordDetails Details for the database system password. Password can be passed as `VaultSecretPasswordDetails` or `PlainTextPasswordDetails`.

type PasswordDetailsPasswordTypeEnum

type PasswordDetailsPasswordTypeEnum string

PasswordDetailsPasswordTypeEnum Enum with underlying type: string

const (
	PasswordDetailsPasswordTypePlainText   PasswordDetailsPasswordTypeEnum = "PLAIN_TEXT"
	PasswordDetailsPasswordTypeVaultSecret PasswordDetailsPasswordTypeEnum = "VAULT_SECRET"
)

Set of constants representing the allowable values for PasswordDetailsPasswordTypeEnum

func GetMappingPasswordDetailsPasswordTypeEnum

func GetMappingPasswordDetailsPasswordTypeEnum(val string) (PasswordDetailsPasswordTypeEnum, bool)

GetMappingPasswordDetailsPasswordTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetPasswordDetailsPasswordTypeEnumValues

func GetPasswordDetailsPasswordTypeEnumValues() []PasswordDetailsPasswordTypeEnum

GetPasswordDetailsPasswordTypeEnumValues Enumerates the set of values for PasswordDetailsPasswordTypeEnum

type PatchDbSystemDetails

type PatchDbSystemDetails struct {

	// List of patch instructions.
	Items []PatchInstruction `mandatory:"false" json:"items"`
}

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.

func (PatchDbSystemDetails) String

func (m PatchDbSystemDetails) String() string

func (*PatchDbSystemDetails) UnmarshalJSON

func (m *PatchDbSystemDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (PatchDbSystemDetails) ValidateEnumValue

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

type 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
}

PatchDbSystemRequest wrapper for the PatchDbSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/PatchDbSystem.go.html to see an example of how to use PatchDbSystemRequest.

func (PatchDbSystemRequest) BinaryRequestBody

func (request PatchDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (PatchDbSystemRequest) HTTPRequest

func (request PatchDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (PatchDbSystemRequest) RetryPolicy

func (request PatchDbSystemRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (PatchDbSystemRequest) String

func (request PatchDbSystemRequest) String() string

func (PatchDbSystemRequest) ValidateEnumValue

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

type PatchDbSystemResponse

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"`
}

PatchDbSystemResponse wrapper for the PatchDbSystem operation

func (PatchDbSystemResponse) HTTPResponse

func (response PatchDbSystemResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (PatchDbSystemResponse) String

func (response PatchDbSystemResponse) String() string

type PatchInsertInstruction

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"`
}

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.

func (PatchInsertInstruction) GetSelection

func (m PatchInsertInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchInsertInstruction) MarshalJSON

func (m PatchInsertInstruction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PatchInsertInstruction) String

func (m PatchInsertInstruction) String() string

func (PatchInsertInstruction) ValidateEnumValue

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

type PatchInsertInstructionPositionEnum

type PatchInsertInstructionPositionEnum string

PatchInsertInstructionPositionEnum Enum with underlying type: string

const (
	PatchInsertInstructionPositionBefore PatchInsertInstructionPositionEnum = "BEFORE"
	PatchInsertInstructionPositionAfter  PatchInsertInstructionPositionEnum = "AFTER"
)

Set of constants representing the allowable values for PatchInsertInstructionPositionEnum

func GetMappingPatchInsertInstructionPositionEnum

func GetMappingPatchInsertInstructionPositionEnum(val string) (PatchInsertInstructionPositionEnum, bool)

GetMappingPatchInsertInstructionPositionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetPatchInsertInstructionPositionEnumValues

func GetPatchInsertInstructionPositionEnumValues() []PatchInsertInstructionPositionEnum

GetPatchInsertInstructionPositionEnumValues Enumerates the set of values for PatchInsertInstructionPositionEnum

type PatchInstruction

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
}

PatchInstruction A single instruction to be included as part of Patch request content.

type PatchInstructionOperationEnum

type PatchInstructionOperationEnum string

PatchInstructionOperationEnum Enum with underlying type: string

const (
	PatchInstructionOperationRequire  PatchInstructionOperationEnum = "REQUIRE"
	PatchInstructionOperationProhibit PatchInstructionOperationEnum = "PROHIBIT"
	PatchInstructionOperationReplace  PatchInstructionOperationEnum = "REPLACE"
	PatchInstructionOperationInsert   PatchInstructionOperationEnum = "INSERT"
	PatchInstructionOperationRemove   PatchInstructionOperationEnum = "REMOVE"
	PatchInstructionOperationMove     PatchInstructionOperationEnum = "MOVE"
	PatchInstructionOperationMerge    PatchInstructionOperationEnum = "MERGE"
)

Set of constants representing the allowable values for PatchInstructionOperationEnum

func GetMappingPatchInstructionOperationEnum

func GetMappingPatchInstructionOperationEnum(val string) (PatchInstructionOperationEnum, bool)

GetMappingPatchInstructionOperationEnum performs case Insensitive comparison on enum value and return the desired enum

func GetPatchInstructionOperationEnumValues

func GetPatchInstructionOperationEnumValues() []PatchInstructionOperationEnum

GetPatchInstructionOperationEnumValues Enumerates the set of values for PatchInstructionOperationEnum

type PatchMergeInstruction

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"`
}

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.

func (PatchMergeInstruction) GetSelection

func (m PatchMergeInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchMergeInstruction) MarshalJSON

func (m PatchMergeInstruction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PatchMergeInstruction) String

func (m PatchMergeInstruction) String() string

func (PatchMergeInstruction) ValidateEnumValue

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

type PatchMoveInstruction

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"`
}

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.

func (PatchMoveInstruction) GetSelection

func (m PatchMoveInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchMoveInstruction) MarshalJSON

func (m PatchMoveInstruction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PatchMoveInstruction) String

func (m PatchMoveInstruction) String() string

func (PatchMoveInstruction) ValidateEnumValue

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

type PatchMoveInstructionPositionEnum

type PatchMoveInstructionPositionEnum string

PatchMoveInstructionPositionEnum Enum with underlying type: string

const (
	PatchMoveInstructionPositionAt     PatchMoveInstructionPositionEnum = "AT"
	PatchMoveInstructionPositionBefore PatchMoveInstructionPositionEnum = "BEFORE"
	PatchMoveInstructionPositionAfter  PatchMoveInstructionPositionEnum = "AFTER"
)

Set of constants representing the allowable values for PatchMoveInstructionPositionEnum

func GetMappingPatchMoveInstructionPositionEnum

func GetMappingPatchMoveInstructionPositionEnum(val string) (PatchMoveInstructionPositionEnum, bool)

GetMappingPatchMoveInstructionPositionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetPatchMoveInstructionPositionEnumValues

func GetPatchMoveInstructionPositionEnumValues() []PatchMoveInstructionPositionEnum

GetPatchMoveInstructionPositionEnumValues Enumerates the set of values for PatchMoveInstructionPositionEnum

type PatchProhibitInstruction

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"`
}

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.

func (PatchProhibitInstruction) GetSelection

func (m PatchProhibitInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchProhibitInstruction) MarshalJSON

func (m PatchProhibitInstruction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PatchProhibitInstruction) String

func (m PatchProhibitInstruction) String() string

func (PatchProhibitInstruction) ValidateEnumValue

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

type PatchRemoveInstruction

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"`
}

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.

func (PatchRemoveInstruction) GetSelection

func (m PatchRemoveInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchRemoveInstruction) MarshalJSON

func (m PatchRemoveInstruction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PatchRemoveInstruction) String

func (m PatchRemoveInstruction) String() string

func (PatchRemoveInstruction) ValidateEnumValue

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

type PatchReplaceInstruction

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"`
}

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.

func (PatchReplaceInstruction) GetSelection

func (m PatchReplaceInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchReplaceInstruction) MarshalJSON

func (m PatchReplaceInstruction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PatchReplaceInstruction) String

func (m PatchReplaceInstruction) String() string

func (PatchReplaceInstruction) ValidateEnumValue

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

type PatchRequireInstruction

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"`
}

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.

func (PatchRequireInstruction) GetSelection

func (m PatchRequireInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchRequireInstruction) MarshalJSON

func (m PatchRequireInstruction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PatchRequireInstruction) String

func (m PatchRequireInstruction) String() string

func (PatchRequireInstruction) ValidateEnumValue

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

type PlainTextPasswordDetails

type PlainTextPasswordDetails struct {

	// The database system password.
	Password *string `mandatory:"true" json:"password"`
}

PlainTextPasswordDetails Details for in-line database system password.

func (PlainTextPasswordDetails) MarshalJSON

func (m PlainTextPasswordDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PlainTextPasswordDetails) String

func (m PlainTextPasswordDetails) String() string

func (PlainTextPasswordDetails) ValidateEnumValue

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

type PostgresqlClient

type PostgresqlClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

PostgresqlClient a client for Postgresql

func NewPostgresqlClientWithConfigurationProvider

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

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 (PostgresqlClient) ChangeBackupCompartment

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/latest/psql/ChangeBackupCompartment.go.html to see an example of how to use ChangeBackupCompartment API. A default retry strategy applies to this operation ChangeBackupCompartment()

func (PostgresqlClient) ChangeConfigurationCompartment

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/latest/psql/ChangeConfigurationCompartment.go.html to see an example of how to use ChangeConfigurationCompartment API. A default retry strategy applies to this operation ChangeConfigurationCompartment()

func (PostgresqlClient) ChangeDbSystemCompartment

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/latest/psql/ChangeDbSystemCompartment.go.html to see an example of how to use ChangeDbSystemCompartment API. A default retry strategy applies to this operation ChangeDbSystemCompartment()

func (*PostgresqlClient) ConfigurationProvider

func (client *PostgresqlClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (PostgresqlClient) CreateBackup

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/latest/psql/CreateBackup.go.html to see an example of how to use CreateBackup API. A default retry strategy applies to this operation CreateBackup()

func (PostgresqlClient) CreateConfiguration

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/latest/psql/CreateConfiguration.go.html to see an example of how to use CreateConfiguration API. A default retry strategy applies to this operation CreateConfiguration()

func (PostgresqlClient) CreateDbSystem

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/latest/psql/CreateDbSystem.go.html to see an example of how to use CreateDbSystem API. A default retry strategy applies to this operation CreateDbSystem()

func (PostgresqlClient) DeleteBackup

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/latest/psql/DeleteBackup.go.html to see an example of how to use DeleteBackup API. A default retry strategy applies to this operation DeleteBackup()

func (PostgresqlClient) DeleteConfiguration

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/latest/psql/DeleteConfiguration.go.html to see an example of how to use DeleteConfiguration API. A default retry strategy applies to this operation DeleteConfiguration()

func (PostgresqlClient) DeleteDbSystem

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/latest/psql/DeleteDbSystem.go.html to see an example of how to use DeleteDbSystem API. A default retry strategy applies to this operation DeleteDbSystem()

func (PostgresqlClient) FailoverDbSystem

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/latest/psql/FailoverDbSystem.go.html to see an example of how to use FailoverDbSystem API. A default retry strategy applies to this operation FailoverDbSystem()

func (PostgresqlClient) GetBackup

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/latest/psql/GetBackup.go.html to see an example of how to use GetBackup API. A default retry strategy applies to this operation GetBackup()

func (PostgresqlClient) GetConfiguration

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/latest/psql/GetConfiguration.go.html to see an example of how to use GetConfiguration API. A default retry strategy applies to this operation GetConfiguration()

func (PostgresqlClient) GetConnectionDetails

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/latest/psql/GetConnectionDetails.go.html to see an example of how to use GetConnectionDetails API. A default retry strategy applies to this operation GetConnectionDetails()

func (PostgresqlClient) GetDbSystem

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/latest/psql/GetDbSystem.go.html to see an example of how to use GetDbSystem API. A default retry strategy applies to this operation GetDbSystem()

func (PostgresqlClient) GetDefaultConfiguration

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/latest/psql/GetDefaultConfiguration.go.html to see an example of how to use GetDefaultConfiguration API. A default retry strategy applies to this operation GetDefaultConfiguration()

func (PostgresqlClient) GetPrimaryDbInstance

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/latest/psql/GetPrimaryDbInstance.go.html to see an example of how to use GetPrimaryDbInstance API. A default retry strategy applies to this operation GetPrimaryDbInstance()

func (PostgresqlClient) GetWorkRequest

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/latest/psql/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (PostgresqlClient) ListBackups

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/latest/psql/ListBackups.go.html to see an example of how to use ListBackups API. A default retry strategy applies to this operation ListBackups()

func (PostgresqlClient) ListConfigurations

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/latest/psql/ListConfigurations.go.html to see an example of how to use ListConfigurations API. A default retry strategy applies to this operation ListConfigurations()

func (PostgresqlClient) ListDbSystems

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/latest/psql/ListDbSystems.go.html to see an example of how to use ListDbSystems API. A default retry strategy applies to this operation ListDbSystems()

func (PostgresqlClient) ListDefaultConfigurations

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/latest/psql/ListDefaultConfigurations.go.html to see an example of how to use ListDefaultConfigurations API. A default retry strategy applies to this operation ListDefaultConfigurations()

func (PostgresqlClient) ListShapes

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/latest/psql/ListShapes.go.html to see an example of how to use ListShapes API. A default retry strategy applies to this operation ListShapes()

func (PostgresqlClient) ListWorkRequestErrors

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/latest/psql/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (PostgresqlClient) ListWorkRequestLogs

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/latest/psql/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (PostgresqlClient) ListWorkRequests

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/latest/psql/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (PostgresqlClient) PatchDbSystem

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/latest/psql/PatchDbSystem.go.html to see an example of how to use PatchDbSystem API. A default retry strategy applies to this operation PatchDbSystem()

func (PostgresqlClient) ResetMasterUserPassword

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/latest/psql/ResetMasterUserPassword.go.html to see an example of how to use ResetMasterUserPassword API. A default retry strategy applies to this operation ResetMasterUserPassword()

func (PostgresqlClient) RestartDbInstanceInDbSystem

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/latest/psql/RestartDbInstanceInDbSystem.go.html to see an example of how to use RestartDbInstanceInDbSystem API. A default retry strategy applies to this operation RestartDbInstanceInDbSystem()

func (PostgresqlClient) RestoreDbSystem

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/latest/psql/RestoreDbSystem.go.html to see an example of how to use RestoreDbSystem API. A default retry strategy applies to this operation RestoreDbSystem()

func (*PostgresqlClient) SetRegion

func (client *PostgresqlClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (PostgresqlClient) UpdateBackup

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/latest/psql/UpdateBackup.go.html to see an example of how to use UpdateBackup API. A default retry strategy applies to this operation UpdateBackup()

func (PostgresqlClient) UpdateConfiguration

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/latest/psql/UpdateConfiguration.go.html to see an example of how to use UpdateConfiguration API. A default retry strategy applies to this operation UpdateConfiguration()

func (PostgresqlClient) UpdateDbSystem

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/latest/psql/UpdateDbSystem.go.html to see an example of how to use UpdateDbSystem API. A default retry strategy applies to this operation UpdateDbSystem()

func (PostgresqlClient) UpdateDbSystemDbInstance

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/latest/psql/UpdateDbSystemDbInstance.go.html to see an example of how to use UpdateDbSystemDbInstance API. A default retry strategy applies to this operation UpdateDbSystemDbInstance()

type PrimaryDbInstanceDetails

type PrimaryDbInstanceDetails struct {

	// A unique identifier for the primary database instance node.
	DbInstanceId *string `mandatory:"true" json:"dbInstanceId"`
}

PrimaryDbInstanceDetails The primary database instance node details.

func (PrimaryDbInstanceDetails) String

func (m PrimaryDbInstanceDetails) String() string

func (PrimaryDbInstanceDetails) ValidateEnumValue

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

type ResetMasterUserPasswordDetails

type ResetMasterUserPasswordDetails struct {
	PasswordDetails PasswordDetails `mandatory:"true" json:"passwordDetails"`
}

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}.

func (ResetMasterUserPasswordDetails) String

func (*ResetMasterUserPasswordDetails) UnmarshalJSON

func (m *ResetMasterUserPasswordDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ResetMasterUserPasswordDetails) ValidateEnumValue

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

type 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
}

ResetMasterUserPasswordRequest wrapper for the ResetMasterUserPassword operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/ResetMasterUserPassword.go.html to see an example of how to use ResetMasterUserPasswordRequest.

func (ResetMasterUserPasswordRequest) BinaryRequestBody

func (request ResetMasterUserPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ResetMasterUserPasswordRequest) HTTPRequest

func (request ResetMasterUserPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ResetMasterUserPasswordRequest) RetryPolicy

func (request ResetMasterUserPasswordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ResetMasterUserPasswordRequest) String

func (request ResetMasterUserPasswordRequest) String() string

func (ResetMasterUserPasswordRequest) ValidateEnumValue

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

type ResetMasterUserPasswordResponse

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"`
}

ResetMasterUserPasswordResponse wrapper for the ResetMasterUserPassword operation

func (ResetMasterUserPasswordResponse) HTTPResponse

func (response ResetMasterUserPasswordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ResetMasterUserPasswordResponse) String

func (response ResetMasterUserPasswordResponse) String() string

type RestartDbInstanceInDbSystemDetails

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"`
}

RestartDbInstanceInDbSystemDetails Database instance node restart parameters.

func (RestartDbInstanceInDbSystemDetails) String

func (RestartDbInstanceInDbSystemDetails) ValidateEnumValue

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

type RestartDbInstanceInDbSystemDetailsRestartTypeEnum

type RestartDbInstanceInDbSystemDetailsRestartTypeEnum string

RestartDbInstanceInDbSystemDetailsRestartTypeEnum Enum with underlying type: string

const (
	RestartDbInstanceInDbSystemDetailsRestartTypeNormal     RestartDbInstanceInDbSystemDetailsRestartTypeEnum = "NORMAL"
	RestartDbInstanceInDbSystemDetailsRestartTypeNodeReboot RestartDbInstanceInDbSystemDetailsRestartTypeEnum = "NODE_REBOOT"
)

Set of constants representing the allowable values for RestartDbInstanceInDbSystemDetailsRestartTypeEnum

func GetMappingRestartDbInstanceInDbSystemDetailsRestartTypeEnum

func GetMappingRestartDbInstanceInDbSystemDetailsRestartTypeEnum(val string) (RestartDbInstanceInDbSystemDetailsRestartTypeEnum, bool)

GetMappingRestartDbInstanceInDbSystemDetailsRestartTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumValues

func GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumValues() []RestartDbInstanceInDbSystemDetailsRestartTypeEnum

GetRestartDbInstanceInDbSystemDetailsRestartTypeEnumValues Enumerates the set of values for RestartDbInstanceInDbSystemDetailsRestartTypeEnum

type 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
}

RestartDbInstanceInDbSystemRequest wrapper for the RestartDbInstanceInDbSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/RestartDbInstanceInDbSystem.go.html to see an example of how to use RestartDbInstanceInDbSystemRequest.

func (RestartDbInstanceInDbSystemRequest) BinaryRequestBody

func (request RestartDbInstanceInDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RestartDbInstanceInDbSystemRequest) HTTPRequest

func (request RestartDbInstanceInDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestartDbInstanceInDbSystemRequest) RetryPolicy

func (request RestartDbInstanceInDbSystemRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestartDbInstanceInDbSystemRequest) String

func (request RestartDbInstanceInDbSystemRequest) String() string

func (RestartDbInstanceInDbSystemRequest) ValidateEnumValue

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

type RestartDbInstanceInDbSystemResponse

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"`
}

RestartDbInstanceInDbSystemResponse wrapper for the RestartDbInstanceInDbSystem operation

func (RestartDbInstanceInDbSystemResponse) HTTPResponse

func (response RestartDbInstanceInDbSystemResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestartDbInstanceInDbSystemResponse) String

func (response RestartDbInstanceInDbSystemResponse) String() string

type RestoreDbSystemDetails

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"`
}

RestoreDbSystemDetails Backup details to restore the database system.

func (RestoreDbSystemDetails) String

func (m RestoreDbSystemDetails) String() string

func (RestoreDbSystemDetails) ValidateEnumValue

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

type 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
}

RestoreDbSystemRequest wrapper for the RestoreDbSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/RestoreDbSystem.go.html to see an example of how to use RestoreDbSystemRequest.

func (RestoreDbSystemRequest) BinaryRequestBody

func (request RestoreDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RestoreDbSystemRequest) HTTPRequest

func (request RestoreDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreDbSystemRequest) RetryPolicy

func (request RestoreDbSystemRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestoreDbSystemRequest) String

func (request RestoreDbSystemRequest) String() string

func (RestoreDbSystemRequest) ValidateEnumValue

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

type RestoreDbSystemResponse

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"`
}

RestoreDbSystemResponse wrapper for the RestoreDbSystem operation

func (RestoreDbSystemResponse) HTTPResponse

func (response RestoreDbSystemResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestoreDbSystemResponse) String

func (response RestoreDbSystemResponse) String() string

type ShapeCollection

type ShapeCollection struct {

	// List of supported shapes.
	Items []ShapeSummary `mandatory:"true" json:"items"`
}

ShapeCollection The list of shapes that can be used to create a database system.

func (ShapeCollection) String

func (m ShapeCollection) String() string

func (ShapeCollection) ValidateEnumValue

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

type ShapeMemoryOptions added in v65.71.0

type ShapeMemoryOptions struct {

	// Default per OCPU configuration in GBs
	DefaultPerOcpuInGBs *int `mandatory:"true" json:"defaultPerOcpuInGBs"`

	// Minimum Memory configuration in GBs
	MinInGBs *int `mandatory:"true" json:"minInGBs"`

	// Minimum Memory configuration per OCPU in GBs
	MinPerOcpuInGBs *int `mandatory:"true" json:"minPerOcpuInGBs"`

	// Maximum Memory configuration in GBs
	MaxInGBs *int `mandatory:"true" json:"maxInGBs"`

	// Maximum Memory configuration per OCPU in GBs
	MaxPerOcpuInGBs *int `mandatory:"true" json:"maxPerOcpuInGBs"`
}

ShapeMemoryOptions Options for the the shape memory

func (ShapeMemoryOptions) String added in v65.71.0

func (m ShapeMemoryOptions) String() string

func (ShapeMemoryOptions) ValidateEnumValue added in v65.71.0

func (m ShapeMemoryOptions) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ShapeOcpuOptions added in v65.71.0

type ShapeOcpuOptions struct {

	// Minimum OCPU configuration
	Min *int `mandatory:"true" json:"min"`

	// Maximum OCPU configuration
	Max *int `mandatory:"true" json:"max"`
}

ShapeOcpuOptions Options for the the shape OCPU

func (ShapeOcpuOptions) String added in v65.71.0

func (m ShapeOcpuOptions) String() string

func (ShapeOcpuOptions) ValidateEnumValue added in v65.71.0

func (m ShapeOcpuOptions) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ShapeSummary

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"`

	// Indicates if the shape is a flex shape.
	IsFlexible *bool `mandatory:"false" json:"isFlexible"`

	ShapeOcpuOptions *ShapeOcpuOptions `mandatory:"false" json:"shapeOcpuOptions"`

	ShapeMemoryOptions *ShapeMemoryOptions `mandatory:"false" json:"shapeMemoryOptions"`
}

ShapeSummary Summary of the database system shape.

func (ShapeSummary) String

func (m ShapeSummary) String() string

func (ShapeSummary) ValidateEnumValue

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

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type SourceDetails

type SourceDetails interface {
}

SourceDetails The source used to restore the database system.

type SourceDetailsSourceTypeEnum

type SourceDetailsSourceTypeEnum string

SourceDetailsSourceTypeEnum Enum with underlying type: string

const (
	SourceDetailsSourceTypeBackup SourceDetailsSourceTypeEnum = "BACKUP"
	SourceDetailsSourceTypeNone   SourceDetailsSourceTypeEnum = "NONE"
)

Set of constants representing the allowable values for SourceDetailsSourceTypeEnum

func GetMappingSourceDetailsSourceTypeEnum

func GetMappingSourceDetailsSourceTypeEnum(val string) (SourceDetailsSourceTypeEnum, bool)

GetMappingSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSourceDetailsSourceTypeEnumValues

func GetSourceDetailsSourceTypeEnumValues() []SourceDetailsSourceTypeEnum

GetSourceDetailsSourceTypeEnumValues Enumerates the set of values for SourceDetailsSourceTypeEnum

type StorageDetails

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
}

StorageDetails Storage details of the database system.

type UpdateBackupDetails

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"`
}

UpdateBackupDetails The backup information to be updated.

func (UpdateBackupDetails) String

func (m UpdateBackupDetails) String() string

func (UpdateBackupDetails) ValidateEnumValue

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

type 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
}

UpdateBackupRequest wrapper for the UpdateBackup operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/UpdateBackup.go.html to see an example of how to use UpdateBackupRequest.

func (UpdateBackupRequest) BinaryRequestBody

func (request UpdateBackupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateBackupRequest) HTTPRequest

func (request UpdateBackupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBackupRequest) RetryPolicy

func (request UpdateBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBackupRequest) String

func (request UpdateBackupRequest) String() string

func (UpdateBackupRequest) ValidateEnumValue

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

type UpdateBackupResponse

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"`
}

UpdateBackupResponse wrapper for the UpdateBackup operation

func (UpdateBackupResponse) HTTPResponse

func (response UpdateBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBackupResponse) String

func (response UpdateBackupResponse) String() string

type UpdateConfigurationDetails

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"`
}

UpdateConfigurationDetails The information to update a configuration.

func (UpdateConfigurationDetails) String

func (UpdateConfigurationDetails) ValidateEnumValue

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

type 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
}

UpdateConfigurationRequest wrapper for the UpdateConfiguration operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/UpdateConfiguration.go.html to see an example of how to use UpdateConfigurationRequest.

func (UpdateConfigurationRequest) BinaryRequestBody

func (request UpdateConfigurationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateConfigurationRequest) HTTPRequest

func (request UpdateConfigurationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateConfigurationRequest) RetryPolicy

func (request UpdateConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateConfigurationRequest) String

func (request UpdateConfigurationRequest) String() string

func (UpdateConfigurationRequest) ValidateEnumValue

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

type UpdateConfigurationResponse

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"`
}

UpdateConfigurationResponse wrapper for the UpdateConfiguration operation

func (UpdateConfigurationResponse) HTTPResponse

func (response UpdateConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateConfigurationResponse) String

func (response UpdateConfigurationResponse) String() string

type UpdateDbConfigParams

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"`
}

UpdateDbConfigParams Configuration for the PostgreSQL database instance.

func (UpdateDbConfigParams) String

func (m UpdateDbConfigParams) String() string

func (UpdateDbConfigParams) ValidateEnumValue

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

type UpdateDbConfigParamsApplyConfigEnum

type UpdateDbConfigParamsApplyConfigEnum string

UpdateDbConfigParamsApplyConfigEnum Enum with underlying type: string

const (
	UpdateDbConfigParamsApplyConfigRestart UpdateDbConfigParamsApplyConfigEnum = "RESTART"
	UpdateDbConfigParamsApplyConfigReload  UpdateDbConfigParamsApplyConfigEnum = "RELOAD"
)

Set of constants representing the allowable values for UpdateDbConfigParamsApplyConfigEnum

func GetMappingUpdateDbConfigParamsApplyConfigEnum

func GetMappingUpdateDbConfigParamsApplyConfigEnum(val string) (UpdateDbConfigParamsApplyConfigEnum, bool)

GetMappingUpdateDbConfigParamsApplyConfigEnum performs case Insensitive comparison on enum value and return the desired enum

func GetUpdateDbConfigParamsApplyConfigEnumValues

func GetUpdateDbConfigParamsApplyConfigEnumValues() []UpdateDbConfigParamsApplyConfigEnum

GetUpdateDbConfigParamsApplyConfigEnumValues Enumerates the set of values for UpdateDbConfigParamsApplyConfigEnum

type UpdateDbSystemDbInstanceDetails

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"`
}

UpdateDbSystemDbInstanceDetails Database instance node update parameters.

func (UpdateDbSystemDbInstanceDetails) String

func (UpdateDbSystemDbInstanceDetails) ValidateEnumValue

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

type 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
}

UpdateDbSystemDbInstanceRequest wrapper for the UpdateDbSystemDbInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/UpdateDbSystemDbInstance.go.html to see an example of how to use UpdateDbSystemDbInstanceRequest.

func (UpdateDbSystemDbInstanceRequest) BinaryRequestBody

func (request UpdateDbSystemDbInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDbSystemDbInstanceRequest) HTTPRequest

func (request UpdateDbSystemDbInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDbSystemDbInstanceRequest) RetryPolicy

func (request UpdateDbSystemDbInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDbSystemDbInstanceRequest) String

func (request UpdateDbSystemDbInstanceRequest) String() string

func (UpdateDbSystemDbInstanceRequest) ValidateEnumValue

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

type UpdateDbSystemDbInstanceResponse

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"`
}

UpdateDbSystemDbInstanceResponse wrapper for the UpdateDbSystemDbInstance operation

func (UpdateDbSystemDbInstanceResponse) HTTPResponse

func (response UpdateDbSystemDbInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDbSystemDbInstanceResponse) String

func (response UpdateDbSystemDbInstanceResponse) String() string

type UpdateDbSystemDetails

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"`

	// The name of the shape for the database system nodes.
	// Example: `VM.Standard.E4.Flex`
	Shape *string `mandatory:"false" json:"shape"`

	// The total number of OCPUs available to each database system node.
	InstanceOcpuCount *int `mandatory:"false" json:"instanceOcpuCount"`

	// The total amount of memory available to each database system node, in gigabytes.
	InstanceMemorySizeInGBs *int `mandatory:"false" json:"instanceMemorySizeInGBs"`

	DbConfigurationParams *UpdateDbConfigParams `mandatory:"false" json:"dbConfigurationParams"`

	ManagementPolicy *ManagementPolicyDetails `mandatory:"false" json:"managementPolicy"`

	StorageDetails *UpdateStorageDetailsParams `mandatory:"false" json:"storageDetails"`

	NetworkDetails *UpdateNetworkDetails `mandatory:"false" json:"networkDetails"`

	// 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"`
}

UpdateDbSystemDetails The information to be updated.

func (UpdateDbSystemDetails) String

func (m UpdateDbSystemDetails) String() string

func (UpdateDbSystemDetails) ValidateEnumValue

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

type 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
}

UpdateDbSystemRequest wrapper for the UpdateDbSystem operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/psql/UpdateDbSystem.go.html to see an example of how to use UpdateDbSystemRequest.

func (UpdateDbSystemRequest) BinaryRequestBody

func (request UpdateDbSystemRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDbSystemRequest) HTTPRequest

func (request UpdateDbSystemRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDbSystemRequest) RetryPolicy

func (request UpdateDbSystemRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDbSystemRequest) String

func (request UpdateDbSystemRequest) String() string

func (UpdateDbSystemRequest) ValidateEnumValue

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

type UpdateDbSystemResponse

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"`
}

UpdateDbSystemResponse wrapper for the UpdateDbSystem operation

func (UpdateDbSystemResponse) HTTPResponse

func (response UpdateDbSystemResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDbSystemResponse) String

func (response UpdateDbSystemResponse) String() string

type UpdateNetworkDetails added in v65.71.0

type UpdateNetworkDetails struct {

	// List of 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"`
}

UpdateNetworkDetails Network details for the database system.

func (UpdateNetworkDetails) String added in v65.71.0

func (m UpdateNetworkDetails) String() string

func (UpdateNetworkDetails) ValidateEnumValue added in v65.71.0

func (m UpdateNetworkDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateStorageDetailsParams

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"`
}

UpdateStorageDetailsParams Storage details of the database system.

func (UpdateStorageDetailsParams) String

func (UpdateStorageDetailsParams) ValidateEnumValue

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

type VaultSecretPasswordDetails

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"`
}

VaultSecretPasswordDetails Secret details for the database system password.

func (VaultSecretPasswordDetails) MarshalJSON

func (m VaultSecretPasswordDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (VaultSecretPasswordDetails) String

func (VaultSecretPasswordDetails) ValidateEnumValue

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

type WeeklyBackupPolicy

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"`
}

WeeklyBackupPolicy Weekly backup policy.

func (WeeklyBackupPolicy) GetRetentionDays

func (m WeeklyBackupPolicy) GetRetentionDays() *int

GetRetentionDays returns RetentionDays

func (WeeklyBackupPolicy) MarshalJSON

func (m WeeklyBackupPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (WeeklyBackupPolicy) String

func (m WeeklyBackupPolicy) String() string

func (WeeklyBackupPolicy) ValidateEnumValue

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

type WeeklyBackupPolicyDaysOfTheWeekEnum

type WeeklyBackupPolicyDaysOfTheWeekEnum string

WeeklyBackupPolicyDaysOfTheWeekEnum Enum with underlying type: string

const (
	WeeklyBackupPolicyDaysOfTheWeekSunday    WeeklyBackupPolicyDaysOfTheWeekEnum = "SUNDAY"
	WeeklyBackupPolicyDaysOfTheWeekMonday    WeeklyBackupPolicyDaysOfTheWeekEnum = "MONDAY"
	WeeklyBackupPolicyDaysOfTheWeekTuesday   WeeklyBackupPolicyDaysOfTheWeekEnum = "TUESDAY"
	WeeklyBackupPolicyDaysOfTheWeekWednesday WeeklyBackupPolicyDaysOfTheWeekEnum = "WEDNESDAY"
	WeeklyBackupPolicyDaysOfTheWeekThursday  WeeklyBackupPolicyDaysOfTheWeekEnum = "THURSDAY"
	WeeklyBackupPolicyDaysOfTheWeekFriday    WeeklyBackupPolicyDaysOfTheWeekEnum = "FRIDAY"
	WeeklyBackupPolicyDaysOfTheWeekSaturday  WeeklyBackupPolicyDaysOfTheWeekEnum = "SATURDAY"
)

Set of constants representing the allowable values for WeeklyBackupPolicyDaysOfTheWeekEnum

func GetMappingWeeklyBackupPolicyDaysOfTheWeekEnum

func GetMappingWeeklyBackupPolicyDaysOfTheWeekEnum(val string) (WeeklyBackupPolicyDaysOfTheWeekEnum, bool)

GetMappingWeeklyBackupPolicyDaysOfTheWeekEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWeeklyBackupPolicyDaysOfTheWeekEnumValues

func GetWeeklyBackupPolicyDaysOfTheWeekEnumValues() []WeeklyBackupPolicyDaysOfTheWeekEnum

GetWeeklyBackupPolicyDaysOfTheWeekEnumValues Enumerates the set of values for WeeklyBackupPolicyDaysOfTheWeekEnum

type WorkRequest

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"`
}

WorkRequest An asynchronous work request.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

type WorkRequestError

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"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

	// List of work request errors.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

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

type WorkRequestLogEntry

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"`
}

WorkRequestLogEntry A log message from the execution of a work request.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

	// List of work request log entries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

type WorkRequestResource

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"`
}

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

type WorkRequestResourceMetadataKeyEnum

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary

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"`
}

WorkRequestSummary A summary of the status of a work request.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

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

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

	// List of work requests.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

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

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL