Package com.oracle.bmc.gdp

Interface GuardedDataPipeline

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    GuardedDataPipelineClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230301")
public interface GuardedDataPipeline
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. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • 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 service.

      • 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

        ChangeGdpPipelineCompartmentResponse changeGdpPipelineCompartment​(ChangeGdpPipelineCompartmentRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/ChangeGdpPipelineCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeGdpPipelineCompartment API.

      • createGdpPipeline

        CreateGdpPipelineResponse createGdpPipeline​(CreateGdpPipelineRequest request)
        Creates a new pipeline.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/CreateGdpPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateGdpPipeline API.

      • deleteGdpPipeline

        DeleteGdpPipelineResponse deleteGdpPipeline​(DeleteGdpPipelineRequest request)
        Deletes a pipeline by identifier.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/DeleteGdpPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteGdpPipeline API.

      • getGdpPipeline

        GetGdpPipelineResponse getGdpPipeline​(GetGdpPipelineRequest request)
        Retrieves a pipeline by identifier.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/GetGdpPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetGdpPipeline API.

      • getGdpWorkRequest

        GetGdpWorkRequestResponse getGdpWorkRequest​(GetGdpWorkRequestRequest request)
        Gets details of the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/GetGdpWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetGdpWorkRequest API.

      • listGdpPipelines

        ListGdpPipelinesResponse listGdpPipelines​(ListGdpPipelinesRequest request)
        Returns a list of pipelines.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/ListGdpPipelinesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListGdpPipelines API.

      • listGdpWorkRequestErrors

        ListGdpWorkRequestErrorsResponse listGdpWorkRequestErrors​(ListGdpWorkRequestErrorsRequest request)
        Returns a (paginated) list of errors for the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/ListGdpWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListGdpWorkRequestErrors API.

      • listGdpWorkRequestLogs

        ListGdpWorkRequestLogsResponse listGdpWorkRequestLogs​(ListGdpWorkRequestLogsRequest request)
        Returns a (paginated) list of logs for the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/ListGdpWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListGdpWorkRequestLogs API.

      • listGdpWorkRequests

        ListGdpWorkRequestsResponse listGdpWorkRequests​(ListGdpWorkRequestsRequest request)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/ListGdpWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListGdpWorkRequests API.

      • peerGdpPipeline

        PeerGdpPipelineResponse peerGdpPipeline​(PeerGdpPipelineRequest request)
        Peers the pipeline.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/PeerGdpPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PeerGdpPipeline API.

      • rotateGdpPipelineKeys

        RotateGdpPipelineKeysResponse rotateGdpPipelineKeys​(RotateGdpPipelineKeysRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/RotateGdpPipelineKeysExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RotateGdpPipelineKeys API.

      • startGdpPipeline

        StartGdpPipelineResponse startGdpPipeline​(StartGdpPipelineRequest request)
        Starts the pipeline.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/StartGdpPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartGdpPipeline API.

      • stopGdpPipeline

        StopGdpPipelineResponse stopGdpPipeline​(StopGdpPipelineRequest request)
        Stops the pipeline.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/StopGdpPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopGdpPipeline API.

      • updateGdpPipeline

        UpdateGdpPipelineResponse updateGdpPipeline​(UpdateGdpPipelineRequest request)
        Updates the pipeline.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/gdp/UpdateGdpPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateGdpPipeline API.

      • getWaiters

        GuardedDataPipelineWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        GuardedDataPipelinePaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.