Package com.oracle.bmc.desktops

Interface DesktopServiceAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DesktopServiceAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220618")
public interface DesktopServiceAsync
extends AutoCloseable
    Create and manage cloud-hosted desktops which can be accessed from a web browser or installed client.

    • 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

      • cancelWorkRequest

        Future<CancelWorkRequestResponse> cancelWorkRequest​(CancelWorkRequestRequest request,
                                                    AsyncHandler<CancelWorkRequestRequest,​CancelWorkRequestResponse> handler)
        Cancel 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.

      • changeDesktopPoolCompartment

        Future<ChangeDesktopPoolCompartmentResponse> changeDesktopPoolCompartment​(ChangeDesktopPoolCompartmentRequest request,
                                                                          AsyncHandler<ChangeDesktopPoolCompartmentRequest,​ChangeDesktopPoolCompartmentResponse> handler)
        Moves a desktop pool into a different compartment within the same tenancy.

        You must provide the OCID of the desktop pool and the OCID of the compartment that you are moving the pool to.

        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.

      • createDesktopPool

        Future<CreateDesktopPoolResponse> createDesktopPool​(CreateDesktopPoolRequest request,
                                                    AsyncHandler<CreateDesktopPoolRequest,​CreateDesktopPoolResponse> handler)
        Creates a desktop pool with the given configuration parameters.
        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.

      • deleteDesktop

        Future<DeleteDesktopResponse> deleteDesktop​(DeleteDesktopRequest request,
                                            AsyncHandler<DeleteDesktopRequest,​DeleteDesktopResponse> handler)
        Deletes the desktop with the specified OCID.

        The service terminates the associated compute instance. The end-user loses access to the desktop instance permanently. Any associated block volume becomes inactive but is not deleted.

        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.

      • deleteDesktopPool

        Future<DeleteDesktopPoolResponse> deleteDesktopPool​(DeleteDesktopPoolRequest request,
                                                    AsyncHandler<DeleteDesktopPoolRequest,​DeleteDesktopPoolResponse> handler)
        Deletes a desktop pool with the specified OCID.

        The service terminates all compute instances and users immediately lose access to their desktops. You can choose to preserve the block volumes associated with the pool.

        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.

      • getDesktop

        Future<GetDesktopResponse> getDesktop​(GetDesktopRequest request,
                                      AsyncHandler<GetDesktopRequest,​GetDesktopResponse> handler)
        Provides information about the desktop with the specified OCID.
        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.

      • getDesktopPool

        Future<GetDesktopPoolResponse> getDesktopPool​(GetDesktopPoolRequest request,
                                              AsyncHandler<GetDesktopPoolRequest,​GetDesktopPoolResponse> handler)
        Returns information about the desktop pool including all configuration parameters and the current state.
        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.

      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Gets the status 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.

      • listDesktopPoolDesktops

        Future<ListDesktopPoolDesktopsResponse> listDesktopPoolDesktops​(ListDesktopPoolDesktopsRequest request,
                                                                AsyncHandler<ListDesktopPoolDesktopsRequest,​ListDesktopPoolDesktopsResponse> handler)
        Returns a list of desktops within a given desktop pool.

        You can limit the results to an availability domain, desktop name, or desktop state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

        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.

      • listDesktopPoolVolumes

        Future<ListDesktopPoolVolumesResponse> listDesktopPoolVolumes​(ListDesktopPoolVolumesRequest request,
                                                              AsyncHandler<ListDesktopPoolVolumesRequest,​ListDesktopPoolVolumesResponse> handler)
        Returns a list of volumes within the given desktop pool.

        You can limit the results to an availability domain, volume name, or volume state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

        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.

      • listDesktopPools

        Future<ListDesktopPoolsResponse> listDesktopPools​(ListDesktopPoolsRequest request,
                                                  AsyncHandler<ListDesktopPoolsRequest,​ListDesktopPoolsResponse> handler)
        Returns a list of desktop pools within the given compartment.

        You can limit the results to an availability domain, pool name, or pool state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

        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.

      • listDesktops

        Future<ListDesktopsResponse> listDesktops​(ListDesktopsRequest request,
                                          AsyncHandler<ListDesktopsRequest,​ListDesktopsResponse> handler)
        Returns a list of desktops filtered by the specified parameters.

        You can limit the results to an availability domain, desktop name, desktop OCID, desktop state, pool OCID, or compartment OCID. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

        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.

      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Return a (paginated) list of errors for a given 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.

      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Return a (paginated) list of logs for a given 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.

      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> 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.

      • startDesktop

        Future<StartDesktopResponse> startDesktop​(StartDesktopRequest request,
                                          AsyncHandler<StartDesktopRequest,​StartDesktopResponse> handler)
        Starts the desktop with the specified OCID.
        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.

      • startDesktopPool

        Future<StartDesktopPoolResponse> startDesktopPool​(StartDesktopPoolRequest request,
                                                  AsyncHandler<StartDesktopPoolRequest,​StartDesktopPoolResponse> handler)
        Starts the desktop pool with the specified OCID.

        Once the pool is ACTIVE, users will have access to their desktops within the pool.

        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.

      • stopDesktop

        Future<StopDesktopResponse> stopDesktop​(StopDesktopRequest request,
                                        AsyncHandler<StopDesktopRequest,​StopDesktopResponse> handler)
        Stops the desktop with the specified OCID.

        Stopping a desktop causes the end-user to lose access to their desktop instance until the desktop is restarted.

        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.

      • stopDesktopPool

        Future<StopDesktopPoolResponse> stopDesktopPool​(StopDesktopPoolRequest request,
                                                AsyncHandler<StopDesktopPoolRequest,​StopDesktopPoolResponse> handler)
        Stops the desktop pool with the specified OCID.

        Users will lose access to their desktops until you explicitly start the pool again.

        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.

      • updateDesktop

        Future<UpdateDesktopResponse> updateDesktop​(UpdateDesktopRequest request,
                                            AsyncHandler<UpdateDesktopRequest,​UpdateDesktopResponse> handler)
        Modifies information about the desktop such as the 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.

      • updateDesktopPool

        Future<UpdateDesktopPoolResponse> updateDesktopPool​(UpdateDesktopPoolRequest request,
                                                    AsyncHandler<UpdateDesktopPoolRequest,​UpdateDesktopPoolResponse> handler)
        Modifies the configuration of the desktop pool such as the availability, contact information, description, name, device policy, pool size, standby size, and start or stop time.
        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.