Class GoldenGateClient

Service client instance for GoldenGate.

Inheritance

object

ClientBase

RegionalClientBase

GoldenGateClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GoldengateService

Assembly: OCI.DotNetSDK.Goldengate.dll

Syntax

public class GoldenGateClient : RegionalClientBase, IDisposable

Constructors

GoldenGateClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public GoldenGateClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public GoldenGatePaginators Paginators { get; }

Property Value

Type	Description
GoldenGatePaginators

Waiters

Declaration

public GoldenGateWaiters Waiters { get; }

Property Value

Type	Description
GoldenGateWaiters

Methods

AddConnectionLock(AddConnectionLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a lock to a Connection resource.

Declaration

public Task<AddConnectionLockResponse> AddConnectionLock(AddConnectionLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddConnectionLockRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AddConnectionLockResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddConnectionLock API.

AddDeploymentBackupLock(AddDeploymentBackupLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a lock to a DeploymentBackup resource.

Declaration

public Task<AddDeploymentBackupLockResponse> AddDeploymentBackupLock(AddDeploymentBackupLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddDeploymentBackupLockRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AddDeploymentBackupLockResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddDeploymentBackupLock API.

AddDeploymentLocalPeer(AddDeploymentLocalPeerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a new local peer to the deployment, this will add the given placement to deployment placement attribute. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<AddDeploymentLocalPeerResponse> AddDeploymentLocalPeer(AddDeploymentLocalPeerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddDeploymentLocalPeerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AddDeploymentLocalPeerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddDeploymentLocalPeer API.

AddDeploymentLock(AddDeploymentLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a lock to a Deployment resource.

Declaration

public Task<AddDeploymentLockResponse> AddDeploymentLock(AddDeploymentLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddDeploymentLockRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AddDeploymentLockResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddDeploymentLock API.

CancelDeploymentBackup(CancelDeploymentBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a Deployment Backup creation process.

Declaration

public Task<CancelDeploymentBackupResponse> CancelDeploymentBackup(CancelDeploymentBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelDeploymentBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CancelDeploymentBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelDeploymentBackup API.

CancelDeploymentUpgrade(CancelDeploymentUpgradeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<CancelDeploymentUpgradeResponse> CancelDeploymentUpgrade(CancelDeploymentUpgradeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelDeploymentUpgradeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CancelDeploymentUpgradeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelDeploymentUpgrade API.

CancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<CancelSnoozeDeploymentUpgradeResponse> CancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelSnoozeDeploymentUpgradeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CancelSnoozeDeploymentUpgradeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelSnoozeDeploymentUpgrade API.

ChangeConnectionCompartment(ChangeConnectionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the Connection into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Declaration

public Task<ChangeConnectionCompartmentResponse> ChangeConnectionCompartment(ChangeConnectionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeConnectionCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeConnectionCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeConnectionCompartment API.

ChangeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Note: Deprecated. Use the /connections API instead. Moves the DatabaseRegistration into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Declaration

public Task<ChangeDatabaseRegistrationCompartmentResponse> ChangeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDatabaseRegistrationCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeDatabaseRegistrationCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDatabaseRegistrationCompartment API.

ChangeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a DeploymentBackup into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Declaration

public Task<ChangeDeploymentBackupCompartmentResponse> ChangeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDeploymentBackupCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeDeploymentBackupCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDeploymentBackupCompartment API.

ChangeDeploymentCompartment(ChangeDeploymentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the Deployment into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Declaration

public Task<ChangeDeploymentCompartmentResponse> ChangeDeploymentCompartment(ChangeDeploymentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDeploymentCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeDeploymentCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDeploymentCompartment API.

ChangePipelineCompartment(ChangePipelineCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the Pipeline into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Declaration

public Task<ChangePipelineCompartmentResponse> ChangePipelineCompartment(ChangePipelineCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangePipelineCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangePipelineCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangePipelineCompartment API.

CollectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<CollectDeploymentDiagnosticResponse> CollectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CollectDeploymentDiagnosticRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CollectDeploymentDiagnosticResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CollectDeploymentDiagnostic API.

CollectPipelineDiagnostic(CollectPipelineDiagnosticRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Collects diagnostics for the pipeline

Declaration

public Task<CollectPipelineDiagnosticResponse> CollectPipelineDiagnostic(CollectPipelineDiagnosticRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CollectPipelineDiagnosticRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CollectPipelineDiagnosticResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CollectPipelineDiagnostic API.

CopyDeploymentBackup(CopyDeploymentBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a copy of a Deployment Backup.

Declaration

public Task<CopyDeploymentBackupResponse> CopyDeploymentBackup(CopyDeploymentBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CopyDeploymentBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CopyDeploymentBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CopyDeploymentBackup API.

CreateCertificate(CreateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new certificate to truststore.

Declaration

public Task<CreateCertificateResponse> CreateCertificate(CreateCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateCertificate API.

CreateConnection(CreateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Connection.

Declaration

public Task<CreateConnectionResponse> CreateConnection(CreateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateConnection API.

CreateConnectionAssignment(CreateConnectionAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Connection Assignment.

Declaration

public Task<CreateConnectionAssignmentResponse> CreateConnectionAssignment(CreateConnectionAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateConnectionAssignmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateConnectionAssignmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateConnectionAssignment API.

CreateDatabaseRegistration(CreateDatabaseRegistrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<CreateDatabaseRegistrationResponse> CreateDatabaseRegistration(CreateDatabaseRegistrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDatabaseRegistrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDatabaseRegistrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDatabaseRegistration API.

CreateDeployment(CreateDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Deployment.

Declaration

public Task<CreateDeploymentResponse> CreateDeployment(CreateDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDeployment API.

CreateDeploymentBackup(CreateDeploymentBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new DeploymentBackup.

Declaration

public Task<CreateDeploymentBackupResponse> CreateDeploymentBackup(CreateDeploymentBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDeploymentBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDeploymentBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDeploymentBackup API.

CreatePipeline(CreatePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Pipeline.

Declaration

public Task<CreatePipelineResponse> CreatePipeline(CreatePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreatePipelineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreatePipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreatePipeline API.

DeleteCertificate(DeleteCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the certificate from truststore.

Declaration

public Task<DeleteCertificateResponse> DeleteCertificate(DeleteCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteCertificate API.

DeleteConnection(DeleteConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Connection.

Declaration

public Task<DeleteConnectionResponse> DeleteConnection(DeleteConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteConnection API.

DeleteConnectionAssignment(DeleteConnectionAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Connection Assignment.

Declaration

public Task<DeleteConnectionAssignmentResponse> DeleteConnectionAssignment(DeleteConnectionAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConnectionAssignmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteConnectionAssignmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteConnectionAssignment API.

DeleteDatabaseRegistration(DeleteDatabaseRegistrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<DeleteDatabaseRegistrationResponse> DeleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDatabaseRegistrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDatabaseRegistrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDatabaseRegistration API.

DeleteDeployment(DeleteDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the Deployment.

Declaration

public Task<DeleteDeploymentResponse> DeleteDeployment(DeleteDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDeployment API.

DeleteDeploymentBackup(DeleteDeploymentBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a DeploymentBackup.

Declaration

public Task<DeleteDeploymentBackupResponse> DeleteDeploymentBackup(DeleteDeploymentBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDeploymentBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDeploymentBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDeploymentBackup API.

DeletePipeline(DeletePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Pipeline.

Declaration

public Task<DeletePipelineResponse> DeletePipeline(DeletePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeletePipelineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeletePipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeletePipeline API.

DeploymentWalletExists(DeploymentWalletExistsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<DeploymentWalletExistsResponse> DeploymentWalletExists(DeploymentWalletExistsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeploymentWalletExistsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeploymentWalletExistsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeploymentWalletExists API.

ExportDeploymentWallet(ExportDeploymentWalletRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ExportDeploymentWalletResponse> ExportDeploymentWallet(ExportDeploymentWalletRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ExportDeploymentWalletRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ExportDeploymentWalletResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ExportDeploymentWallet API.

GenerateLibraryUrl(GenerateLibraryUrlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<GenerateLibraryUrlResponse> GenerateLibraryUrl(GenerateLibraryUrlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateLibraryUrlRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GenerateLibraryUrlResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GenerateLibraryUrl API.

GetCertificate(GetCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a Certificate.

Declaration

public Task<GetCertificateResponse> GetCertificate(GetCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCertificate API.

GetConnection(GetConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a Connection.

Declaration

public Task<GetConnectionResponse> GetConnection(GetConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetConnection API.

GetConnectionAssignment(GetConnectionAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a Connection Assignment.

Declaration

public Task<GetConnectionAssignmentResponse> GetConnectionAssignment(GetConnectionAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConnectionAssignmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetConnectionAssignmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetConnectionAssignment API.

GetDatabaseRegistration(GetDatabaseRegistrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetDatabaseRegistrationResponse> GetDatabaseRegistration(GetDatabaseRegistrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDatabaseRegistrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDatabaseRegistrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDatabaseRegistration API.

GetDeployment(GetDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a deployment.

Declaration

public Task<GetDeploymentResponse> GetDeployment(GetDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDeployment API.

GetDeploymentBackup(GetDeploymentBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a DeploymentBackup.

Declaration

public Task<GetDeploymentBackupResponse> GetDeploymentBackup(GetDeploymentBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDeploymentBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDeploymentBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDeploymentBackup API.

GetDeploymentUpgrade(GetDeploymentUpgradeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a deployment upgrade.

Declaration

public Task<GetDeploymentUpgradeResponse> GetDeploymentUpgrade(GetDeploymentUpgradeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDeploymentUpgradeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDeploymentUpgradeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDeploymentUpgrade API.

GetPipeline(GetPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a Pipeline details.

Declaration

public Task<GetPipelineResponse> GetPipeline(GetPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPipelineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetPipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPipeline API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieve the WorkRequest identified by the given OCID.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ImportDeploymentWallet(ImportDeploymentWalletRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ImportDeploymentWalletResponse> ImportDeploymentWallet(ImportDeploymentWalletRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ImportDeploymentWalletRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ImportDeploymentWalletResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ImportDeploymentWallet API.

ListCertificates(ListCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of certificates from truststore.

Declaration

public Task<ListCertificatesResponse> ListCertificates(ListCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListCertificatesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListCertificatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListCertificates API.

ListConnectionAssignments(ListConnectionAssignmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Connection Assignments in the compartment.

Declaration

public Task<ListConnectionAssignmentsResponse> ListConnectionAssignments(ListConnectionAssignmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConnectionAssignmentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListConnectionAssignmentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListConnectionAssignments API.

ListConnections(ListConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Connections in the compartment.

Declaration

public Task<ListConnectionsResponse> ListConnections(ListConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConnectionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListConnectionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListConnections API.

ListDatabaseRegistrations(ListDatabaseRegistrationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListDatabaseRegistrationsResponse> ListDatabaseRegistrations(ListDatabaseRegistrationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDatabaseRegistrationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDatabaseRegistrationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDatabaseRegistrations API.

ListDeploymentBackups(ListDeploymentBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Backups in a compartment.

Declaration

public Task<ListDeploymentBackupsResponse> ListDeploymentBackups(ListDeploymentBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDeploymentBackupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDeploymentBackupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDeploymentBackups API.

ListDeploymentEnvironments(ListDeploymentEnvironmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns an array of DeploymentEnvironmentDescriptor

Declaration

public Task<ListDeploymentEnvironmentsResponse> ListDeploymentEnvironments(ListDeploymentEnvironmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDeploymentEnvironmentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDeploymentEnvironmentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDeploymentEnvironments API.

ListDeploymentPeers(ListDeploymentPeersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the local and remote peers in a deployment.

Declaration

public Task<ListDeploymentPeersResponse> ListDeploymentPeers(ListDeploymentPeersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDeploymentPeersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDeploymentPeersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDeploymentPeers API.

ListDeploymentTypes(ListDeploymentTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns an array of DeploymentTypeDescriptor

Declaration

public Task<ListDeploymentTypesResponse> ListDeploymentTypes(ListDeploymentTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDeploymentTypesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDeploymentTypesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDeploymentTypes API.

ListDeploymentUpgrades(ListDeploymentUpgradesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Deployment Upgrades in a compartment.

Declaration

public Task<ListDeploymentUpgradesResponse> ListDeploymentUpgrades(ListDeploymentUpgradesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDeploymentUpgradesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDeploymentUpgradesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDeploymentUpgrades API.

ListDeploymentVersions(ListDeploymentVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the list of available deployment versions.

Declaration

public Task<ListDeploymentVersionsResponse> ListDeploymentVersions(ListDeploymentVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDeploymentVersionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDeploymentVersionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDeploymentVersions API.

ListDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the wallets export/import operations to/from a deployment.

Declaration

public Task<ListDeploymentWalletsOperationsResponse> ListDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDeploymentWalletsOperationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDeploymentWalletsOperationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDeploymentWalletsOperations API.

ListDeployments(ListDeploymentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Deployments in a compartment.

Declaration

public Task<ListDeploymentsResponse> ListDeployments(ListDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDeploymentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDeploymentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDeployments API.

ListMessages(ListMessagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ListMessagesResponse> ListMessages(ListMessagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMessagesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMessagesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMessages API.

ListPipelineInitializationSteps(ListPipelineInitializationStepsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a Pipeline recipe steps and its progress details.

Declaration

public Task<ListPipelineInitializationStepsResponse> ListPipelineInitializationSteps(ListPipelineInitializationStepsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPipelineInitializationStepsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPipelineInitializationStepsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPipelineInitializationSteps API.

ListPipelineRunningProcesses(ListPipelineRunningProcessesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a Pipeline's running replication process's status like Capture/Apply.

Declaration

public Task<ListPipelineRunningProcessesResponse> ListPipelineRunningProcesses(ListPipelineRunningProcessesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPipelineRunningProcessesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPipelineRunningProcessesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPipelineRunningProcesses API.

ListPipelineSchemaTables(ListPipelineSchemaTablesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.

Declaration

public Task<ListPipelineSchemaTablesResponse> ListPipelineSchemaTables(ListPipelineSchemaTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPipelineSchemaTablesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPipelineSchemaTablesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPipelineSchemaTables API.

ListPipelineSchemas(ListPipelineSchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns an array of schemas based on mapping rules for a pipeline.

Declaration

public Task<ListPipelineSchemasResponse> ListPipelineSchemas(ListPipelineSchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPipelineSchemasRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPipelineSchemasResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPipelineSchemas API.

ListPipelines(ListPipelinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Pipelines in the compartment.

Declaration

public Task<ListPipelinesResponse> ListPipelines(ListPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPipelinesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPipelinesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPipelines API.

ListRecipes(ListRecipesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns an array of Recipe Summary.

Declaration

public Task<ListRecipesResponse> ListRecipes(ListRecipesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListRecipesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListRecipesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListRecipes API.

ListTrailFiles(ListTrailFilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ListTrailFilesResponse> ListTrailFiles(ListTrailFilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTrailFilesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListTrailFilesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTrailFiles API.

ListTrailSequences(ListTrailSequencesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ListTrailSequencesResponse> ListTrailSequences(ListTrailSequencesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTrailSequencesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListTrailSequencesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTrailSequences API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists work request errors.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists work request logs.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in the compartment.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

RefreshConnection(RefreshConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refresh the external Connection attributes.

Declaration

public Task<RefreshConnectionResponse> RefreshConnection(RefreshConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RefreshConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RefreshConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RefreshConnection API.

RemoveConnectionLock(RemoveConnectionLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a lock from a Connection resource.

Declaration

public Task<RemoveConnectionLockResponse> RemoveConnectionLock(RemoveConnectionLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RemoveConnectionLockRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RemoveConnectionLockResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemoveConnectionLock API.

RemoveDeploymentBackupLock(RemoveDeploymentBackupLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a lock from a DeploymentBackup resource.

Declaration

public Task<RemoveDeploymentBackupLockResponse> RemoveDeploymentBackupLock(RemoveDeploymentBackupLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RemoveDeploymentBackupLockRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RemoveDeploymentBackupLockResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemoveDeploymentBackupLock API.

RemoveDeploymentLocalPeer(RemoveDeploymentLocalPeerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a local peer of the deployment, this will remove the given placement entry from the deployment placement attribute. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<RemoveDeploymentLocalPeerResponse> RemoveDeploymentLocalPeer(RemoveDeploymentLocalPeerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RemoveDeploymentLocalPeerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RemoveDeploymentLocalPeerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemoveDeploymentLocalPeer API.

RemoveDeploymentLock(RemoveDeploymentLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a lock from a Deployment resource.

Declaration

public Task<RemoveDeploymentLockResponse> RemoveDeploymentLock(RemoveDeploymentLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RemoveDeploymentLockRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RemoveDeploymentLockResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemoveDeploymentLock API.

RescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<RescheduleDeploymentUpgradeResponse> RescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RescheduleDeploymentUpgradeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RescheduleDeploymentUpgradeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RescheduleDeploymentUpgrade API.

RestoreDeployment(RestoreDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Restores a Deployment from a Deployment Backup created from the same Deployment.

Declaration

public Task<RestoreDeploymentResponse> RestoreDeployment(RestoreDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RestoreDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RestoreDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RestoreDeployment API.

RollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<RollbackDeploymentUpgradeResponse> RollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RollbackDeploymentUpgradeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RollbackDeploymentUpgradeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RollbackDeploymentUpgrade API.

SnoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<SnoozeDeploymentUpgradeResponse> SnoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SnoozeDeploymentUpgradeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SnoozeDeploymentUpgradeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SnoozeDeploymentUpgrade API.

StartDeployment(StartDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<StartDeploymentResponse> StartDeployment(StartDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StartDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StartDeployment API.

StartPipeline(StartPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts the pipeline for data replication.

Declaration

public Task<StartPipelineResponse> StartPipeline(StartPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartPipelineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StartPipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StartPipeline API.

StopDeployment(StopDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<StopDeploymentResponse> StopDeployment(StopDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StopDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StopDeployment API.

StopPipeline(StopPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops the pipeline for data replication.

Declaration

public Task<StopPipelineResponse> StopPipeline(StopPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopPipelineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StopPipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StopPipeline API.

SwitchoverDeploymentPeer(SwitchoverDeploymentPeerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Switchover to the selected standby peer, which can be a local placement or a standby deployment in different region. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<SwitchoverDeploymentPeerResponse> SwitchoverDeploymentPeer(SwitchoverDeploymentPeerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SwitchoverDeploymentPeerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SwitchoverDeploymentPeerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SwitchoverDeploymentPeer API.

TestConnectionAssignment(TestConnectionAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<TestConnectionAssignmentResponse> TestConnectionAssignment(TestConnectionAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
TestConnectionAssignmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<TestConnectionAssignmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use TestConnectionAssignment API.

TestPipelineConnection(TestPipelineConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Tests pipeline connections against pipeline to verify the connectivity. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<TestPipelineConnectionResponse> TestPipelineConnection(TestPipelineConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
TestPipelineConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<TestPipelineConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use TestPipelineConnection API.

UpdateConnection(UpdateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the Connection.

Declaration

public Task<UpdateConnectionResponse> UpdateConnection(UpdateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateConnection API.

UpdateDatabaseRegistration(UpdateDatabaseRegistrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateDatabaseRegistrationResponse> UpdateDatabaseRegistration(UpdateDatabaseRegistrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDatabaseRegistrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDatabaseRegistrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDatabaseRegistration API.

UpdateDeployment(UpdateDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies a Deployment.

Declaration

public Task<UpdateDeploymentResponse> UpdateDeployment(UpdateDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDeployment API.

UpdateDeploymentBackup(UpdateDeploymentBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies a Deployment Backup.

Declaration

public Task<UpdateDeploymentBackupResponse> UpdateDeploymentBackup(UpdateDeploymentBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDeploymentBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDeploymentBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDeploymentBackup API.

UpdatePipeline(UpdatePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the Pipeline.

Declaration

public Task<UpdatePipelineResponse> UpdatePipeline(UpdatePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdatePipelineRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdatePipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdatePipeline API.

UpgradeDeployment(UpgradeDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpgradeDeploymentResponse> UpgradeDeployment(UpgradeDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpgradeDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpgradeDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpgradeDeployment API.

UpgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpgradeDeploymentUpgradeResponse> UpgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpgradeDeploymentUpgradeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpgradeDeploymentUpgradeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpgradeDeploymentUpgrade API.

Implements

IDisposable