Package com.oracle.bmc.zpr

Interface ZprAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ZprAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240301")
public interface ZprAsync
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.

    • 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

      • createConfiguration

        Future<CreateConfigurationResponse> createConfiguration​(CreateConfigurationRequest request,
                                                        AsyncHandler<CreateConfigurationRequest,​CreateConfigurationResponse> handler)
        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
        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.

      • createZprPolicy

        Future<CreateZprPolicyResponse> createZprPolicy​(CreateZprPolicyRequest request,
                                                AsyncHandler<CreateZprPolicyRequest,​CreateZprPolicyResponse> handler)
        Creates a ZprPolicy.
        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.

      • deleteZprPolicy

        Future<DeleteZprPolicyResponse> deleteZprPolicy​(DeleteZprPolicyRequest request,
                                                AsyncHandler<DeleteZprPolicyRequest,​DeleteZprPolicyResponse> handler)
        Deletes a ZprPolicy.
        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.

      • getConfiguration

        Future<GetConfigurationResponse> getConfiguration​(GetConfigurationRequest request,
                                                  AsyncHandler<GetConfigurationRequest,​GetConfigurationResponse> handler)
        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
        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.

      • getZprPolicy

        Future<GetZprPolicyResponse> getZprPolicy​(GetZprPolicyRequest request,
                                          AsyncHandler<GetZprPolicyRequest,​GetZprPolicyResponse> handler)
        Gets information about a ZprPolicy.
        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.

      • listZprPolicies

        Future<ListZprPoliciesResponse> listZprPolicies​(ListZprPoliciesRequest request,
                                                AsyncHandler<ListZprPoliciesRequest,​ListZprPoliciesResponse> handler)
        Gets a list of ZprPolicies.
        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.

      • updateZprPolicy

        Future<UpdateZprPolicyResponse> updateZprPolicy​(UpdateZprPolicyRequest request,
                                                AsyncHandler<UpdateZprPolicyRequest,​UpdateZprPolicyResponse> handler)
        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
        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.