Interface IntegrationInstanceAsync

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.
      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)
      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.
      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.
      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
      • addLogAnalyticsLogGroup

        Future<AddLogAnalyticsLogGroupResponse> addLogAnalyticsLogGroup​(AddLogAnalyticsLogGroupRequest request,
                                                                        AsyncHandler<AddLogAnalyticsLogGroupRequest,​AddLogAnalyticsLogGroupResponse> handler)
        Add LogGroup with specified ocid for Integration Instance to enable sending OIC Activity Stream to OCI Logging Analytics.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • convertInstance

        Future<ConvertInstanceResponse> convertInstance​(ConvertInstanceRequest request,
                                                        AsyncHandler<ConvertInstanceRequest,​ConvertInstanceResponse> handler)
        Integration instance identified by ID will be migrated to a new Disaster Recovery enabled integration instance.

        If a given Integration instance has certain features enabled which are not supported for conversion/migration it will not be accepted for conversion.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • disableProcessAutomation

        Future<DisableProcessAutomationResponse> disableProcessAutomation​(DisableProcessAutomationRequest request,
                                                                          AsyncHandler<DisableProcessAutomationRequest,​DisableProcessAutomationResponse> handler)
        Disable Process Automation for given Integration Instance
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • disasterRecoveryFailover

        Future<DisasterRecoveryFailoverResponse> disasterRecoveryFailover​(DisasterRecoveryFailoverRequest request,
                                                                          AsyncHandler<DisasterRecoveryFailoverRequest,​DisasterRecoveryFailoverResponse> handler)
        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.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • enableProcessAutomation

        Future<EnableProcessAutomationResponse> enableProcessAutomation​(EnableProcessAutomationRequest request,
                                                                        AsyncHandler<EnableProcessAutomationRequest,​EnableProcessAutomationResponse> handler)
        Enable Process Automation for given Integration Instance
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • extendDataRetention

        Future<ExtendDataRetentionResponse> extendDataRetention​(ExtendDataRetentionRequest request,
                                                                AsyncHandler<ExtendDataRetentionRequest,​ExtendDataRetentionResponse> handler)
        Extend Data Retention period for given Integration Instance
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • getIntegrationInstance

        Future<GetIntegrationInstanceResponse> getIntegrationInstance​(GetIntegrationInstanceRequest request,
                                                                      AsyncHandler<GetIntegrationInstanceRequest,​GetIntegrationInstanceResponse> handler)
        Gets a IntegrationInstance by identifier
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                                      AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Gets the status of the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                                    AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Get the errors of a work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                                AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Get the logs of a work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                          AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • removeLogAnalyticsLogGroup

        Future<RemoveLogAnalyticsLogGroupResponse> removeLogAnalyticsLogGroup​(RemoveLogAnalyticsLogGroupRequest request,
                                                                              AsyncHandler<RemoveLogAnalyticsLogGroupRequest,​RemoveLogAnalyticsLogGroupResponse> handler)
        Removes Log Analytics logGroup, if enabled for given integrationInstance.

        Since only single LogGroup can be enabled for integration instance, no additional details are required to be includes in the request.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • startIntegrationInstance

        Future<StartIntegrationInstanceResponse> startIntegrationInstance​(StartIntegrationInstanceRequest request,
                                                                          AsyncHandler<StartIntegrationInstanceRequest,​StartIntegrationInstanceResponse> handler)
        Start an integration instance that was previously in an INACTIVE state
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      • stopIntegrationInstance

        Future<StopIntegrationInstanceResponse> stopIntegrationInstance​(StopIntegrationInstanceRequest request,
                                                                        AsyncHandler<StopIntegrationInstanceRequest,​StopIntegrationInstanceResponse> handler)
        Stop an integration instance that was previously in an ACTIVE state
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.