Namespace Oci.PsqlService.Models
Classes
Backup
Database system backup information.
BackupCollection
Results of a backup search. Contains the BackupSummary items and other information, such as metadata.
BackupPolicy
PostgreSQL database system backup policy.
BackupPolicyModelConverter
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.
BackupSummary
Summary information for a backup.
ChangeBackupCompartmentDetails
The information used to move a backup to a different compartment.
ChangeConfigurationCompartmentDetails
The information to move a configuration to a different compartment.
ChangeDbSystemCompartmentDetails
Change database system compartment operation details.
ConfigOverrides
Configuration overrides for a PostgreSQL instance.
ConfigParams
Database configuration.
Configuration
PostgreSQL configuration for a database system.
ConfigurationCollection
Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata.
ConfigurationDetails
List of configuration details.
ConfigurationSummary
Summary of the configuration.
ConnectionDetails
Database system connection information. Used to connect to PostgreSQL instance(s).
CreateBackupDetails
The information to create a new backup.
CreateConfigurationDetails
The information to create a new configuration.
CreateDbInstanceDetails
Information about the new database instance node.
CreateDbSystemDetails
The information about new database system.
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}.
DailyBackupPolicy
Daily backup policy.
DbConfigurationOverrideCollection
Configuration overrides for a PostgreSQL instance.
DbInstance
Information about a database instance node.
DbInstanceEndpoint
The database instance node endpoint information.
DbSystem
Information about a database system.
DbSystemCollection
Results of a database system search. Contains both DbSystemSummary items and other information, such as metadata.
DbSystemDetails
Information about the database system associated with a backup.
DbSystemSummary
Summary information about a database system.
DefaultConfigParams
Default database configuration.
DefaultConfiguration
Default configurations for PostgreSQL database systems.
DefaultConfigurationCollection
Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata.
DefaultConfigurationDetails
List of default configuration values for databases.
DefaultConfigurationSummary
Summary of the configuration.
Endpoint
Information about the database instance node endpoint.
FailoverDbSystemDetails
Database system failover information.
ManagementPolicy
PostgreSQL database system management policy.
ManagementPolicyDetails
PostgreSQL database system management policy update details.
MonthlyBackupPolicy
Monthly backup policy.
NetworkDetails
Network details for the database system.
NoneBackupPolicy
No backup policy.
NoneSourceDetails
This is used to create new database system or update without restoring from backup.
OciOptimizedStorageDetails
Storage details of the database system.
PasswordDetails
Details for the database system password.
Password can be passed as VaultSecretPasswordDetails
or PlainTextPasswordDetails
.
PasswordDetailsModelConverter
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.
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.
PatchInstruction
A single instruction to be included as part of Patch request content.
PatchInstructionModelConverter
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 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.
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.
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.
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.
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.
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.
PlainTextPasswordDetails
Details for in-line database system password.
PrimaryDbInstanceDetails
The primary database instance node details.
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}.
RestartDbInstanceInDbSystemDetails
Database instance node restart parameters.
RestoreDbSystemDetails
Backup details to restore the database system.
ShapeCollection
The list of shapes that can be used to create a database system.
ShapeMemoryOptions
Options for the the shape memory
ShapeOcpuOptions
Options for the the shape OCPU
ShapeSummary
Summary of the database system shape.
SourceDetails
The source used to restore the database system.
SourceDetailsModelConverter
StorageDetails
Storage details of the database system.
StorageDetailsModelConverter
UpdateBackupDetails
The backup information to be updated.
UpdateConfigurationDetails
The information to update a configuration.
UpdateDbConfigParams
Configuration for the PostgreSQL database instance.
UpdateDbSystemDbInstanceDetails
Database instance node update parameters.
UpdateDbSystemDetails
The information to be updated.
UpdateNetworkDetails
Network details for the database system.
UpdateStorageDetailsParams
Storage details of the database system.
VaultSecretPasswordDetails
Secret details for the database system password.
WeeklyBackupPolicy
Weekly backup policy.
WorkRequest
An asynchronous work request.
WorkRequestError
An error encountered while executing a work request.
WorkRequestErrorCollection
Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
WorkRequestLogEntry
A log message from the execution of a work request.
WorkRequestLogEntryCollection
Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
WorkRequestResource
A resource created or operated on by a work request.
WorkRequestSummary
A summary of the status of a work request.
WorkRequestSummaryCollection
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
Enums
ActionType
Possible types of actions.
Backup.LifecycleStateEnum
Backup.SourceTypeEnum
BackupPolicy.KindEnum
Configuration.ConfigTypeEnum
Configuration.LifecycleStateEnum
DbInstance.LifecycleStateEnum
DbSystem.LifecycleStateEnum
DbSystem.SystemTypeEnum
DefaultConfiguration.LifecycleStateEnum
OperationStatus
Possible operation status.
OperationType
Possible operation types.
PasswordDetails.PasswordTypeEnum
PatchInsertInstruction.PositionEnum
PatchInstruction.OperationEnum
PatchMoveInstruction.PositionEnum
RestartDbInstanceInDbSystemDetails.RestartTypeEnum
SortOrder
Sort orders.
SourceDetails.SourceTypeEnum
UpdateDbConfigParams.ApplyConfigEnum
WeeklyBackupPolicy.DaysOfTheWeekEnum
WorkRequestResourceMetadataKey
Possible metadata keys for workRequest resource metadata.