Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DatabaseClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DatabaseClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DatabaseClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DatabaseClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: DatabaseWaiter

targetService

targetService: string = "Database"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://database.{region}.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

activateExadataInfrastructure

addStorageCapacityCloudExadataInfrastructure

  • Makes the storage capacity from additional storage servers available for Cloud VM Cluster consumption. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddStorageCapacityCloudExadataInfrastructure API.

    Parameters

    Returns Promise<AddStorageCapacityCloudExadataInfrastructureResponse>

    AddStorageCapacityCloudExadataInfrastructureResponse

addStorageCapacityExadataInfrastructure

addVirtualMachineToCloudVmCluster

addVirtualMachineToVmCluster

autonomousDatabaseManualRefresh

  • Initiates a data refresh for an Autonomous Database refreshable clone. Data is refreshed from the source database to the point of a specified timestamp.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AutonomousDatabaseManualRefresh API.

    Parameters

    Returns Promise<AutonomousDatabaseManualRefreshResponse>

    AutonomousDatabaseManualRefreshResponse

cancelBackup

  • Cancel automatic/standalone full/incremental create backup workrequests specified by the backup Id. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelBackup API.

    Parameters

    Returns Promise<CancelBackupResponse>

    CancelBackupResponse

changeAutonomousContainerDatabaseCompartment

changeAutonomousDatabaseCompartment

changeAutonomousDatabaseSoftwareImageCompartment

changeAutonomousExadataInfrastructureCompartment

  • Deprecated. Use the {@link #changeCloudExadataInfrastructureCompartment(ChangeCloudExadataInfrastructureCompartmentRequest) changeCloudExadataInfrastructureCompartment} operation to move an Exadata infrastructure resource to a different compartment and {@link #changeCloudAutonomousVmClusterCompartment(ChangeCloudAutonomousVmClusterCompartmentRequest) changeCloudAutonomousVmClusterCompartment} operation to move an Autonomous Exadata VM cluster to a different compartment. For more information, see Moving Database Resources to a Different Compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAutonomousExadataInfrastructureCompartment API.

    Parameters

    Returns Promise<ChangeAutonomousExadataInfrastructureCompartmentResponse>

    ChangeAutonomousExadataInfrastructureCompartmentResponse

changeAutonomousVmClusterCompartment

  • Moves an Autonomous VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer only. For systems in the Oracle cloud, see {@link #changeAutonomousVmClusterCompartment(ChangeAutonomousVmClusterCompartmentRequest) changeAutonomousVmClusterCompartment}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAutonomousVmClusterCompartment API.

    Parameters

    Returns Promise<ChangeAutonomousVmClusterCompartmentResponse>

    ChangeAutonomousVmClusterCompartmentResponse

changeBackupDestinationCompartment

changeCloudAutonomousVmClusterCompartment

  • Moves an Autonomous Exadata VM cluster in the Oracle cloud and its dependent resources to another compartment. For Exadata Cloud@Customer systems, see {@link #changeAutonomousVmClusterCompartment(ChangeAutonomousVmClusterCompartmentRequest) changeAutonomousVmClusterCompartment}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeCloudAutonomousVmClusterCompartment API.

    Parameters

    Returns Promise<ChangeCloudAutonomousVmClusterCompartmentResponse>

    ChangeCloudAutonomousVmClusterCompartmentResponse

changeCloudExadataInfrastructureCompartment

changeCloudVmClusterCompartment

  • Moves a cloud VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeCloudVmClusterCompartment API.

    Parameters

    Returns Promise<ChangeCloudVmClusterCompartmentResponse>

    ChangeCloudVmClusterCompartmentResponse

changeDatabaseSoftwareImageCompartment

changeDataguardRole

changeDbSystemCompartment

changeDisasterRecoveryConfiguration

  • This operation updates the cross-region disaster recovery (DR) details of the standby Autonomous Database Serverless database, and must be run on the standby side. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeDisasterRecoveryConfiguration API.

    Parameters

    Returns Promise<ChangeDisasterRecoveryConfigurationResponse>

    ChangeDisasterRecoveryConfigurationResponse

changeExadataInfrastructureCompartment

  • Moves an Exadata infrastructure resource and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move an Exadata Cloud Service infrastructure resource to another compartment, use the {@link #changeCloudExadataInfrastructureCompartment(ChangeCloudExadataInfrastructureCompartmentRequest) changeCloudExadataInfrastructureCompartment} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeExadataInfrastructureCompartment API.

    Parameters

    Returns Promise<ChangeExadataInfrastructureCompartmentResponse>

    ChangeExadataInfrastructureCompartmentResponse

changeExternalContainerDatabaseCompartment

changeExternalNonContainerDatabaseCompartment

changeExternalPluggableDatabaseCompartment

changeKeyStoreCompartment

changeKeyStoreType

changeOneoffPatchCompartment

changeVmClusterCompartment

  • Moves a VM cluster and its dependent resources to another compartment. Applies to Exadata Cloud@Customer instances only. To move a cloud VM cluster in an Exadata Cloud Service instance to another compartment, use the {@link #changeCloudVmClusterCompartment(ChangeCloudVmClusterCompartmentRequest) changeCloudVmClusterCompartment} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeVmClusterCompartment API.

    Parameters

    Returns Promise<ChangeVmClusterCompartmentResponse>

    ChangeVmClusterCompartmentResponse

checkExternalDatabaseConnectorConnectionStatus

close

  • close(): void

completeExternalBackupJob

  • Changes the status of the standalone backup resource to ACTIVE after the backup is created from the on-premises database and placed in Oracle Cloud Infrastructure Object Storage.

    *Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](https://docs.cloud.oracle.com/Content/Database/Tasks/mig-onprembackup.htm) for more information.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CompleteExternalBackupJob API.

    Parameters

    Returns Promise<CompleteExternalBackupJobResponse>

    CompleteExternalBackupJobResponse

configureAutonomousDatabaseVaultKey

configureSaasAdminUser

convertToPdb

  • Converts a non-container database to a pluggable database.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ConvertToPdb API.

    Parameters

    Returns Promise<ConvertToPdbResponse>

    ConvertToPdbResponse

convertToRegularPluggableDatabase

createApplicationVip

  • Creates a new application virtual IP (VIP) address in the specified cloud VM cluster based on the request parameters you provide.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateApplicationVip API.

    Parameters

    Returns Promise<CreateApplicationVipResponse>

    CreateApplicationVipResponse

createAutonomousContainerDatabase

createAutonomousContainerDatabaseDataguardAssociation

  • Create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the specified Autonomous Container database and a peer Autonomous Container database. For more information, see Using Oracle Data Guard.

    All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAutonomousContainerDatabaseDataguardAssociation API.

    Parameters

    Returns Promise<CreateAutonomousContainerDatabaseDataguardAssociationResponse>

    CreateAutonomousContainerDatabaseDataguardAssociationResponse

createAutonomousDatabase

createAutonomousDatabaseBackup

createAutonomousDatabaseSoftwareImage

createAutonomousVmCluster

  • Creates an Autonomous VM cluster for Exadata Cloud@Customer. To create an Autonomous VM Cluster in the Oracle cloud, see {@link #createCloudAutonomousVmCluster(CreateCloudAutonomousVmClusterRequest) createCloudAutonomousVmCluster}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAutonomousVmCluster API.

    Parameters

    Returns Promise<CreateAutonomousVmClusterResponse>

    CreateAutonomousVmClusterResponse

createBackup

  • Creates a new backup in the specified database based on the request parameters you provide. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateBackup API.

    Parameters

    Returns Promise<CreateBackupResponse>

    CreateBackupResponse

createBackupDestination

createCloudAutonomousVmCluster

  • Creates an Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see {@link #createAutonomousVmCluster(CreateAutonomousVmClusterRequest) createAutonomousVmCluster}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCloudAutonomousVmCluster API.

    Parameters

    Returns Promise<CreateCloudAutonomousVmClusterResponse>

    CreateCloudAutonomousVmClusterResponse

createCloudExadataInfrastructure

createCloudVmCluster

createConsoleConnection

  • Creates a new console connection to the specified database node. After the console connection has been created and is available, you connect to the console using SSH.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateConsoleConnection API.

    Parameters

    Returns Promise<CreateConsoleConnectionResponse>

    CreateConsoleConnectionResponse

createConsoleHistory

  • Captures the most recent serial console data (up to a megabyte) for the specified database node.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateConsoleHistory API.

    Parameters

    Returns Promise<CreateConsoleHistoryResponse>

    CreateConsoleHistoryResponse

createDataGuardAssociation

  • Creates a new Data Guard association. A Data Guard association represents the replication relationship between the specified database and a peer database. For more information, see Using Oracle Data Guard.

    All Oracle Cloud Infrastructure resources, including Data Guard associations, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDataGuardAssociation API.

    Parameters

    Returns Promise<CreateDataGuardAssociationResponse>

    CreateDataGuardAssociationResponse

createDatabase

  • Creates a new database in the specified Database Home. If the database version is provided, it must match the version of the Database Home. Applies to Exadata and Exadata Cloud@Customer systems.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDatabase API.

    Parameters

    Returns Promise<CreateDatabaseResponse>

    CreateDatabaseResponse

createDatabaseSoftwareImage

createDbHome

  • Creates a new Database Home in the specified database system based on the request parameters you provide. Applies to bare metal DB systems, Exadata systems, and Exadata Cloud@Customer systems.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDbHome API.

    Parameters

    Returns Promise<CreateDbHomeResponse>

    CreateDbHomeResponse

createExadataInfrastructure

  • Creates an Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To create an Exadata Cloud Service infrastructure resource, use the {@link #createCloudExadataInfrastructure(CreateCloudExadataInfrastructureRequest) createCloudExadataInfrastructure} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateExadataInfrastructure API.

    Parameters

    Returns Promise<CreateExadataInfrastructureResponse>

    CreateExadataInfrastructureResponse

createExternalBackupJob

  • Creates a new backup resource and returns the information the caller needs to back up an on-premises Oracle Database to Oracle Cloud Infrastructure.

    *Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](https://docs.cloud.oracle.com/Content/Database/Tasks/mig-onprembackup.htm) for more information.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateExternalBackupJob API.

    Parameters

    Returns Promise<CreateExternalBackupJobResponse>

    CreateExternalBackupJobResponse

createExternalContainerDatabase

createExternalDatabaseConnector

createExternalNonContainerDatabase

createExternalPluggableDatabase

  • Registers a new {@link #createExternalPluggableDatabaseDetails(CreateExternalPluggableDatabaseDetailsRequest) createExternalPluggableDatabaseDetails} resource.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateExternalPluggableDatabase API.

    Parameters

    Returns Promise<CreateExternalPluggableDatabaseResponse>

    CreateExternalPluggableDatabaseResponse

createKeyStore

createMaintenanceRun

  • Creates a maintenance run with one of the following:

    1. The latest available release update patch (RUP) for the Autonomous Container Database.
    2. The latest available RUP and DST time-zone (TZ) file updates for the Autonomous Container Database.
    3. The DST TZ file updates for the Autonomous Container Database.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateMaintenanceRun API.

    Parameters

    Returns Promise<CreateMaintenanceRunResponse>

    CreateMaintenanceRunResponse

createOneoffPatch

  • Creates one-off patch for specified database version to download.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateOneoffPatch API.

    Parameters

    Returns Promise<CreateOneoffPatchResponse>

    CreateOneoffPatchResponse

createPluggableDatabase

  • Creates and starts a pluggable database in the specified container database. Pluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API. Use the {@link #startPluggableDatabase(StartPluggableDatabaseRequest) startPluggableDatabase} and {@link #stopPluggableDatabase(StopPluggableDatabaseRequest) stopPluggableDatabase} APIs to start and stop the pluggable database.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreatePluggableDatabase API.

    Parameters

    Returns Promise<CreatePluggableDatabaseResponse>

    CreatePluggableDatabaseResponse

createVmCluster

createVmClusterNetwork

  • Creates the VM cluster network. Applies to Exadata Cloud@Customer instances only. To create a cloud VM cluster in an Exadata Cloud Service instance, use the {@link #createCloudVmCluster(CreateCloudVmClusterRequest) createCloudVmCluster} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateVmClusterNetwork API.

    Parameters

    Returns Promise<CreateVmClusterNetworkResponse>

    CreateVmClusterNetworkResponse

createWaiters

  • Creates a new DatabaseWaiter for resources for this service.

    Parameters

    • workRequestClient: WorkRequestClient

      The work request service client used to query for work request status

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DatabaseWaiter

    The service waiters.

dbNodeAction

  • Performs one of the following power actions on the specified DB node:

    • start - power on
    • stop - power off
    • softreset - ACPI shutdown and power on
    • reset - power off and power on

    *Note:** Stopping a node affects billing differently, depending on the type of DB system: Bare metal and Exadata systems - The stop state has no effect on the resources you consume. Billing continues for DB nodes that you stop, and related resources continue to apply against any relevant quotas. You must terminate the DB system ({@link #terminateDbSystem(TerminateDbSystemRequest) terminateDbSystem}) to remove its resources from billing and quotas. Virtual machine DB systems - Stopping a node stops billing for all OCPUs associated with that node, and billing resumes when you restart the node.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DbNodeAction API.

    Parameters

    Returns Promise<DbNodeActionResponse>

    DbNodeActionResponse

deleteApplicationVip

deleteAutonomousDatabase

deleteAutonomousDatabaseBackup

deleteAutonomousDatabaseSoftwareImage

deleteAutonomousVmCluster

  • Deletes the specified Autonomous VM cluster in an Exadata Cloud@Customer system. To delete an Autonomous VM Cluster in the Oracle cloud, see {@link #deleteCloudAutonomousVmCluster(DeleteCloudAutonomousVmClusterRequest) deleteCloudAutonomousVmCluster}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAutonomousVmCluster API.

    Parameters

    Returns Promise<DeleteAutonomousVmClusterResponse>

    DeleteAutonomousVmClusterResponse

deleteBackup

  • Deletes a full backup. You cannot delete automatic backups using this API. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteBackup API.

    Parameters

    Returns Promise<DeleteBackupResponse>

    DeleteBackupResponse

deleteBackupDestination

deleteCloudAutonomousVmCluster

  • Deletes the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see {@link #deleteAutonomousVmCluster(DeleteAutonomousVmClusterRequest) deleteAutonomousVmCluster}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCloudAutonomousVmCluster API.

    Parameters

    Returns Promise<DeleteCloudAutonomousVmClusterResponse>

    DeleteCloudAutonomousVmClusterResponse

deleteCloudExadataInfrastructure

  • Deletes the cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCloudExadataInfrastructure API.

    Parameters

    Returns Promise<DeleteCloudExadataInfrastructureResponse>

    DeleteCloudExadataInfrastructureResponse

deleteCloudVmCluster

  • Deletes the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCloudVmCluster API.

    Parameters

    Returns Promise<DeleteCloudVmClusterResponse>

    DeleteCloudVmClusterResponse

deleteConsoleConnection

deleteConsoleHistory

deleteDatabase

  • Deletes the specified database. Applies only to Exadata systems.

    The data in this database is local to the Exadata system and will be lost when the database is deleted. Oracle recommends that you back up any data in the Exadata system prior to deleting it. You can use the `performFinalBackup` parameter to have the Exadata system database backed up before it is deleted.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDatabase API.

    Parameters

    Returns Promise<DeleteDatabaseResponse>

    DeleteDatabaseResponse

deleteDatabaseSoftwareImage

deleteDbHome

  • Deletes a Database Home. Applies to bare metal DB systems, Exadata Cloud Service, and Exadata Cloud@Customer systems.

    Oracle recommends that you use the `performFinalBackup` parameter to back up any data on a bare metal DB system before you delete a Database Home. On an Exadata Cloud@Customer system or an Exadata Cloud Service system, you can delete a Database Home only when there are no databases in it and therefore you cannot use the `performFinalBackup` parameter to back up data.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDbHome API.

    Parameters

    Returns Promise<DeleteDbHomeResponse>

    DeleteDbHomeResponse

deleteExadataInfrastructure

deleteExternalContainerDatabase

  • Deletes the {@link #createExternalContainerDatabaseDetails(CreateExternalContainerDatabaseDetailsRequest) createExternalContainerDatabaseDetails} resource. Any external pluggable databases registered under this container database must be deleted in your Oracle Cloud Infrastructure tenancy prior to this operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteExternalContainerDatabase API.

    Parameters

    Returns Promise<DeleteExternalContainerDatabaseResponse>

    DeleteExternalContainerDatabaseResponse

deleteExternalDatabaseConnector

  • Deletes an external database connector. Any services enabled using the external database connector must be deleted prior to this operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteExternalDatabaseConnector API.

    Parameters

    Returns Promise<DeleteExternalDatabaseConnectorResponse>

    DeleteExternalDatabaseConnectorResponse

deleteExternalNonContainerDatabase

deleteExternalPluggableDatabase

  • Deletes the {@link #createExternalPluggableDatabaseDetails(CreateExternalPluggableDatabaseDetailsRequest) createExternalPluggableDatabaseDetails}. resource.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteExternalPluggableDatabase API.

    Parameters

    Returns Promise<DeleteExternalPluggableDatabaseResponse>

    DeleteExternalPluggableDatabaseResponse

deleteKeyStore

deleteOneoffPatch

deletePluggableDatabase

deleteVmCluster

  • Deletes the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteVmCluster API.

    Parameters

    Returns Promise<DeleteVmClusterResponse>

    DeleteVmClusterResponse

deleteVmClusterNetwork

  • Deletes the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To delete a cloud VM cluster in an Exadata Cloud Service instance, use the {@link #deleteCloudVmCluster(DeleteCloudVmClusterRequest) deleteCloudVmCluster} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteVmClusterNetwork API.

    Parameters

    Returns Promise<DeleteVmClusterNetworkResponse>

    DeleteVmClusterNetworkResponse

deregisterAutonomousDatabaseDataSafe

disableAutonomousDatabaseManagement

disableAutonomousDatabaseOperationsInsights

disableDatabaseManagement

disableExternalContainerDatabaseDatabaseManagement

disableExternalContainerDatabaseStackMonitoring

disableExternalNonContainerDatabaseDatabaseManagement

disableExternalNonContainerDatabaseOperationsInsights

disableExternalNonContainerDatabaseStackMonitoring

disableExternalPluggableDatabaseDatabaseManagement

disableExternalPluggableDatabaseOperationsInsights

disableExternalPluggableDatabaseStackMonitoring

disablePluggableDatabaseManagement

downloadExadataInfrastructureConfigFile

downloadOneoffPatch

downloadValidationReport

  • Downloads the network validation report file for the specified VM cluster network. Applies to Exadata Cloud@Customer instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DownloadValidationReport API.

    Parameters

    Returns Promise<DownloadValidationReportResponse>

    DownloadValidationReportResponse

downloadVmClusterNetworkConfigFile

enableAutonomousDatabaseManagement

enableAutonomousDatabaseOperationsInsights

enableDatabaseManagement

  • Enables the Database Management service for an Oracle Database located in Oracle Cloud Infrastructure. This service allows the database to access tools including Metrics and Performance hub. Database Management is enabled at the container database (CDB) level. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableDatabaseManagement API.

    Parameters

    Returns Promise<EnableDatabaseManagementResponse>

    EnableDatabaseManagementResponse

enableExternalContainerDatabaseDatabaseManagement

enableExternalContainerDatabaseStackMonitoring

enableExternalNonContainerDatabaseDatabaseManagement

enableExternalNonContainerDatabaseOperationsInsights

enableExternalNonContainerDatabaseStackMonitoring

enableExternalPluggableDatabaseDatabaseManagement

enableExternalPluggableDatabaseOperationsInsights

enableExternalPluggableDatabaseStackMonitoring

enablePluggableDatabaseManagement

  • Enables the Database Management service for an Oracle Pluggable Database located in Oracle Cloud Infrastructure. This service allows the pluggable database to access tools including Metrics and Performance hub. Database Management is enabled at the pluggable database (PDB) level. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnablePluggableDatabaseManagement API.

    Parameters

    Returns Promise<EnablePluggableDatabaseManagementResponse>

    EnablePluggableDatabaseManagementResponse

failOverAutonomousDatabase

  • Initiates a failover of the specified Autonomous Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. This API should be called in the remote region where the peer database resides. Below parameter is optional:

    • peerDbId Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. If this parameter is not provided, the failover will happen in the same region.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use FailOverAutonomousDatabase API.

    Parameters

    Returns Promise<FailOverAutonomousDatabaseResponse>

    FailOverAutonomousDatabaseResponse

failoverAutonomousContainerDatabaseDataguardAssociation

  • Fails over the standby Autonomous Container Database identified by the autonomousContainerDatabaseId parameter to the primary Autonomous Container Database after the existing primary Autonomous Container Database fails or becomes unreachable.

    A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use FailoverAutonomousContainerDatabaseDataguardAssociation API.

    Parameters

    Returns Promise<FailoverAutonomousContainerDatabaseDataguardAssociationResponse>

    FailoverAutonomousContainerDatabaseDataguardAssociationResponse

failoverDataGuardAssociation

  • Performs a failover to transition the standby database identified by the databaseId parameter into the specified Data Guard association's primary role after the existing primary database fails or becomes unreachable.

    A failover might result in data loss depending on the protection mode in effect at the time of the primary database failure.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use FailoverDataGuardAssociation API.

    Parameters

    Returns Promise<FailoverDataGuardAssociationResponse>

    FailoverDataGuardAssociationResponse

generateAutonomousDatabaseWallet

generateRecommendedVmClusterNetwork

getApplicationVip

  • Gets information about a specified application virtual IP (VIP) address. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetApplicationVip API.

    Parameters

    Returns Promise<GetApplicationVipResponse>

    GetApplicationVipResponse

getAutonomousContainerDatabase

getAutonomousContainerDatabaseDataguardAssociation

getAutonomousContainerDatabaseResourceUsage

getAutonomousDatabase

getAutonomousDatabaseBackup

getAutonomousDatabaseDataguardAssociation

getAutonomousDatabaseRegionalWallet

getAutonomousDatabaseSoftwareImage

getAutonomousDatabaseWallet

getAutonomousExadataInfrastructure

  • Deprecated. Use the {@link #getCloudExadataInfrastructure(GetCloudExadataInfrastructureRequest) getCloudExadataInfrastructure} operation to get details of an Exadata Infrastructure resource and the {@link #getCloudAutonomousVmCluster(GetCloudAutonomousVmClusterRequest) getCloudAutonomousVmCluster} operation to get details of an Autonomous Exadata VM cluster.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAutonomousExadataInfrastructure API.

    Parameters

    Returns Promise<GetAutonomousExadataInfrastructureResponse>

    GetAutonomousExadataInfrastructureResponse

getAutonomousPatch

getAutonomousVirtualMachine

getAutonomousVmCluster

  • Gets information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system. To get information about an Autonomous VM Cluster in the Oracle cloud, see {@link #getCloudAutonomousVmCluster(GetCloudAutonomousVmClusterRequest) getCloudAutonomousVmCluster}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAutonomousVmCluster API.

    Parameters

    Returns Promise<GetAutonomousVmClusterResponse>

    GetAutonomousVmClusterResponse

getAutonomousVmClusterResourceUsage

getBackup

  • Gets information about the specified backup. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBackup API.

    Parameters

    Returns Promise<GetBackupResponse>

    GetBackupResponse

getBackupDestination

  • Gets information about the specified backup destination in an Exadata Cloud@Customer system.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBackupDestination API.

    Parameters

    Returns Promise<GetBackupDestinationResponse>

    GetBackupDestinationResponse

getCloudAutonomousVmCluster

  • Gets information about the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Custustomer systems, see {@link #getAutonomousVmCluster(GetAutonomousVmClusterRequest) getAutonomousVmCluster}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCloudAutonomousVmCluster API.

    Parameters

    Returns Promise<GetCloudAutonomousVmClusterResponse>

    GetCloudAutonomousVmClusterResponse

getCloudAutonomousVmClusterResourceUsage

getCloudExadataInfrastructure

  • Gets information about the specified cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCloudExadataInfrastructure API.

    Parameters

    Returns Promise<GetCloudExadataInfrastructureResponse>

    GetCloudExadataInfrastructureResponse

getCloudExadataInfrastructureUnallocatedResources

getCloudVmCluster

  • Gets information about the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCloudVmCluster API.

    Parameters

    Returns Promise<GetCloudVmClusterResponse>

    GetCloudVmClusterResponse

getCloudVmClusterIormConfig

  • Gets the IORM configuration for the specified cloud VM cluster in an Exadata Cloud Service instance. If you have not specified an IORM configuration, the default configuration is returned.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCloudVmClusterIormConfig API.

    Parameters

    Returns Promise<GetCloudVmClusterIormConfigResponse>

    GetCloudVmClusterIormConfigResponse

getCloudVmClusterUpdate

  • Gets information about a specified maintenance update package for a cloud VM cluster. Applies to Exadata Cloud Service instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCloudVmClusterUpdate API.

    Parameters

    Returns Promise<GetCloudVmClusterUpdateResponse>

    GetCloudVmClusterUpdateResponse

getCloudVmClusterUpdateHistoryEntry

getConsoleConnection

getConsoleHistory

getConsoleHistoryContent

getDataGuardAssociation

getDatabase

  • Gets information about the specified database. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDatabase API.

    Parameters

    Returns Promise<GetDatabaseResponse>

    GetDatabaseResponse

getDatabaseSoftwareImage

getDatabaseUpgradeHistoryEntry

getDbHome

  • Gets information about the specified Database Home. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDbHome API.

    Parameters

    Returns Promise<GetDbHomeResponse>

    GetDbHomeResponse

getDbHomePatch

getDbHomePatchHistoryEntry

getDbNode

  • Gets information about the specified database node. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDbNode API.

    Parameters

    Returns Promise<GetDbNodeResponse>

    GetDbNodeResponse

getDbServer

  • Gets information about the Exadata Db server.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDbServer API.

    Parameters

    Returns Promise<GetDbServerResponse>

    GetDbServerResponse

getDbSystem

  • Gets information about the specified DB system.

    *Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.

    For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDbSystem API.

    Parameters

    Returns Promise<GetDbSystemResponse>

    GetDbSystemResponse

getDbSystemPatch

getDbSystemPatchHistoryEntry

getDbSystemUpgradeHistoryEntry

getExadataInfrastructure

  • Gets information about the specified Exadata infrastructure. Applies to Exadata Cloud@Customer instances only. To get information on an Exadata Cloud Service infrastructure resource, use the {@link #getCloudExadataInfrastructure(GetCloudExadataInfrastructureRequest) getCloudExadataInfrastructure} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetExadataInfrastructure API.

    Parameters

    Returns Promise<GetExadataInfrastructureResponse>

    GetExadataInfrastructureResponse

getExadataInfrastructureOcpus

getExadataInfrastructureUnAllocatedResources

getExadataIormConfig

  • Gets the IORM configuration settings for the specified cloud Exadata DB system. All Exadata service instances have default IORM settings.

    *Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.

    For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.

    The {@link #getCloudVmClusterIormConfig(GetCloudVmClusterIormConfigRequest) getCloudVmClusterIormConfig} API is used for this operation with Exadata systems using the new resource model.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetExadataIormConfig API.

    Parameters

    Returns Promise<GetExadataIormConfigResponse>

    GetExadataIormConfigResponse

getExternalBackupJob

  • Gets information about the specified external backup job.

    *Note:** This API is used by an Oracle Cloud Infrastructure Python script that is packaged with the Oracle Cloud Infrastructure CLI. Oracle recommends that you use the script instead using the API directly. See [Migrating an On-Premises Database to Oracle Cloud Infrastructure by Creating a Backup in the Cloud](https://docs.cloud.oracle.com/Content/Database/Tasks/mig-onprembackup.htm) for more information.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetExternalBackupJob API.

    Parameters

    Returns Promise<GetExternalBackupJobResponse>

    GetExternalBackupJobResponse

getExternalContainerDatabase

getExternalDatabaseConnector

getExternalNonContainerDatabase

getExternalPluggableDatabase

  • Gets information about a specific {@link #createExternalPluggableDatabaseDetails(CreateExternalPluggableDatabaseDetailsRequest) createExternalPluggableDatabaseDetails} resource.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetExternalPluggableDatabase API.

    Parameters

    Returns Promise<GetExternalPluggableDatabaseResponse>

    GetExternalPluggableDatabaseResponse

getInfrastructureTargetVersions

  • Gets details of the Exadata Infrastructure target system software versions that can be applied to the specified infrastructure resource for maintenance updates. Applies to Exadata Cloud@Customer and Exadata Cloud instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetInfrastructureTargetVersions API.

    Parameters

    Returns Promise<GetInfrastructureTargetVersionsResponse>

    GetInfrastructureTargetVersionsResponse

getKeyStore

  • Gets information about the specified key store.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetKeyStore API.

    Parameters

    Returns Promise<GetKeyStoreResponse>

    GetKeyStoreResponse

getMaintenanceRun

getMaintenanceRunHistory

getOneoffPatch

getPdbConversionHistoryEntry

getPluggableDatabase

getVmCluster

  • Gets information about the VM cluster. Applies to Exadata Cloud@Customer instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVmCluster API.

    Parameters

    Returns Promise<GetVmClusterResponse>

    GetVmClusterResponse

getVmClusterNetwork

  • Gets information about the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To get information about a cloud VM cluster in an Exadata Cloud Service instance, use the {@link #getCloudVmCluster(GetCloudVmClusterRequest) getCloudVmCluster} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVmClusterNetwork API.

    Parameters

    Returns Promise<GetVmClusterNetworkResponse>

    GetVmClusterNetworkResponse

getVmClusterPatch

getVmClusterPatchHistoryEntry

getVmClusterUpdate

  • Gets information about a specified maintenance update package for a VM cluster. Applies to Exadata Cloud@Customer instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVmClusterUpdate API.

    Parameters

    Returns Promise<GetVmClusterUpdateResponse>

    GetVmClusterUpdateResponse

getVmClusterUpdateHistoryEntry

getWaiters

launchAutonomousExadataInfrastructure

  • Deprecated To create a new Autonomous Database system on dedicated Exadata Infrastructure, use the {@link #createCloudExadataInfrastructure(CreateCloudExadataInfrastructureRequest) createCloudExadataInfrastructure} and {@link #createCloudAutonomousVmCluster(CreateCloudAutonomousVmClusterRequest) createCloudAutonomousVmCluster} operations instead. Note that to create an Autonomous VM cluster, you must have an existing Exadata Infrastructure resource to contain the VM cluster.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use LaunchAutonomousExadataInfrastructure API.

    Parameters

    Returns Promise<LaunchAutonomousExadataInfrastructureResponse>

    LaunchAutonomousExadataInfrastructureResponse

launchDbSystem

  • Creates a new DB system in the specified compartment and availability domain. The Oracle Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.

    An initial database is created on the DB system based on the request parameters you provide and some default options. For detailed information about default options, see [Bare metal and virtual machine DB system default options.](https://docs.cloud.oracle.com/Content/Database/Tasks/creatingDBsystem.htm#Default)

    *Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.

    For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.

    Use the {@link #createCloudExadataInfrastructure(CreateCloudExadataInfrastructureRequest) createCloudExadataInfrastructure} and {@link #createCloudVmCluster(CreateCloudVmClusterRequest) createCloudVmCluster} APIs to provision a new Exadata Cloud Service instance.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use LaunchDbSystem API.

    Parameters

    Returns Promise<LaunchDbSystemResponse>

    LaunchDbSystemResponse

listAllApplicationVips

  • NOTE: This function is deprecated in favor of listApplicationVipsRecordIterator function. Creates a new async iterator which will iterate over the models.ApplicationVipSummary objects contained in responses from the listApplicationVips operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ApplicationVipSummary>

listAllApplicationVipsResponses

  • NOTE: This function is deprecated in favor of listApplicationVipsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listApplicationVips operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListApplicationVipsResponse>

listAllAutonomousContainerDatabaseDataguardAssociations

listAllAutonomousContainerDatabaseDataguardAssociationsResponses

listAllAutonomousContainerDatabaseVersions

  • NOTE: This function is deprecated in favor of listAutonomousContainerDatabaseVersionsRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousContainerDatabaseVersionSummary objects contained in responses from the listAutonomousContainerDatabaseVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousContainerDatabaseVersionSummary>

listAllAutonomousContainerDatabaseVersionsResponses

listAllAutonomousContainerDatabases

  • NOTE: This function is deprecated in favor of listAutonomousContainerDatabasesRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousContainerDatabaseSummary objects contained in responses from the listAutonomousContainerDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousContainerDatabaseSummary>

listAllAutonomousContainerDatabasesResponses

listAllAutonomousDatabaseBackups

  • NOTE: This function is deprecated in favor of listAutonomousDatabaseBackupsRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousDatabaseBackupSummary objects contained in responses from the listAutonomousDatabaseBackups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousDatabaseBackupSummary>

listAllAutonomousDatabaseBackupsResponses

listAllAutonomousDatabaseClones

  • NOTE: This function is deprecated in favor of listAutonomousDatabaseClonesRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousDatabaseSummary objects contained in responses from the listAutonomousDatabaseClones operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousDatabaseSummary>

listAllAutonomousDatabaseClonesResponses

listAllAutonomousDatabaseDataguardAssociations

  • NOTE: This function is deprecated in favor of listAutonomousDatabaseDataguardAssociationsRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousDatabaseDataguardAssociation objects contained in responses from the listAutonomousDatabaseDataguardAssociations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousDatabaseDataguardAssociation>

listAllAutonomousDatabaseDataguardAssociationsResponses

listAllAutonomousDatabases

  • NOTE: This function is deprecated in favor of listAutonomousDatabasesRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousDatabaseSummary objects contained in responses from the listAutonomousDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousDatabaseSummary>

listAllAutonomousDatabasesResponses

  • NOTE: This function is deprecated in favor of listAutonomousDatabasesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAutonomousDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAutonomousDatabasesResponse>

listAllAutonomousDbPreviewVersions

  • NOTE: This function is deprecated in favor of listAutonomousDbPreviewVersionsRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousDbPreviewVersionSummary objects contained in responses from the listAutonomousDbPreviewVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousDbPreviewVersionSummary>

listAllAutonomousDbPreviewVersionsResponses

listAllAutonomousDbVersions

  • NOTE: This function is deprecated in favor of listAutonomousDbVersionsRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousDbVersionSummary objects contained in responses from the listAutonomousDbVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousDbVersionSummary>

listAllAutonomousDbVersionsResponses

  • NOTE: This function is deprecated in favor of listAutonomousDbVersionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAutonomousDbVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAutonomousDbVersionsResponse>

listAllAutonomousExadataInfrastructureShapes

listAllAutonomousExadataInfrastructureShapesResponses

listAllAutonomousExadataInfrastructures

  • NOTE: This function is deprecated in favor of listAutonomousExadataInfrastructuresRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousExadataInfrastructureSummary objects contained in responses from the listAutonomousExadataInfrastructures operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousExadataInfrastructureSummary>

listAllAutonomousExadataInfrastructuresResponses

listAllAutonomousVirtualMachines

  • NOTE: This function is deprecated in favor of listAutonomousVirtualMachinesRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousVirtualMachineSummary objects contained in responses from the listAutonomousVirtualMachines operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousVirtualMachineSummary>

listAllAutonomousVirtualMachinesResponses

listAllAutonomousVmClusterAcdResourceUsage

  • NOTE: This function is deprecated in favor of listAutonomousVmClusterAcdResourceUsageRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousContainerDatabaseResourceUsage objects contained in responses from the listAutonomousVmClusterAcdResourceUsage operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousContainerDatabaseResourceUsage>

listAllAutonomousVmClusterAcdResourceUsageResponses

listAllAutonomousVmClusters

  • NOTE: This function is deprecated in favor of listAutonomousVmClustersRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousVmClusterSummary objects contained in responses from the listAutonomousVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousVmClusterSummary>

listAllAutonomousVmClustersResponses

  • NOTE: This function is deprecated in favor of listAutonomousVmClustersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAutonomousVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAutonomousVmClustersResponse>

listAllBackupDestination

  • NOTE: This function is deprecated in favor of listBackupDestinationRecordIterator function. Creates a new async iterator which will iterate over the models.BackupDestinationSummary objects contained in responses from the listBackupDestination operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<BackupDestinationSummary>

listAllBackupDestinationResponses

  • NOTE: This function is deprecated in favor of listBackupDestinationResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listBackupDestination operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListBackupDestinationResponse>

listAllBackups

  • NOTE: This function is deprecated in favor of listBackupsRecordIterator function. Creates a new async iterator which will iterate over the models.BackupSummary objects contained in responses from the listBackups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<BackupSummary>

listAllBackupsResponses

  • NOTE: This function is deprecated in favor of listBackupsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listBackups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListBackupsResponse>

listAllCloudAutonomousVmClusterAcdResourceUsage

listAllCloudAutonomousVmClusterAcdResourceUsageResponses

listAllCloudAutonomousVmClusters

  • NOTE: This function is deprecated in favor of listCloudAutonomousVmClustersRecordIterator function. Creates a new async iterator which will iterate over the models.CloudAutonomousVmClusterSummary objects contained in responses from the listCloudAutonomousVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CloudAutonomousVmClusterSummary>

listAllCloudAutonomousVmClustersResponses

listAllCloudExadataInfrastructures

  • NOTE: This function is deprecated in favor of listCloudExadataInfrastructuresRecordIterator function. Creates a new async iterator which will iterate over the models.CloudExadataInfrastructureSummary objects contained in responses from the listCloudExadataInfrastructures operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CloudExadataInfrastructureSummary>

listAllCloudExadataInfrastructuresResponses

listAllCloudVmClusterUpdateHistoryEntries

  • NOTE: This function is deprecated in favor of listCloudVmClusterUpdateHistoryEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.UpdateHistoryEntrySummary objects contained in responses from the listCloudVmClusterUpdateHistoryEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UpdateHistoryEntrySummary>

listAllCloudVmClusterUpdateHistoryEntriesResponses

listAllCloudVmClusterUpdates

  • NOTE: This function is deprecated in favor of listCloudVmClusterUpdatesRecordIterator function. Creates a new async iterator which will iterate over the models.UpdateSummary objects contained in responses from the listCloudVmClusterUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UpdateSummary>

listAllCloudVmClusterUpdatesResponses

  • NOTE: This function is deprecated in favor of listCloudVmClusterUpdatesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCloudVmClusterUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCloudVmClusterUpdatesResponse>

listAllCloudVmClusters

  • NOTE: This function is deprecated in favor of listCloudVmClustersRecordIterator function. Creates a new async iterator which will iterate over the models.CloudVmClusterSummary objects contained in responses from the listCloudVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CloudVmClusterSummary>

listAllCloudVmClustersResponses

  • NOTE: This function is deprecated in favor of listCloudVmClustersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCloudVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCloudVmClustersResponse>

listAllContainerDatabasePatches

  • NOTE: This function is deprecated in favor of listContainerDatabasePatchesRecordIterator function. Creates a new async iterator which will iterate over the models.AutonomousPatchSummary objects contained in responses from the listContainerDatabasePatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AutonomousPatchSummary>

listAllContainerDatabasePatchesResponses

listAllDataGuardAssociations

  • NOTE: This function is deprecated in favor of listDataGuardAssociationsRecordIterator function. Creates a new async iterator which will iterate over the models.DataGuardAssociationSummary objects contained in responses from the listDataGuardAssociations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DataGuardAssociationSummary>

listAllDataGuardAssociationsResponses

  • NOTE: This function is deprecated in favor of listDataGuardAssociationsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDataGuardAssociations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDataGuardAssociationsResponse>

listAllDatabaseSoftwareImages

  • NOTE: This function is deprecated in favor of listDatabaseSoftwareImagesRecordIterator function. Creates a new async iterator which will iterate over the models.DatabaseSoftwareImageSummary objects contained in responses from the listDatabaseSoftwareImages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DatabaseSoftwareImageSummary>

listAllDatabaseSoftwareImagesResponses

listAllDatabaseUpgradeHistoryEntries

  • NOTE: This function is deprecated in favor of listDatabaseUpgradeHistoryEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.DatabaseUpgradeHistoryEntrySummary objects contained in responses from the listDatabaseUpgradeHistoryEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DatabaseUpgradeHistoryEntrySummary>

listAllDatabaseUpgradeHistoryEntriesResponses

listAllDatabases

  • NOTE: This function is deprecated in favor of listDatabasesRecordIterator function. Creates a new async iterator which will iterate over the models.DatabaseSummary objects contained in responses from the listDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DatabaseSummary>

listAllDatabasesResponses

  • NOTE: This function is deprecated in favor of listDatabasesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDatabasesResponse>

listAllDbHomePatchHistoryEntries

  • NOTE: This function is deprecated in favor of listDbHomePatchHistoryEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.PatchHistoryEntrySummary objects contained in responses from the listDbHomePatchHistoryEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchHistoryEntrySummary>

listAllDbHomePatchHistoryEntriesResponses

listAllDbHomePatches

  • NOTE: This function is deprecated in favor of listDbHomePatchesRecordIterator function. Creates a new async iterator which will iterate over the models.PatchSummary objects contained in responses from the listDbHomePatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchSummary>

listAllDbHomePatchesResponses

  • NOTE: This function is deprecated in favor of listDbHomePatchesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbHomePatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbHomePatchesResponse>

listAllDbHomes

  • NOTE: This function is deprecated in favor of listDbHomesRecordIterator function. Creates a new async iterator which will iterate over the models.DbHomeSummary objects contained in responses from the listDbHomes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbHomeSummary>

listAllDbHomesResponses

  • NOTE: This function is deprecated in favor of listDbHomesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbHomes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbHomesResponse>

listAllDbNodes

  • NOTE: This function is deprecated in favor of listDbNodesRecordIterator function. Creates a new async iterator which will iterate over the models.DbNodeSummary objects contained in responses from the listDbNodes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbNodeSummary>

listAllDbNodesResponses

  • NOTE: This function is deprecated in favor of listDbNodesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbNodes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbNodesResponse>

listAllDbServers

  • NOTE: This function is deprecated in favor of listDbServersRecordIterator function. Creates a new async iterator which will iterate over the models.DbServerSummary objects contained in responses from the listDbServers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbServerSummary>

listAllDbServersResponses

  • NOTE: This function is deprecated in favor of listDbServersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbServers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbServersResponse>

listAllDbSystemPatchHistoryEntries

  • NOTE: This function is deprecated in favor of listDbSystemPatchHistoryEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.PatchHistoryEntrySummary objects contained in responses from the listDbSystemPatchHistoryEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchHistoryEntrySummary>

listAllDbSystemPatchHistoryEntriesResponses

listAllDbSystemPatches

  • NOTE: This function is deprecated in favor of listDbSystemPatchesRecordIterator function. Creates a new async iterator which will iterate over the models.PatchSummary objects contained in responses from the listDbSystemPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchSummary>

listAllDbSystemPatchesResponses

  • NOTE: This function is deprecated in favor of listDbSystemPatchesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbSystemPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbSystemPatchesResponse>

listAllDbSystemShapes

  • NOTE: This function is deprecated in favor of listDbSystemShapesRecordIterator function. Creates a new async iterator which will iterate over the models.DbSystemShapeSummary objects contained in responses from the listDbSystemShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbSystemShapeSummary>

listAllDbSystemShapesResponses

  • NOTE: This function is deprecated in favor of listDbSystemShapesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbSystemShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbSystemShapesResponse>

listAllDbSystemUpgradeHistoryEntries

  • NOTE: This function is deprecated in favor of listDbSystemUpgradeHistoryEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.DbSystemUpgradeHistoryEntrySummary objects contained in responses from the listDbSystemUpgradeHistoryEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbSystemUpgradeHistoryEntrySummary>

listAllDbSystemUpgradeHistoryEntriesResponses

listAllDbSystems

  • NOTE: This function is deprecated in favor of listDbSystemsRecordIterator function. Creates a new async iterator which will iterate over the models.DbSystemSummary objects contained in responses from the listDbSystems operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbSystemSummary>

listAllDbSystemsResponses

  • NOTE: This function is deprecated in favor of listDbSystemsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbSystems operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbSystemsResponse>

listAllDbVersions

  • NOTE: This function is deprecated in favor of listDbVersionsRecordIterator function. Creates a new async iterator which will iterate over the models.DbVersionSummary objects contained in responses from the listDbVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbVersionSummary>

listAllDbVersionsResponses

  • NOTE: This function is deprecated in favor of listDbVersionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDbVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbVersionsResponse>

listAllExadataInfrastructures

  • NOTE: This function is deprecated in favor of listExadataInfrastructuresRecordIterator function. Creates a new async iterator which will iterate over the models.ExadataInfrastructureSummary objects contained in responses from the listExadataInfrastructures operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ExadataInfrastructureSummary>

listAllExadataInfrastructuresResponses

listAllExternalContainerDatabases

  • NOTE: This function is deprecated in favor of listExternalContainerDatabasesRecordIterator function. Creates a new async iterator which will iterate over the models.ExternalContainerDatabaseSummary objects contained in responses from the listExternalContainerDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ExternalContainerDatabaseSummary>

listAllExternalContainerDatabasesResponses

listAllExternalDatabaseConnectors

  • NOTE: This function is deprecated in favor of listExternalDatabaseConnectorsRecordIterator function. Creates a new async iterator which will iterate over the models.ExternalDatabaseConnectorSummary objects contained in responses from the listExternalDatabaseConnectors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ExternalDatabaseConnectorSummary>

listAllExternalDatabaseConnectorsResponses

listAllExternalNonContainerDatabases

  • NOTE: This function is deprecated in favor of listExternalNonContainerDatabasesRecordIterator function. Creates a new async iterator which will iterate over the models.ExternalNonContainerDatabaseSummary objects contained in responses from the listExternalNonContainerDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ExternalNonContainerDatabaseSummary>

listAllExternalNonContainerDatabasesResponses

listAllExternalPluggableDatabases

  • NOTE: This function is deprecated in favor of listExternalPluggableDatabasesRecordIterator function. Creates a new async iterator which will iterate over the models.ExternalPluggableDatabaseSummary objects contained in responses from the listExternalPluggableDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ExternalPluggableDatabaseSummary>

listAllExternalPluggableDatabasesResponses

listAllGiVersions

  • NOTE: This function is deprecated in favor of listGiVersionsRecordIterator function. Creates a new async iterator which will iterate over the models.GiVersionSummary objects contained in responses from the listGiVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GiVersionSummary>

listAllGiVersionsResponses

  • NOTE: This function is deprecated in favor of listGiVersionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listGiVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListGiVersionsResponse>

listAllKeyStores

  • NOTE: This function is deprecated in favor of listKeyStoresRecordIterator function. Creates a new async iterator which will iterate over the models.KeyStoreSummary objects contained in responses from the listKeyStores operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<KeyStoreSummary>

listAllKeyStoresResponses

  • NOTE: This function is deprecated in favor of listKeyStoresResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listKeyStores operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListKeyStoresResponse>

listAllMaintenanceRunHistory

  • NOTE: This function is deprecated in favor of listMaintenanceRunHistoryRecordIterator function. Creates a new async iterator which will iterate over the models.MaintenanceRunHistorySummary objects contained in responses from the listMaintenanceRunHistory operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<MaintenanceRunHistorySummary>

listAllMaintenanceRunHistoryResponses

  • NOTE: This function is deprecated in favor of listMaintenanceRunHistoryResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listMaintenanceRunHistory operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListMaintenanceRunHistoryResponse>

listAllMaintenanceRuns

  • NOTE: This function is deprecated in favor of listMaintenanceRunsRecordIterator function. Creates a new async iterator which will iterate over the models.MaintenanceRunSummary objects contained in responses from the listMaintenanceRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<MaintenanceRunSummary>

listAllMaintenanceRunsResponses

  • NOTE: This function is deprecated in favor of listMaintenanceRunsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listMaintenanceRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListMaintenanceRunsResponse>

listAllOneoffPatches

  • NOTE: This function is deprecated in favor of listOneoffPatchesRecordIterator function. Creates a new async iterator which will iterate over the models.OneoffPatchSummary objects contained in responses from the listOneoffPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<OneoffPatchSummary>

listAllOneoffPatchesResponses

  • NOTE: This function is deprecated in favor of listOneoffPatchesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listOneoffPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListOneoffPatchesResponse>

listAllPdbConversionHistoryEntries

  • NOTE: This function is deprecated in favor of listPdbConversionHistoryEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.PdbConversionHistoryEntrySummary objects contained in responses from the listPdbConversionHistoryEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PdbConversionHistoryEntrySummary>

listAllPdbConversionHistoryEntriesResponses

listAllPluggableDatabases

  • NOTE: This function is deprecated in favor of listPluggableDatabasesRecordIterator function. Creates a new async iterator which will iterate over the models.PluggableDatabaseSummary objects contained in responses from the listPluggableDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PluggableDatabaseSummary>

listAllPluggableDatabasesResponses

  • NOTE: This function is deprecated in favor of listPluggableDatabasesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPluggableDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPluggableDatabasesResponse>

listAllVmClusterNetworks

  • NOTE: This function is deprecated in favor of listVmClusterNetworksRecordIterator function. Creates a new async iterator which will iterate over the models.VmClusterNetworkSummary objects contained in responses from the listVmClusterNetworks operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VmClusterNetworkSummary>

listAllVmClusterNetworksResponses

  • NOTE: This function is deprecated in favor of listVmClusterNetworksResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVmClusterNetworks operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListVmClusterNetworksResponse>

listAllVmClusterPatchHistoryEntries

  • NOTE: This function is deprecated in favor of listVmClusterPatchHistoryEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.PatchHistoryEntrySummary objects contained in responses from the listVmClusterPatchHistoryEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchHistoryEntrySummary>

listAllVmClusterPatchHistoryEntriesResponses

listAllVmClusterPatches

  • NOTE: This function is deprecated in favor of listVmClusterPatchesRecordIterator function. Creates a new async iterator which will iterate over the models.PatchSummary objects contained in responses from the listVmClusterPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchSummary>

listAllVmClusterPatchesResponses

  • NOTE: This function is deprecated in favor of listVmClusterPatchesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVmClusterPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListVmClusterPatchesResponse>

listAllVmClusterUpdateHistoryEntries

  • NOTE: This function is deprecated in favor of listVmClusterUpdateHistoryEntriesRecordIterator function. Creates a new async iterator which will iterate over the models.VmClusterUpdateHistoryEntrySummary objects contained in responses from the listVmClusterUpdateHistoryEntries operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VmClusterUpdateHistoryEntrySummary>

listAllVmClusterUpdateHistoryEntriesResponses

listAllVmClusterUpdates

  • NOTE: This function is deprecated in favor of listVmClusterUpdatesRecordIterator function. Creates a new async iterator which will iterate over the models.VmClusterUpdateSummary objects contained in responses from the listVmClusterUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VmClusterUpdateSummary>

listAllVmClusterUpdatesResponses

  • NOTE: This function is deprecated in favor of listVmClusterUpdatesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVmClusterUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListVmClusterUpdatesResponse>

listAllVmClusters

  • NOTE: This function is deprecated in favor of listVmClustersRecordIterator function. Creates a new async iterator which will iterate over the models.VmClusterSummary objects contained in responses from the listVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VmClusterSummary>

listAllVmClustersResponses

  • NOTE: This function is deprecated in favor of listVmClustersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListVmClustersResponse>

listApplicationVips

listApplicationVipsRecordIterator

  • Creates a new async iterator which will iterate over the models.ApplicationVipSummary objects contained in responses from the listApplicationVips operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ApplicationVipSummary>

listApplicationVipsResponseIterator

listAutonomousContainerDatabaseDataguardAssociations

listAutonomousContainerDatabaseDataguardAssociationsRecordIterator

listAutonomousContainerDatabaseDataguardAssociationsResponseIterator

listAutonomousContainerDatabaseVersions

listAutonomousContainerDatabaseVersionsRecordIterator

listAutonomousContainerDatabaseVersionsResponseIterator

listAutonomousContainerDatabases

listAutonomousContainerDatabasesRecordIterator

listAutonomousContainerDatabasesResponseIterator

listAutonomousDatabaseBackups

  • Gets a list of Autonomous Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAutonomousDatabaseBackups API.

    Parameters

    Returns Promise<ListAutonomousDatabaseBackupsResponse>

    ListAutonomousDatabaseBackupsResponse

listAutonomousDatabaseBackupsRecordIterator

listAutonomousDatabaseBackupsResponseIterator

listAutonomousDatabaseCharacterSets

listAutonomousDatabaseClones

listAutonomousDatabaseClonesRecordIterator

listAutonomousDatabaseClonesResponseIterator

listAutonomousDatabaseDataguardAssociations

listAutonomousDatabaseDataguardAssociationsRecordIterator

listAutonomousDatabaseDataguardAssociationsResponseIterator

listAutonomousDatabaseRefreshableClones

listAutonomousDatabaseSoftwareImages

listAutonomousDatabases

listAutonomousDatabasesRecordIterator

listAutonomousDatabasesResponseIterator

listAutonomousDbPreviewVersions

listAutonomousDbPreviewVersionsRecordIterator

listAutonomousDbPreviewVersionsResponseIterator

listAutonomousDbVersions

listAutonomousDbVersionsRecordIterator

listAutonomousDbVersionsResponseIterator

listAutonomousExadataInfrastructureShapes

listAutonomousExadataInfrastructureShapesRecordIterator

listAutonomousExadataInfrastructureShapesResponseIterator

listAutonomousExadataInfrastructures

  • Deprecated. Use the {@link #listCloudExadataInfrastructures(ListCloudExadataInfrastructuresRequest) listCloudExadataInfrastructures} operation to list Exadata Infrastructures in the Oracle cloud and the {@link #listCloudAutonomousVmClusters(ListCloudAutonomousVmClustersRequest) listCloudAutonomousVmClusters} operation to list Autonomous Exadata VM clusters.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAutonomousExadataInfrastructures API.

    Parameters

    Returns Promise<ListAutonomousExadataInfrastructuresResponse>

    ListAutonomousExadataInfrastructuresResponse

listAutonomousExadataInfrastructuresRecordIterator

listAutonomousExadataInfrastructuresResponseIterator

listAutonomousVirtualMachines

listAutonomousVirtualMachinesRecordIterator

listAutonomousVirtualMachinesResponseIterator

listAutonomousVmClusterAcdResourceUsage

listAutonomousVmClusterAcdResourceUsageRecordIterator

listAutonomousVmClusterAcdResourceUsageResponseIterator

listAutonomousVmClusters

  • Gets a list of Exadata Cloud@Customer Autonomous VM clusters in the specified compartment. To list Autonomous VM Clusters in the Oracle Cloud, see {@link #listCloudAutonomousVmClusters(ListCloudAutonomousVmClustersRequest) listCloudAutonomousVmClusters}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAutonomousVmClusters API.

    Parameters

    Returns Promise<ListAutonomousVmClustersResponse>

    ListAutonomousVmClustersResponse

listAutonomousVmClustersRecordIterator

listAutonomousVmClustersResponseIterator

listBackupDestination

listBackupDestinationRecordIterator

listBackupDestinationResponseIterator

listBackups

  • Gets a list of backups based on the databaseId or compartmentId specified. Either one of these query parameters must be provided.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBackups API.

    Parameters

    Returns Promise<ListBackupsResponse>

    ListBackupsResponse

listBackupsRecordIterator

  • Creates a new async iterator which will iterate over the models.BackupSummary objects contained in responses from the listBackups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<BackupSummary>

listBackupsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listBackups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListBackupsResponse>

listCloudAutonomousVmClusterAcdResourceUsage

listCloudAutonomousVmClusterAcdResourceUsageRecordIterator

listCloudAutonomousVmClusterAcdResourceUsageResponseIterator

listCloudAutonomousVmClusters

  • Lists Autonomous Exadata VM clusters in the Oracle cloud. For Exadata Cloud@Customer systems, see {@link #listAutonomousVmClusters(ListAutonomousVmClustersRequest) listAutonomousVmClusters}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCloudAutonomousVmClusters API.

    Parameters

    Returns Promise<ListCloudAutonomousVmClustersResponse>

    ListCloudAutonomousVmClustersResponse

listCloudAutonomousVmClustersRecordIterator

listCloudAutonomousVmClustersResponseIterator

listCloudExadataInfrastructures

  • Gets a list of the cloud Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCloudExadataInfrastructures API.

    Parameters

    Returns Promise<ListCloudExadataInfrastructuresResponse>

    ListCloudExadataInfrastructuresResponse

listCloudExadataInfrastructuresRecordIterator

listCloudExadataInfrastructuresResponseIterator

listCloudVmClusterUpdateHistoryEntries

listCloudVmClusterUpdateHistoryEntriesRecordIterator

listCloudVmClusterUpdateHistoryEntriesResponseIterator

listCloudVmClusterUpdates

  • Lists the maintenance updates that can be applied to the specified cloud VM cluster. Applies to Exadata Cloud Service instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCloudVmClusterUpdates API.

    Parameters

    Returns Promise<ListCloudVmClusterUpdatesResponse>

    ListCloudVmClusterUpdatesResponse

listCloudVmClusterUpdatesRecordIterator

  • Creates a new async iterator which will iterate over the models.UpdateSummary objects contained in responses from the listCloudVmClusterUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<UpdateSummary>

listCloudVmClusterUpdatesResponseIterator

listCloudVmClusters

  • Gets a list of the cloud VM clusters in the specified compartment. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCloudVmClusters API.

    Parameters

    Returns Promise<ListCloudVmClustersResponse>

    ListCloudVmClustersResponse

listCloudVmClustersRecordIterator

  • Creates a new async iterator which will iterate over the models.CloudVmClusterSummary objects contained in responses from the listCloudVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CloudVmClusterSummary>

listCloudVmClustersResponseIterator

listConsoleConnections

listConsoleHistories

listContainerDatabasePatches

listContainerDatabasePatchesRecordIterator

listContainerDatabasePatchesResponseIterator

listDataGuardAssociations

listDataGuardAssociationsRecordIterator

listDataGuardAssociationsResponseIterator

listDatabaseSoftwareImages

listDatabaseSoftwareImagesRecordIterator

listDatabaseSoftwareImagesResponseIterator

listDatabaseUpgradeHistoryEntries

listDatabaseUpgradeHistoryEntriesRecordIterator

listDatabaseUpgradeHistoryEntriesResponseIterator

listDatabases

  • Gets a list of the databases in the specified Database Home.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDatabases API.

    Parameters

    Returns Promise<ListDatabasesResponse>

    ListDatabasesResponse

listDatabasesRecordIterator

  • Creates a new async iterator which will iterate over the models.DatabaseSummary objects contained in responses from the listDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DatabaseSummary>

listDatabasesResponseIterator

listDbHomePatchHistoryEntries

listDbHomePatchHistoryEntriesRecordIterator

listDbHomePatchHistoryEntriesResponseIterator

listDbHomePatches

listDbHomePatchesRecordIterator

  • Creates a new async iterator which will iterate over the models.PatchSummary objects contained in responses from the listDbHomePatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchSummary>

listDbHomePatchesResponseIterator

listDbHomes

  • Lists the Database Homes in the specified DB system and compartment. A Database Home is a directory where Oracle Database software is installed.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDbHomes API.

    Parameters

    Returns Promise<ListDbHomesResponse>

    ListDbHomesResponse

listDbHomesRecordIterator

  • Creates a new async iterator which will iterate over the models.DbHomeSummary objects contained in responses from the listDbHomes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbHomeSummary>

listDbHomesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listDbHomes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbHomesResponse>

listDbNodes

  • Lists the database nodes in the specified DB system and compartment. A database node is a server running database software.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDbNodes API.

    Parameters

    Returns Promise<ListDbNodesResponse>

    ListDbNodesResponse

listDbNodesRecordIterator

  • Creates a new async iterator which will iterate over the models.DbNodeSummary objects contained in responses from the listDbNodes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbNodeSummary>

listDbNodesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listDbNodes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDbNodesResponse>

listDbServers

  • Lists the Exadata DB servers in the ExadataInfrastructureId and specified compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDbServers API.

    Parameters

    Returns Promise<ListDbServersResponse>

    ListDbServersResponse

listDbServersRecordIterator

  • Creates a new async iterator which will iterate over the models.DbServerSummary objects contained in responses from the listDbServers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbServerSummary>

listDbServersResponseIterator

listDbSystemComputePerformances

listDbSystemPatchHistoryEntries

listDbSystemPatchHistoryEntriesRecordIterator

listDbSystemPatchHistoryEntriesResponseIterator

listDbSystemPatches

listDbSystemPatchesRecordIterator

  • Creates a new async iterator which will iterate over the models.PatchSummary objects contained in responses from the listDbSystemPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchSummary>

listDbSystemPatchesResponseIterator

listDbSystemShapes

  • Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDbSystemShapes API.

    Parameters

    Returns Promise<ListDbSystemShapesResponse>

    ListDbSystemShapesResponse

listDbSystemShapesRecordIterator

  • Creates a new async iterator which will iterate over the models.DbSystemShapeSummary objects contained in responses from the listDbSystemShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbSystemShapeSummary>

listDbSystemShapesResponseIterator

listDbSystemStoragePerformances

listDbSystemUpgradeHistoryEntries

listDbSystemUpgradeHistoryEntriesRecordIterator

listDbSystemUpgradeHistoryEntriesResponseIterator

listDbSystems

  • Lists the DB systems in the specified compartment. You can specify a backupId to list only the DB systems that support creating a database using this backup in this compartment.

    *Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.

    For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDbSystems API.

    Parameters

    Returns Promise<ListDbSystemsResponse>

    ListDbSystemsResponse

listDbSystemsRecordIterator

  • Creates a new async iterator which will iterate over the models.DbSystemSummary objects contained in responses from the listDbSystems operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbSystemSummary>

listDbSystemsResponseIterator

listDbVersions

listDbVersionsRecordIterator

  • Creates a new async iterator which will iterate over the models.DbVersionSummary objects contained in responses from the listDbVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DbVersionSummary>

listDbVersionsResponseIterator

listExadataInfrastructures

  • Lists the Exadata infrastructure resources in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the Exadata Cloud Service infrastructure resources in a compartment, use the {@link #listCloudExadataInfrastructures(ListCloudExadataInfrastructuresRequest) listCloudExadataInfrastructures} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListExadataInfrastructures API.

    Parameters

    Returns Promise<ListExadataInfrastructuresResponse>

    ListExadataInfrastructuresResponse

listExadataInfrastructuresRecordIterator

listExadataInfrastructuresResponseIterator

listExternalContainerDatabases

listExternalContainerDatabasesRecordIterator

listExternalContainerDatabasesResponseIterator

listExternalDatabaseConnectors

listExternalDatabaseConnectorsRecordIterator

listExternalDatabaseConnectorsResponseIterator

listExternalNonContainerDatabases

listExternalNonContainerDatabasesRecordIterator

listExternalNonContainerDatabasesResponseIterator

listExternalPluggableDatabases

  • Gets a list of the {@link #createExternalPluggableDatabaseDetails(CreateExternalPluggableDatabaseDetailsRequest) createExternalPluggableDatabaseDetails} resources in the specified compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListExternalPluggableDatabases API.

    Parameters

    Returns Promise<ListExternalPluggableDatabasesResponse>

    ListExternalPluggableDatabasesResponse

listExternalPluggableDatabasesRecordIterator

listExternalPluggableDatabasesResponseIterator

listFlexComponents

  • Gets a list of the flex components that can be used to launch a new DB system. The flex component determines resources to allocate to the DB system - Database Servers and Storage Servers. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFlexComponents API.

    Parameters

    Returns Promise<ListFlexComponentsResponse>

    ListFlexComponentsResponse

listGiVersions

  • Gets a list of supported GI versions for the Exadata Cloud@Customer VM cluster. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListGiVersions API.

    Parameters

    Returns Promise<ListGiVersionsResponse>

    ListGiVersionsResponse

listGiVersionsRecordIterator

  • Creates a new async iterator which will iterate over the models.GiVersionSummary objects contained in responses from the listGiVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GiVersionSummary>

listGiVersionsResponseIterator

listKeyStores

  • Gets a list of key stores in the specified compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListKeyStores API.

    Parameters

    Returns Promise<ListKeyStoresResponse>

    ListKeyStoresResponse

listKeyStoresRecordIterator

  • Creates a new async iterator which will iterate over the models.KeyStoreSummary objects contained in responses from the listKeyStores operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<KeyStoreSummary>

listKeyStoresResponseIterator

listMaintenanceRunHistory

listMaintenanceRunHistoryRecordIterator

listMaintenanceRunHistoryResponseIterator

listMaintenanceRuns

listMaintenanceRunsRecordIterator

  • Creates a new async iterator which will iterate over the models.MaintenanceRunSummary objects contained in responses from the listMaintenanceRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<MaintenanceRunSummary>

listMaintenanceRunsResponseIterator

listOneoffPatches

listOneoffPatchesRecordIterator

  • Creates a new async iterator which will iterate over the models.OneoffPatchSummary objects contained in responses from the listOneoffPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<OneoffPatchSummary>

listOneoffPatchesResponseIterator

listPdbConversionHistoryEntries

listPdbConversionHistoryEntriesRecordIterator

listPdbConversionHistoryEntriesResponseIterator

listPluggableDatabases

  • Gets a list of the pluggable databases in a database or compartment. You must provide either a databaseId or compartmentId value.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPluggableDatabases API.

    Parameters

    Returns Promise<ListPluggableDatabasesResponse>

    ListPluggableDatabasesResponse

listPluggableDatabasesRecordIterator

listPluggableDatabasesResponseIterator

listSystemVersions

  • Gets a list of supported Exadata system versions for a given shape and GI version. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSystemVersions API.

    Parameters

    Returns Promise<ListSystemVersionsResponse>

    ListSystemVersionsResponse

listVmClusterNetworks

  • Gets a list of the VM cluster networks in the specified compartment. Applies to Exadata Cloud@Customer instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVmClusterNetworks API.

    Parameters

    Returns Promise<ListVmClusterNetworksResponse>

    ListVmClusterNetworksResponse

listVmClusterNetworksRecordIterator

  • Creates a new async iterator which will iterate over the models.VmClusterNetworkSummary objects contained in responses from the listVmClusterNetworks operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VmClusterNetworkSummary>

listVmClusterNetworksResponseIterator

listVmClusterPatchHistoryEntries

listVmClusterPatchHistoryEntriesRecordIterator

listVmClusterPatchHistoryEntriesResponseIterator

listVmClusterPatches

  • Lists the patches applicable to the specified VM cluster in an Exadata Cloud@Customer system.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVmClusterPatches API.

    Parameters

    Returns Promise<ListVmClusterPatchesResponse>

    ListVmClusterPatchesResponse

listVmClusterPatchesRecordIterator

  • Creates a new async iterator which will iterate over the models.PatchSummary objects contained in responses from the listVmClusterPatches operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PatchSummary>

listVmClusterPatchesResponseIterator

listVmClusterUpdateHistoryEntries

listVmClusterUpdateHistoryEntriesRecordIterator

listVmClusterUpdateHistoryEntriesResponseIterator

listVmClusterUpdates

  • Lists the maintenance updates that can be applied to the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVmClusterUpdates API.

    Parameters

    Returns Promise<ListVmClusterUpdatesResponse>

    ListVmClusterUpdatesResponse

listVmClusterUpdatesRecordIterator

  • Creates a new async iterator which will iterate over the models.VmClusterUpdateSummary objects contained in responses from the listVmClusterUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VmClusterUpdateSummary>

listVmClusterUpdatesResponseIterator

listVmClusters

  • Lists the VM clusters in the specified compartment. Applies to Exadata Cloud@Customer instances only. To list the cloud VM clusters in an Exadata Cloud Service instance, use the {@link #listCloudVmClusters(ListCloudVmClustersRequest) listCloudVmClusters} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVmClusters API.

    Parameters

    Returns Promise<ListVmClustersResponse>

    ListVmClustersResponse

listVmClustersRecordIterator

  • Creates a new async iterator which will iterate over the models.VmClusterSummary objects contained in responses from the listVmClusters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VmClusterSummary>

listVmClustersResponseIterator

localClonePluggableDatabase

  • Deprecated. Use {@link #createPluggableDatabase(CreatePluggableDatabaseRequest) createPluggableDatabase} for Pluggable Database LocalClone Operation. Clones and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in the READ_WRITE openMode to perform the clone operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use LocalClonePluggableDatabase API.

    Parameters

    Returns Promise<LocalClonePluggableDatabaseResponse>

    LocalClonePluggableDatabaseResponse

migrateExadataDbSystemResourceModel

migrateVaultKey

modifyDatabaseManagement

modifyPluggableDatabaseManagement

refreshPluggableDatabase

registerAutonomousDatabaseDataSafe

reinstateAutonomousContainerDatabaseDataguardAssociation

reinstateDataGuardAssociation

remoteClonePluggableDatabase

  • Deprecated. Use {@link #createPluggableDatabase(CreatePluggableDatabaseRequest) createPluggableDatabase} for Pluggable Database RemoteClone Operation. Clones a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in the READ_WRITE openMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoteClonePluggableDatabase API.

    Parameters

    Returns Promise<RemoteClonePluggableDatabaseResponse>

    RemoteClonePluggableDatabaseResponse

removeVirtualMachineFromCloudVmCluster

removeVirtualMachineFromVmCluster

resizeVmClusterNetwork

  • Adds or removes Db server network nodes to extend or shrink the existing VM cluster network. Applies to Exadata Cloud@Customer instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ResizeVmClusterNetwork API.

    Parameters

    Returns Promise<ResizeVmClusterNetworkResponse>

    ResizeVmClusterNetworkResponse

resourcePoolShapes

restartAutonomousContainerDatabase

restartAutonomousDatabase

restoreAutonomousDatabase

restoreDatabase

  • Restore a Database based on the request parameters you provide.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RestoreDatabase API.

    Parameters

    Returns Promise<RestoreDatabaseResponse>

    RestoreDatabaseResponse

rotateAutonomousContainerDatabaseEncryptionKey

rotateAutonomousDatabaseEncryptionKey

rotateAutonomousVmClusterOrdsCerts

rotateAutonomousVmClusterSslCerts

rotateCloudAutonomousVmClusterOrdsCerts

rotateCloudAutonomousVmClusterSslCerts

rotateOrdsCerts

  • Deprecated. Use the {@link #rotateCloudAutonomousVmClusterOrdsCerts(RotateCloudAutonomousVmClusterOrdsCertsRequest) rotateCloudAutonomousVmClusterOrdsCerts} to rotate Oracle REST Data Services (ORDS) certs for an Autonomous Exadata VM cluster instead.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RotateOrdsCerts API.

    Parameters

    Returns Promise<RotateOrdsCertsResponse>

    RotateOrdsCertsResponse

rotatePluggableDatabaseEncryptionKey

rotateSslCerts

  • Deprecated. Use the {@link #rotateCloudAutonomousVmClusterSslCerts(RotateCloudAutonomousVmClusterSslCertsRequest) rotateCloudAutonomousVmClusterSslCerts} to rotate SSL certs for an Autonomous Exadata VM cluster instead.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RotateSslCerts API.

    Parameters

    Returns Promise<RotateSslCertsResponse>

    RotateSslCertsResponse

rotateVaultKey

saasAdminUserStatus

  • This operation gets SaaS administrative user status of the Autonomous Database. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SaasAdminUserStatus API.

    Parameters

    Returns Promise<SaasAdminUserStatusResponse>

    SaasAdminUserStatusResponse

scanExternalContainerDatabasePluggableDatabases

shrinkAutonomousDatabase

  • This operation shrinks the current allocated storage down to the current actual used data storage (actualUsedDataStorageSizeInTBs). The if the base storage value for the database (dataStorageSizeInTBs) is larger than the actualUsedDataStorageSizeInTBs value, you are billed for the base storage value.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ShrinkAutonomousDatabase API.

    Parameters

    Returns Promise<ShrinkAutonomousDatabaseResponse>

    ShrinkAutonomousDatabaseResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startAutonomousDatabase

startPluggableDatabase

  • Starts a stopped pluggable database. The openMode value of the pluggable database will be READ_WRITE upon completion. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StartPluggableDatabase API.

    Parameters

    Returns Promise<StartPluggableDatabaseResponse>

    StartPluggableDatabaseResponse

stopAutonomousDatabase

stopPluggableDatabase

  • Stops a pluggable database. The openMode value of the pluggable database will be MOUNTED upon completion. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StopPluggableDatabase API.

    Parameters

    Returns Promise<StopPluggableDatabaseResponse>

    StopPluggableDatabaseResponse

switchoverAutonomousContainerDatabaseDataguardAssociation

  • Switches over the primary Autonomous Container Database of an Autonomous Data Guard peer association to standby role. The standby Autonomous Container Database associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary Autonomous Container Database role.

    A switchover incurs no data loss.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SwitchoverAutonomousContainerDatabaseDataguardAssociation API.

    Parameters

    Returns Promise<SwitchoverAutonomousContainerDatabaseDataguardAssociationResponse>

    SwitchoverAutonomousContainerDatabaseDataguardAssociationResponse

switchoverAutonomousDatabase

  • Initiates a switchover of the specified Autonomous Database to the associated peer database. Applicable only to databases with Disaster Recovery enabled. This API should be called in the remote region where the peer database resides. Below parameter is optional:

    • peerDbId Use this parameter to specify the database OCID of the Disaster Recovery peer, which is located in a different (remote) region from the current peer database. If this parameter is not provided, the switchover will happen in the same region.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SwitchoverAutonomousDatabase API.

    Parameters

    Returns Promise<SwitchoverAutonomousDatabaseResponse>

    SwitchoverAutonomousDatabaseResponse

switchoverDataGuardAssociation

  • Performs a switchover to transition the primary database of a Data Guard association into a standby role. The standby database associated with the dataGuardAssociationId assumes the primary database role.

    A switchover guarantees no data loss.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SwitchoverDataGuardAssociation API.

    Parameters

    Returns Promise<SwitchoverDataGuardAssociationResponse>

    SwitchoverDataGuardAssociationResponse

terminateAutonomousContainerDatabase

  • Terminates an Autonomous Container Database, which permanently deletes the container database and any databases within the container database. The database data is local to the Autonomous Exadata Infrastructure and will be lost when the container database is terminated. Oracle recommends that you back up any data in the Autonomous Container Database prior to terminating it. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use TerminateAutonomousContainerDatabase API.

    Parameters

    Returns Promise<TerminateAutonomousContainerDatabaseResponse>

    TerminateAutonomousContainerDatabaseResponse

terminateAutonomousExadataInfrastructure

  • Deprecated. To terminate an Exadata Infrastructure resource in the Oracle cloud, use the {@link #deleteCloudExadataInfrastructure(DeleteCloudExadataInfrastructureRequest) deleteCloudExadataInfrastructure} operation. To delete an Autonomous Exadata VM cluster in the Oracle cloud, use the {@link #deleteCloudAutonomousVmCluster(DeleteCloudAutonomousVmClusterRequest) deleteCloudAutonomousVmCluster} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use TerminateAutonomousExadataInfrastructure API.

    Parameters

    Returns Promise<TerminateAutonomousExadataInfrastructureResponse>

    TerminateAutonomousExadataInfrastructureResponse

terminateDbSystem

  • Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it.

    *Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.

    For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use TerminateDbSystem API.

    Parameters

    Returns Promise<TerminateDbSystemResponse>

    TerminateDbSystemResponse

updateAutonomousContainerDatabase

updateAutonomousContainerDatabaseDataguardAssociation

updateAutonomousDatabase

  • Updates one or more attributes of the specified Autonomous Database. See the UpdateAutonomousDatabaseDetails resource for a full list of attributes that can be updated.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAutonomousDatabase API.

    Parameters

    Returns Promise<UpdateAutonomousDatabaseResponse>

    UpdateAutonomousDatabaseResponse

updateAutonomousDatabaseBackup

updateAutonomousDatabaseRegionalWallet

updateAutonomousDatabaseSoftwareImage

updateAutonomousDatabaseWallet

updateAutonomousExadataInfrastructure

  • Deprecated. Use the {@link #updateCloudExadataInfrastructure(UpdateCloudExadataInfrastructureRequest) updateCloudExadataInfrastructure} operation to update an Exadata Infrastructure resource and {@link #updateCloudAutonomousVmCluster(UpdateCloudAutonomousVmClusterRequest) updateCloudAutonomousVmCluster} operation to update an Autonomous Exadata VM cluster.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAutonomousExadataInfrastructure API.

    Parameters

    Returns Promise<UpdateAutonomousExadataInfrastructureResponse>

    UpdateAutonomousExadataInfrastructureResponse

updateAutonomousVmCluster

  • Updates the specified Autonomous VM cluster for the Exadata Cloud@Customer system.To update an Autonomous VM Cluster in the Oracle cloud, see {@link #updateCloudAutonomousVmCluster(UpdateCloudAutonomousVmClusterRequest) updateCloudAutonomousVmCluster}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAutonomousVmCluster API.

    Parameters

    Returns Promise<UpdateAutonomousVmClusterResponse>

    UpdateAutonomousVmClusterResponse

updateBackupDestination

  • If no database is associated with the backup destination:

    • For a RECOVERY_APPLIANCE backup destination, updates the connection string and/or the list of VPC users.
    • For an NFS backup destination, updates the NFS location.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateBackupDestination API.

    Parameters

    Returns Promise<UpdateBackupDestinationResponse>

    UpdateBackupDestinationResponse

updateCloudAutonomousVmCluster

  • Updates the specified Autonomous Exadata VM cluster in the Oracle cloud. For Exadata Cloud@Customer systems, see {@link #updateAutonomousVmCluster(UpdateAutonomousVmClusterRequest) updateAutonomousVmCluster}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCloudAutonomousVmCluster API.

    Parameters

    Returns Promise<UpdateCloudAutonomousVmClusterResponse>

    UpdateCloudAutonomousVmClusterResponse

updateCloudExadataInfrastructure

  • Updates the Cloud Exadata infrastructure resource. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCloudExadataInfrastructure API.

    Parameters

    Returns Promise<UpdateCloudExadataInfrastructureResponse>

    UpdateCloudExadataInfrastructureResponse

updateCloudVmCluster

  • Updates the specified cloud VM cluster. Applies to Exadata Cloud Service instances and Autonomous Database on dedicated Exadata infrastructure only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCloudVmCluster API.

    Parameters

    Returns Promise<UpdateCloudVmClusterResponse>

    UpdateCloudVmClusterResponse

updateCloudVmClusterIormConfig

updateConsoleConnection

updateConsoleHistory

updateDataGuardAssociation

  • Updates the Data Guard association the specified database. This API can be used to change the protectionMode and transportType of the Data Guard association.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDataGuardAssociation API.

    Parameters

    Returns Promise<UpdateDataGuardAssociationResponse>

    UpdateDataGuardAssociationResponse

updateDatabase

  • Update the specified database based on the request parameters provided.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDatabase API.

    Parameters

    Returns Promise<UpdateDatabaseResponse>

    UpdateDatabaseResponse

updateDatabaseSoftwareImage

updateDbHome

updateDbNode

updateDbSystem

  • Updates the properties of the specified DB system.

    *Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.

    For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDbSystem API.

    Parameters

    Returns Promise<UpdateDbSystemResponse>

    UpdateDbSystemResponse

updateExadataInfrastructure

  • Updates the Exadata infrastructure resource. Applies to Exadata Cloud@Customer instances only. To update an Exadata Cloud Service infrastructure resource, use the {@link #updateCloudExadataInfrastructure(UpdateCloudExadataInfrastructureRequest) updateCloudExadataInfrastructure} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateExadataInfrastructure API.

    Parameters

    Returns Promise<UpdateExadataInfrastructureResponse>

    UpdateExadataInfrastructureResponse

updateExadataIormConfig

  • Updates IORM settings for the specified Exadata DB system.

    *Note:** Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.

    For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.

    The {@link #updateCloudVmClusterIormConfig(UpdateCloudVmClusterIormConfigRequest) updateCloudVmClusterIormConfig} API is used for Exadata systems using the new resource model.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateExadataIormConfig API.

    Parameters

    Returns Promise<UpdateExadataIormConfigResponse>

    UpdateExadataIormConfigResponse

updateExternalContainerDatabase

  • Updates the properties of an {@link #createExternalContainerDatabaseDetails(CreateExternalContainerDatabaseDetailsRequest) createExternalContainerDatabaseDetails} resource, such as the display name.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateExternalContainerDatabase API.

    Parameters

    Returns Promise<UpdateExternalContainerDatabaseResponse>

    UpdateExternalContainerDatabaseResponse

updateExternalDatabaseConnector

updateExternalNonContainerDatabase

updateExternalPluggableDatabase

  • Updates the properties of an {@link #createExternalPluggableDatabaseDetails(CreateExternalPluggableDatabaseDetailsRequest) createExternalPluggableDatabaseDetails} resource, such as the display name.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateExternalPluggableDatabase API.

    Parameters

    Returns Promise<UpdateExternalPluggableDatabaseResponse>

    UpdateExternalPluggableDatabaseResponse

updateKeyStore

  • If no database is associated with the key store, edit the key store.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateKeyStore API.

    Parameters

    Returns Promise<UpdateKeyStoreResponse>

    UpdateKeyStoreResponse

updateMaintenanceRun

  • Updates the properties of a maintenance run, such as the state of a maintenance run. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateMaintenanceRun API.

    Parameters

    Returns Promise<UpdateMaintenanceRunResponse>

    UpdateMaintenanceRunResponse

updateOneoffPatch

updatePluggableDatabase

updateVmCluster

  • Updates the specified VM cluster. Applies to Exadata Cloud@Customer instances only.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateVmCluster API.

    Parameters

    Returns Promise<UpdateVmClusterResponse>

    UpdateVmClusterResponse

updateVmClusterNetwork

  • Updates the specified VM cluster network. Applies to Exadata Cloud@Customer instances only. To update a cloud VM cluster in an Exadata Cloud Service instance, use the {@link #updateCloudVmCluster(UpdateCloudVmClusterRequest) updateCloudVmCluster} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateVmClusterNetwork API.

    Parameters

    Returns Promise<UpdateVmClusterNetworkResponse>

    UpdateVmClusterNetworkResponse

upgradeDatabase

upgradeDbSystem

  • Upgrades the operating system and grid infrastructure of the DB system.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpgradeDbSystem API.

    Parameters

    Returns Promise<UpgradeDbSystemResponse>

    UpgradeDbSystemResponse

validateVmClusterNetwork