/** * Database Service API * The API for the Database Service. Use this API to manage resources such as databases and DB Systems. For more information, see [Overview of the Database Service](https://docs.oracle.com/iaas/Content/Database/Concepts/databaseoverview.htm). * OpenAPI spec version: 20160918 * Contact: sic_dbaas_cp_us_grp@oracle.com * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ /** * The properties that define a Data Guard association. *
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an * administrator. If you're an administrator who needs to write policies to give users access, see * [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). *
For information about endpoints and signing API requests, see * [About the API](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see * [SDKS and Other Tools](https://docs.oracle.com/iaas/Content/API/Concepts/sdks.htm). * */ export interface DataGuardAssociationSummary { /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Data Guard association. */ "id": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the reporting database. */ "databaseId": string; /** * The role of the reporting database in this Data Guard association. */ "role": DataGuardAssociationSummary.Role; /** * The current state of the Data Guard association. */ "lifecycleState": DataGuardAssociationSummary.LifecycleState; /** * Additional information about the current lifecycleState, if available. * */ "lifecycleDetails"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system containing the associated * peer database. * */ "peerDbSystemId": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home containing the associated peer database. * */ "peerDbHomeId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated peer database. */ "peerDatabaseId"?: string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the peer database's Data Guard association. */ "peerDataGuardAssociationId"?: string; /** * The role of the peer database in this Data Guard association. */ "peerRole": DataGuardAssociationSummary.PeerRole; /** * The lag time between updates to the primary database and application of the redo data on the standby database, * as computed by the reporting database. *
Example: {@code 9 seconds} * */ "applyLag"?: string; /** * The rate at which redo logs are synced between the associated databases. *
Example: {@code 180 Mb per second} * */ "applyRate"?: string; /** * The protection mode of this Data Guard association. For more information, see * [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) * in the Oracle Data Guard documentation. * */ "protectionMode": DataGuardAssociationSummary.ProtectionMode; /** * The redo transport type used by this Data Guard association. For more information, see * [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) * in the Oracle Data Guard documentation. * */ "transportType"?: DataGuardAssociationSummary.TransportType; /** * The date and time the Data Guard association was created. */ "timeCreated"?: Date; /** * True if active Data Guard is enabled. */ "isActiveDataGuardEnabled"?: boolean; } export declare namespace DataGuardAssociationSummary { enum Role { Primary = "PRIMARY", Standby = "STANDBY", DisabledStandby = "DISABLED_STANDBY", SnapshotStandby = "SNAPSHOT_STANDBY", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum LifecycleState { Provisioning = "PROVISIONING", Available = "AVAILABLE", Updating = "UPDATING", Terminating = "TERMINATING", Terminated = "TERMINATED", Failed = "FAILED", Upgrading = "UPGRADING", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum PeerRole { Primary = "PRIMARY", Standby = "STANDBY", DisabledStandby = "DISABLED_STANDBY", SnapshotStandby = "SNAPSHOT_STANDBY", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum ProtectionMode { MaximumAvailability = "MAXIMUM_AVAILABILITY", MaximumPerformance = "MAXIMUM_PERFORMANCE", MaximumProtection = "MAXIMUM_PROTECTION", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum TransportType { Sync = "SYNC", Async = "ASYNC", Fastsync = "FASTSYNC", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: DataGuardAssociationSummary): object; function getDeserializedJsonObj(obj: DataGuardAssociationSummary): object; }