Show / Hide Table of Contents

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.

BackupCopyDetails

Backup Copy details

BackupCopyPolicy

Backup copy details

BackupCopyStatusDetails

Backup Copy Status details

BackupPolicy

PostgreSQL database system backup policy.

BackupPolicyModelConverter

BackupSourceDetails

Details of the database system backup.

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.

ChangeRoleToReplicaDetails

The information required to change a primary database system's role to replica.

ChangeRoleToStandaloneDetails

The information required to change a replica database system's role to standalone.

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.

CreateReplicationConfigDetails

Details of the replication configuration that is applicable when database system gets the PRIMARY_DB_SYSTEM role.
This configuration does not have any effect on database systems with other roles.

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.

DateTimeRangeCapability

Indicates whether a time range is required for the insight.

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.

DbSystemReplicaCollection

Results of replica database system search.

DbSystemReplicaSummary

Summary information about a replica database system.

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.

DisabledInsightDetails

Disable Insight for the database system.

DisabledKerberosAuthDetails

Disable Kerberos Authentication for the database system.

EnabledInsightDetails

Enable or Update Existing Insights for the database system.

EnabledKerberosAuthDetails

Enable or Update Existing Kerberos Authentication for the database system.

Endpoint

Information about the database instance node endpoint.

FailoverDbSystemDetails

Database system failover information.

GranularityCapability

Describes time granularity behavior for time-series Insight.

InsightCapabilityCollection

PostgreSQL insight capabilities collection.

InsightCapabilitySummary

Describes supported insight types and their capabilities.

InsightDataContract

Describes the response data format returned for an insight type.

InsightDataTypeCapability

Capability metadata for a specific insight data type.

InsightFilterCapability

Describes a supported filter for an insight type.

InsightLimits

Defines limits applicable to an insight type.

KerberosAuthDetails

Kerberos Authentication details for the database system.

KerberosAuthDetailsModelConverter

KerberosCredential

Kerberos Credential details as OCI Vault Secret for the keytab.

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.

OdspInsight

Details for a single ODSP insight.

OdspInsightDetails

ODSP Insight details for the database system.

OdspInsightDetailsModelConverter

PaginationCapability

Describes pagination support for an insight type.

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.

PrimaryDbSystemSourceDetails

Details of the primary database system.

ReplicationConfig

Replication configuration that is applicable on database systems with the PRIMARY_DB_SYSTEM role.
This configuration does not have any effect on database systems with other roles.

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.

SortingCapability

Describes sorting support for an insight type.

SortingDefault

Default sorting behavior for an insight type.

SourceBackupDetails

Information about the Source Backup associated with a backup.

SourceDetails

The source of the database system.

SourceDetailsModelConverter

StartDbSystemDetails

DB System start parameters to update ocpu, memory, shape and configuration.

StorageDetails

Storage details of the database system.

StorageDetailsModelConverter

SwitchOverDetails

The information required to swap role between the primary and an existing replica database system.

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.

UpdateReplicationConfigDetails

Details of the replication configuration that is applicable when database system gets the PRIMARY_DB_SYSTEM role.
This configuration does not have any effect on database systems with other roles.

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

BackupCopyStatusDetails.StateEnum

BackupPolicy.KindEnum

ChangeRoleToStandaloneDetails.ChangeModeEnum

Configuration.ConfigTypeEnum

Configuration.LifecycleStateEnum

DbInstance.LifecycleStateEnum

DbSystem.LifecycleStateEnum

DbSystem.SystemRoleEnum

DbSystem.SystemTypeEnum

DefaultConfiguration.LifecycleStateEnum

GranularityCapability.TypeEnum

InsightCapabilitySummary.InsightTypeEnum

InsightDataContract.KindEnum

InsightDataTypeCapability.InsightDataTypeEnum

KerberosAuthDetails.KindEnum

OdspInsight.InsightTypeEnum

OdspInsightDetails.KindEnum

OperationStatus

Possible operation status.

OperationType

Possible operation types.

PasswordDetails.PasswordTypeEnum

PatchInsertInstruction.PositionEnum

PatchInstruction.OperationEnum

PatchMoveInstruction.PositionEnum

RestartDbInstanceInDbSystemDetails.RestartTypeEnum

SortOrder

Sort orders.

SortingDefault.OrderEnum

SourceDetails.SourceTypeEnum

UpdateDbConfigParams.ApplyConfigEnum

WeeklyBackupPolicy.DaysOfTheWeekEnum

WorkRequestResourceMetadataKey

Possible metadata keys for workRequest resource metadata.

In this article
Back to top