Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GoldenGateClient

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

  • GoldenGateClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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

targetService

targetService: string = "GoldenGate"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://goldengate.{region}.oci.{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

addConnectionLock

  • Adds a lock to a Connection resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddConnectionLock API.

    Parameters

    Returns Promise<AddConnectionLockResponse>

    AddConnectionLockResponse

addDeploymentBackupLock

addDeploymentLock

  • Adds a lock to a Deployment resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddDeploymentLock API.

    Parameters

    Returns Promise<AddDeploymentLockResponse>

    AddDeploymentLockResponse

cancelDeploymentBackup

cancelDeploymentUpgrade

  • Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelDeploymentUpgrade API.

    Parameters

    Returns Promise<CancelDeploymentUpgradeResponse>

    CancelDeploymentUpgradeResponse

cancelSnoozeDeploymentUpgrade

  • Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelSnoozeDeploymentUpgrade API.

    Parameters

    Returns Promise<CancelSnoozeDeploymentUpgradeResponse>

    CancelSnoozeDeploymentUpgradeResponse

changeConnectionCompartment

changeDatabaseRegistrationCompartment

changeDeploymentBackupCompartment

changeDeploymentCompartment

close

  • close(): void

collectDeploymentDiagnostic

  • Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CollectDeploymentDiagnostic API.

    Parameters

    Returns Promise<CollectDeploymentDiagnosticResponse>

    CollectDeploymentDiagnosticResponse

copyDeploymentBackup

createCertificate

  • Creates a new certificate to truststore.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCertificate API.

    Parameters

    Returns Promise<CreateCertificateResponse>

    CreateCertificateResponse

createConnection

createConnectionAssignment

createDatabaseRegistration

  • Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDatabaseRegistration API.

    Parameters

    Returns Promise<CreateDatabaseRegistrationResponse>

    CreateDatabaseRegistrationResponse

createDeployment

createDeploymentBackup

createWaiters

  • Creates a new GoldenGateWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns GoldenGateWaiter

    The service waiters.

deleteCertificate

  • Deletes the certificate from truststore.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCertificate API.

    Parameters

    Returns Promise<DeleteCertificateResponse>

    DeleteCertificateResponse

deleteConnection

deleteConnectionAssignment

deleteDatabaseRegistration

  • Note: Deprecated. Use the /connections API instead. Deletes a DatabaseRegistration.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDatabaseRegistration API.

    Parameters

    Returns Promise<DeleteDatabaseRegistrationResponse>

    DeleteDatabaseRegistrationResponse

deleteDeployment

deleteDeploymentBackup

deploymentWalletExists

  • Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeploymentWalletExists API.

    Parameters

    Returns Promise<DeploymentWalletExistsResponse>

    DeploymentWalletExistsResponse

exportDeploymentWallet

  • Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ExportDeploymentWallet API.

    Parameters

    Returns Promise<ExportDeploymentWalletResponse>

    ExportDeploymentWalletResponse

generateLibraryUrl

  • Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GenerateLibraryUrl API.

    Parameters

    Returns Promise<GenerateLibraryUrlResponse>

    GenerateLibraryUrlResponse

getCertificate

  • Retrieves a Certificate.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCertificate API.

    Parameters

    Returns Promise<GetCertificateResponse>

    GetCertificateResponse

getConnection

  • Retrieves a Connection.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConnection API.

    Parameters

    Returns Promise<GetConnectionResponse>

    GetConnectionResponse

getConnectionAssignment

getDatabaseRegistration

  • Note: Deprecated. Use the /connections API instead. Retrieves a DatabaseRegistration.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDatabaseRegistration API.

    Parameters

    Returns Promise<GetDatabaseRegistrationResponse>

    GetDatabaseRegistrationResponse

getDeployment

  • Retrieves a deployment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDeployment API.

    Parameters

    Returns Promise<GetDeploymentResponse>

    GetDeploymentResponse

getDeploymentBackup

getDeploymentUpgrade

getWaiters

getWorkRequest

  • Retrieve the WorkRequest identified by the given OCID.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

importDeploymentWallet

  • Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ImportDeploymentWallet API.

    Parameters

    Returns Promise<ImportDeploymentWalletResponse>

    ImportDeploymentWalletResponse

listAllWorkRequestErrors

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

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

    Parameters

    Returns AsyncIterableIterator<WorkRequest>

listAllWorkRequestsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listCertificates

  • Returns a list of certificates from truststore. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCertificates API.

    Parameters

    Returns Promise<ListCertificatesResponse>

    ListCertificatesResponse

listConnectionAssignments

listConnections

  • Lists the Connections in the compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListConnections API.

    Parameters

    Returns Promise<ListConnectionsResponse>

    ListConnectionsResponse

listDatabaseRegistrations

  • Note: Deprecated. Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDatabaseRegistrations API.

    Parameters

    Returns Promise<ListDatabaseRegistrationsResponse>

    ListDatabaseRegistrationsResponse

listDeploymentBackups

listDeploymentTypes

listDeploymentUpgrades

listDeploymentVersions

listDeploymentWalletsOperations

listDeployments

  • Lists the Deployments in a compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDeployments API.

    Parameters

    Returns Promise<ListDeploymentsResponse>

    ListDeploymentsResponse

listMessages

  • Lists the DeploymentMessages for a deployment. The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMessages API.

    Parameters

    Returns Promise<ListMessagesResponse>

    ListMessagesResponse

listTrailFiles

  • Lists the TrailFiles for a deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTrailFiles API.

    Parameters

    Returns Promise<ListTrailFilesResponse>

    ListTrailFilesResponse

listTrailSequences

  • Lists the Trail Sequences for a TrailFile in a given deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTrailSequences API.

    Parameters

    Returns Promise<ListTrailSequencesResponse>

    ListTrailSequencesResponse

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listWorkRequestLogsResponseIterator

listWorkRequests

  • Lists the work requests in the compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

listWorkRequestsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequest>

listWorkRequestsResponseIterator

removeConnectionLock

removeDeploymentBackupLock

removeDeploymentLock

rescheduleDeploymentUpgrade

  • Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RescheduleDeploymentUpgrade API.

    Parameters

    Returns Promise<RescheduleDeploymentUpgradeResponse>

    RescheduleDeploymentUpgradeResponse

restoreDeployment

  • Restores a Deployment from a Deployment Backup created from the same Deployment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RestoreDeployment API.

    Parameters

    Returns Promise<RestoreDeploymentResponse>

    RestoreDeploymentResponse

rollbackDeploymentUpgrade

  • Rollback a deployment to it's previous version. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RollbackDeploymentUpgrade API.

    Parameters

    Returns Promise<RollbackDeploymentUpgradeResponse>

    RollbackDeploymentUpgradeResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

snoozeDeploymentUpgrade

  • Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SnoozeDeploymentUpgrade API.

    Parameters

    Returns Promise<SnoozeDeploymentUpgradeResponse>

    SnoozeDeploymentUpgradeResponse

startDeployment

  • Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StartDeployment API.

    Parameters

    Returns Promise<StartDeploymentResponse>

    StartDeploymentResponse

stopDeployment

  • Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use StopDeployment API.

    Parameters

    Returns Promise<StopDeploymentResponse>

    StopDeploymentResponse

testConnectionAssignment

  • Tests the connectivity between given GoldenGate deployment and one of the associated database / service. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use TestConnectionAssignment API.

    Parameters

    Returns Promise<TestConnectionAssignmentResponse>

    TestConnectionAssignmentResponse

updateConnection

updateDatabaseRegistration

  • Note: Deprecated. Use the /connections API instead. Updates the DatabaseRegistration.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDatabaseRegistration API.

    Parameters

    Returns Promise<UpdateDatabaseRegistrationResponse>

    UpdateDatabaseRegistrationResponse

updateDeployment

updateDeploymentBackup

upgradeDeployment

  • Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpgradeDeployment API.

    Parameters

    Returns Promise<UpgradeDeploymentResponse>

    UpgradeDeploymentResponse

upgradeDeploymentUpgrade

  • Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpgradeDeploymentUpgrade API.

    Parameters

    Returns Promise<UpgradeDeploymentUpgradeResponse>

    UpgradeDeploymentUpgradeResponse