Package com.oracle.bmc.gdp

Interface GuardedDataPipelineAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    GuardedDataPipelineAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230301")
public interface GuardedDataPipelineAsync
extends AutoCloseable
    Use Guarded Data Pipelines to facilitate data transfer between different security domains.

    The service provides physical, network, and logistical isolation between security domains, malware and vulnerability scanning, auditing, and logging, with deep content inspection capabilities.

    • 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

      • changeGdpPipelineCompartment

        Future<ChangeGdpPipelineCompartmentResponse> changeGdpPipelineCompartment​(ChangeGdpPipelineCompartmentRequest request,
                                                                          AsyncHandler<ChangeGdpPipelineCompartmentRequest,​ChangeGdpPipelineCompartmentResponse> handler)
        Moves a pipeline resource from one compartment to another.

        When provided, if-match is checked against etag values of the resource.

        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.

      • createGdpPipeline

        Future<CreateGdpPipelineResponse> createGdpPipeline​(CreateGdpPipelineRequest request,
                                                    AsyncHandler<CreateGdpPipelineRequest,​CreateGdpPipelineResponse> handler)
        Creates a new pipeline.
        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.

      • deleteGdpPipeline

        Future<DeleteGdpPipelineResponse> deleteGdpPipeline​(DeleteGdpPipelineRequest request,
                                                    AsyncHandler<DeleteGdpPipelineRequest,​DeleteGdpPipelineResponse> handler)
        Deletes a pipeline 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.

      • getGdpPipeline

        Future<GetGdpPipelineResponse> getGdpPipeline​(GetGdpPipelineRequest request,
                                              AsyncHandler<GetGdpPipelineRequest,​GetGdpPipelineResponse> handler)
        Retrieves a pipeline 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.

      • getGdpWorkRequest

        Future<GetGdpWorkRequestResponse> getGdpWorkRequest​(GetGdpWorkRequestRequest request,
                                                    AsyncHandler<GetGdpWorkRequestRequest,​GetGdpWorkRequestResponse> handler)
        Gets details 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.

      • listGdpPipelines

        Future<ListGdpPipelinesResponse> listGdpPipelines​(ListGdpPipelinesRequest request,
                                                  AsyncHandler<ListGdpPipelinesRequest,​ListGdpPipelinesResponse> handler)
        Returns a list of pipelines.
        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.

      • listGdpWorkRequestErrors

        Future<ListGdpWorkRequestErrorsResponse> listGdpWorkRequestErrors​(ListGdpWorkRequestErrorsRequest request,
                                                                  AsyncHandler<ListGdpWorkRequestErrorsRequest,​ListGdpWorkRequestErrorsResponse> handler)
        Returns a (paginated) list of errors for 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.

      • listGdpWorkRequestLogs

        Future<ListGdpWorkRequestLogsResponse> listGdpWorkRequestLogs​(ListGdpWorkRequestLogsRequest request,
                                                              AsyncHandler<ListGdpWorkRequestLogsRequest,​ListGdpWorkRequestLogsResponse> handler)
        Returns a (paginated) list of logs for 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.

      • listGdpWorkRequests

        Future<ListGdpWorkRequestsResponse> listGdpWorkRequests​(ListGdpWorkRequestsRequest request,
                                                        AsyncHandler<ListGdpWorkRequestsRequest,​ListGdpWorkRequestsResponse> 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.

      • peerGdpPipeline

        Future<PeerGdpPipelineResponse> peerGdpPipeline​(PeerGdpPipelineRequest request,
                                                AsyncHandler<PeerGdpPipelineRequest,​PeerGdpPipelineResponse> handler)
        Peers the pipeline.
        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.

      • rotateGdpPipelineKeys

        Future<RotateGdpPipelineKeysResponse> rotateGdpPipelineKeys​(RotateGdpPipelineKeysRequest request,
                                                            AsyncHandler<RotateGdpPipelineKeysRequest,​RotateGdpPipelineKeysResponse> handler)
        Rotates the pipeline keys by resending the control message with a fresh pair of keys.
        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.

      • startGdpPipeline

        Future<StartGdpPipelineResponse> startGdpPipeline​(StartGdpPipelineRequest request,
                                                  AsyncHandler<StartGdpPipelineRequest,​StartGdpPipelineResponse> handler)
        Starts the pipeline.
        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.

      • stopGdpPipeline

        Future<StopGdpPipelineResponse> stopGdpPipeline​(StopGdpPipelineRequest request,
                                                AsyncHandler<StopGdpPipelineRequest,​StopGdpPipelineResponse> handler)
        Stops the pipeline.
        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.

      • updateGdpPipeline

        Future<UpdateGdpPipelineResponse> updateGdpPipeline​(UpdateGdpPipelineRequest request,
                                                    AsyncHandler<UpdateGdpPipelineRequest,​UpdateGdpPipelineResponse> handler)
        Updates the pipeline.
        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.