Package com.oracle.bmc.zpr

Interface Zpr

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ZprClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240301")
public interface Zpr
extends AutoCloseable
    Use the Zero Trust Packet Routing Control Plane API to manage ZPR configuration and policy.

    See the Zero Trust Packet Routing documentation for more information. 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

      • createConfiguration

        CreateConfigurationResponse createConfiguration​(CreateConfigurationRequest request)
        Initiates the process to onboard ZPR in a root compartment (the root compartment is the tenancy).

        It creates an object of ZPR configuration as part of onboarding.

        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/latest/zpr/CreateConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateConfiguration API.

      • createZprPolicy

        CreateZprPolicyResponse createZprPolicy​(CreateZprPolicyRequest request)
        Creates a ZprPolicy.
        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/latest/zpr/CreateZprPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateZprPolicy API.

      • deleteZprPolicy

        DeleteZprPolicyResponse deleteZprPolicy​(DeleteZprPolicyRequest request)
        Deletes a ZprPolicy.
        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/latest/zpr/DeleteZprPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteZprPolicy API.

      • getConfiguration

        GetConfigurationResponse getConfiguration​(GetConfigurationRequest request)
        Retrieves the ZPR configuration details for the root compartment (the root compartment is the tenancy).

        Returns ZPR configuration for root compartment (the root compartment is the tenancy).

        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/latest/zpr/GetConfigurationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConfiguration API.

      • getZprConfigurationWorkRequest

        GetZprConfigurationWorkRequestResponse getZprConfigurationWorkRequest​(GetZprConfigurationWorkRequestRequest request)
        Gets the details of a work request.
        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/latest/zpr/GetZprConfigurationWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetZprConfigurationWorkRequest API.

      • getZprPolicy

        GetZprPolicyResponse getZprPolicy​(GetZprPolicyRequest request)
        Gets information about a ZprPolicy.
        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/latest/zpr/GetZprPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetZprPolicy API.

      • getZprPolicyWorkRequest

        GetZprPolicyWorkRequestResponse getZprPolicyWorkRequest​(GetZprPolicyWorkRequestRequest request)
        Gets the details of a work request.
        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/latest/zpr/GetZprPolicyWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetZprPolicyWorkRequest API.

      • listZprConfigurationWorkRequestErrors

        ListZprConfigurationWorkRequestErrorsResponse listZprConfigurationWorkRequestErrors​(ListZprConfigurationWorkRequestErrorsRequest request)
        Lists the errors for a work request.
        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/latest/zpr/ListZprConfigurationWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListZprConfigurationWorkRequestErrors API.

      • listZprConfigurationWorkRequestLogs

        ListZprConfigurationWorkRequestLogsResponse listZprConfigurationWorkRequestLogs​(ListZprConfigurationWorkRequestLogsRequest request)
        Lists the logs for a work request.
        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/latest/zpr/ListZprConfigurationWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListZprConfigurationWorkRequestLogs API.

      • listZprConfigurationWorkRequests

        ListZprConfigurationWorkRequestsResponse listZprConfigurationWorkRequests​(ListZprConfigurationWorkRequestsRequest 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/latest/zpr/ListZprConfigurationWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListZprConfigurationWorkRequests API.

      • listZprPolicies

        ListZprPoliciesResponse listZprPolicies​(ListZprPoliciesRequest request)
        Gets a list of ZprPolicies.
        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/latest/zpr/ListZprPoliciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListZprPolicies API.

      • listZprPolicyWorkRequestErrors

        ListZprPolicyWorkRequestErrorsResponse listZprPolicyWorkRequestErrors​(ListZprPolicyWorkRequestErrorsRequest request)
        Lists the errors for a work request.
        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/latest/zpr/ListZprPolicyWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListZprPolicyWorkRequestErrors API.

      • listZprPolicyWorkRequestLogs

        ListZprPolicyWorkRequestLogsResponse listZprPolicyWorkRequestLogs​(ListZprPolicyWorkRequestLogsRequest request)
        Lists the logs for a work request.
        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/latest/zpr/ListZprPolicyWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListZprPolicyWorkRequestLogs API.

      • listZprPolicyWorkRequests

        ListZprPolicyWorkRequestsResponse listZprPolicyWorkRequests​(ListZprPolicyWorkRequestsRequest 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/latest/zpr/ListZprPolicyWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListZprPolicyWorkRequests API.

      • updateZprPolicy

        UpdateZprPolicyResponse updateZprPolicy​(UpdateZprPolicyRequest request)
        Updates a specific ZprPolicy.

        If updating on statements, the entire list of policy statements is required, which will replace the existing policy statements associated with the policy 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/latest/zpr/UpdateZprPolicyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateZprPolicy API.

      • getWaiters

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

      • getPaginators

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