Class IntegrationInstanceClient

Service client instance for IntegrationInstance.

Inheritance

object

ClientBase

RegionalClientBase

IntegrationInstanceClient

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.IntegrationService

Assembly: OCI.DotNetSDK.Integration.dll

Syntax

public class IntegrationInstanceClient : RegionalClientBase, IDisposable

Constructors

IntegrationInstanceClient(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 IntegrationInstanceClient(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 IntegrationInstancePaginators Paginators { get; }

Property Value

Type	Description
IntegrationInstancePaginators

Waiters

Declaration

public IntegrationInstanceWaiters Waiters { get; }

Property Value

Type	Description
IntegrationInstanceWaiters

Methods

AddOracleManagedCustomEndpoint(AddOracleManagedCustomEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Enable Oracle Managed Custom Endpoint for given integration instance.

Declaration

public Task<AddOracleManagedCustomEndpointResponse> AddOracleManagedCustomEndpoint(AddOracleManagedCustomEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddOracleManagedCustomEndpointRequest	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<AddOracleManagedCustomEndpointResponse>	A response object containing details about the completed operation

Examples

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

ChangeIntegrationInstanceCompartment(ChangeIntegrationInstanceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change the compartment for an integration instance

Declaration

public Task<ChangeIntegrationInstanceCompartmentResponse> ChangeIntegrationInstanceCompartment(ChangeIntegrationInstanceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeIntegrationInstanceCompartmentRequest	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<ChangeIntegrationInstanceCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeIntegrationInstanceNetworkEndpoint(ChangeIntegrationInstanceNetworkEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change an Integration instance network endpoint. The operation is long-running and creates a new WorkRequest.

Declaration

public Task<ChangeIntegrationInstanceNetworkEndpointResponse> ChangeIntegrationInstanceNetworkEndpoint(ChangeIntegrationInstanceNetworkEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeIntegrationInstanceNetworkEndpointRequest	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<ChangeIntegrationInstanceNetworkEndpointResponse>	A response object containing details about the completed operation

Examples

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

ChangePrivateEndpointOutboundConnection(ChangePrivateEndpointOutboundConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change private endpoint outbound connection for given Integration instance. The operation is long-running and creates a new WorkRequest.

Declaration

public Task<ChangePrivateEndpointOutboundConnectionResponse> ChangePrivateEndpointOutboundConnection(ChangePrivateEndpointOutboundConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangePrivateEndpointOutboundConnectionRequest	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<ChangePrivateEndpointOutboundConnectionResponse>	A response object containing details about the completed operation

Examples

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

CreateIntegrationInstance(CreateIntegrationInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Integration Instance.

Declaration

public Task<CreateIntegrationInstanceResponse> CreateIntegrationInstance(CreateIntegrationInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateIntegrationInstanceRequest	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<CreateIntegrationInstanceResponse>	A response object containing details about the completed operation

Examples

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

DeleteIntegrationInstance(DeleteIntegrationInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an Integration Instance resource by identifier.

Declaration

public Task<DeleteIntegrationInstanceResponse> DeleteIntegrationInstance(DeleteIntegrationInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteIntegrationInstanceRequest	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<DeleteIntegrationInstanceResponse>	A response object containing details about the completed operation

Examples

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

DisasterRecoveryFailover(DisasterRecoveryFailoverRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Allows failover for disaster recovery. Called in the context of integration instance in that region. Upon calling the failover api in the region where given instance was created, the intigration instance if primary will be switched to standby and crossRegion integration instance will be switched to primary and vice-versa.

Declaration

public Task<DisasterRecoveryFailoverResponse> DisasterRecoveryFailover(DisasterRecoveryFailoverRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DisasterRecoveryFailoverRequest	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<DisasterRecoveryFailoverResponse>	A response object containing details about the completed operation

Examples

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

EnableProcessAutomation(EnableProcessAutomationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Enable Process Automation for given Integration Instance

Declaration

public Task<EnableProcessAutomationResponse> EnableProcessAutomation(EnableProcessAutomationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
EnableProcessAutomationRequest	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<EnableProcessAutomationResponse>	A response object containing details about the completed operation

Examples

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

ExtendDataRetention(ExtendDataRetentionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Extend Data Retention period for given Integration Instance

Declaration

public Task<ExtendDataRetentionResponse> ExtendDataRetention(ExtendDataRetentionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ExtendDataRetentionRequest	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<ExtendDataRetentionResponse>	A response object containing details about the completed operation

Examples

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

GetIntegrationInstance(GetIntegrationInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a IntegrationInstance by identifier

Declaration

public Task<GetIntegrationInstanceResponse> GetIntegrationInstance(GetIntegrationInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetIntegrationInstanceRequest	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<GetIntegrationInstanceResponse>	A response object containing details about the completed operation

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the status of the work request with the given ID.

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.

ListIntegrationInstances(ListIntegrationInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Integration Instances.

Declaration

public Task<ListIntegrationInstancesResponse> ListIntegrationInstances(ListIntegrationInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListIntegrationInstancesRequest	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<ListIntegrationInstancesResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the errors of a work request.

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)

Get the logs of a work request.

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 a 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.

RemoveOracleManagedCustomEndpoint(RemoveOracleManagedCustomEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Remove Oracle Managed Custom Endpoint for given integration instance that was previously enabled.

Declaration

public Task<RemoveOracleManagedCustomEndpointResponse> RemoveOracleManagedCustomEndpoint(RemoveOracleManagedCustomEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RemoveOracleManagedCustomEndpointRequest	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<RemoveOracleManagedCustomEndpointResponse>	A response object containing details about the completed operation

Examples

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

StartIntegrationInstance(StartIntegrationInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Start an integration instance that was previously in an INACTIVE state

Declaration

public Task<StartIntegrationInstanceResponse> StartIntegrationInstance(StartIntegrationInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartIntegrationInstanceRequest	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<StartIntegrationInstanceResponse>	A response object containing details about the completed operation

Examples

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

StopIntegrationInstance(StopIntegrationInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stop an integration instance that was previously in an ACTIVE state

Declaration

public Task<StopIntegrationInstanceResponse> StopIntegrationInstance(StopIntegrationInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopIntegrationInstanceRequest	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<StopIntegrationInstanceResponse>	A response object containing details about the completed operation

Examples

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

UpdateIntegrationInstance(UpdateIntegrationInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the Integration Instance.

Declaration

public Task<UpdateIntegrationInstanceResponse> UpdateIntegrationInstance(UpdateIntegrationInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateIntegrationInstanceRequest	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<UpdateIntegrationInstanceResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable