Package com.oracle.bmc.psa

Interface PrivateServiceAccessAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    PrivateServiceAccessAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240301")
public interface PrivateServiceAccessAsync
extends AutoCloseable
    Use the PrivateServiceAccess Control Plane API to manage privateServiceAccess.

    • 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

      • cancelPsaWorkRequest

        Future<CancelPsaWorkRequestResponse> cancelPsaWorkRequest​(CancelPsaWorkRequestRequest request,
                                                          AsyncHandler<CancelPsaWorkRequestRequest,​CancelPsaWorkRequestResponse> handler)
        Cancels a PrivateServiceAccess 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.

      • createPrivateServiceAccess

        Future<CreatePrivateServiceAccessResponse> createPrivateServiceAccess​(CreatePrivateServiceAccessRequest request,
                                                                      AsyncHandler<CreatePrivateServiceAccessRequest,​CreatePrivateServiceAccessResponse> handler)
        Creates a private service access in the specified subnet (in the consumer’s VCN) and the specified compartment for a particular service.
        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.

      • getPrivateServiceAccess

        Future<GetPrivateServiceAccessResponse> getPrivateServiceAccess​(GetPrivateServiceAccessRequest request,
                                                                AsyncHandler<GetPrivateServiceAccessRequest,​GetPrivateServiceAccessResponse> handler)
        Gets information about a PrivateServiceAccess.
        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.

      • getPsaWorkRequest

        Future<GetPsaWorkRequestResponse> getPsaWorkRequest​(GetPsaWorkRequestRequest request,
                                                    AsyncHandler<GetPsaWorkRequestRequest,​GetPsaWorkRequestResponse> handler)
        Gets the details of a PrivateServiceAccess 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.

      • listPrivateServiceAccesses

        Future<ListPrivateServiceAccessesResponse> listPrivateServiceAccesses​(ListPrivateServiceAccessesRequest request,
                                                                      AsyncHandler<ListPrivateServiceAccessesRequest,​ListPrivateServiceAccessesResponse> handler)
        List the private service accesses in the specified compartment.

        You can optionally filter the list by specifying the OCID of a subnet in the cunsumer’s VCN.

        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.

      • listPsaServices

        Future<ListPsaServicesResponse> listPsaServices​(ListPsaServicesRequest request,
                                                AsyncHandler<ListPsaServicesRequest,​ListPsaServicesResponse> handler)
        List the OCI services available for Private Service Access catalog in the region, sorted by service name.
        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.

      • listPsaWorkRequestErrors

        Future<ListPsaWorkRequestErrorsResponse> listPsaWorkRequestErrors​(ListPsaWorkRequestErrorsRequest request,
                                                                  AsyncHandler<ListPsaWorkRequestErrorsRequest,​ListPsaWorkRequestErrorsResponse> handler)
        Lists the errors for a PrivateServiceAccess 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.

      • listPsaWorkRequestLogs

        Future<ListPsaWorkRequestLogsResponse> listPsaWorkRequestLogs​(ListPsaWorkRequestLogsRequest request,
                                                              AsyncHandler<ListPsaWorkRequestLogsRequest,​ListPsaWorkRequestLogsResponse> handler)
        Lists the logs for a PrivateServiceAccess 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.

      • listPsaWorkRequests

        Future<ListPsaWorkRequestsResponse> listPsaWorkRequests​(ListPsaWorkRequestsRequest request,
                                                        AsyncHandler<ListPsaWorkRequestsRequest,​ListPsaWorkRequestsResponse> handler)
        Lists the PrivateServiceAccess 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.