Package com.oracle.bmc.osmanagementhub

Interface ManagementStationAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ManagementStationAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface ManagementStationAsync
extends AutoCloseable
    Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds.

    For more information, see Overview of OS Management Hub.

    • 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

      • createManagementStation

        Future<CreateManagementStationResponse> createManagementStation​(CreateManagementStationRequest request,
                                                                AsyncHandler<CreateManagementStationRequest,​CreateManagementStationResponse> handler)
        Creates a management station using the proxy and mirror configuration information provided.
        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.

      • deleteManagementStation

        Future<DeleteManagementStationResponse> deleteManagementStation​(DeleteManagementStationRequest request,
                                                                AsyncHandler<DeleteManagementStationRequest,​DeleteManagementStationResponse> handler)
        Deletes a management station.

        You can’t delete a station if there are resources associated with the station (such as instances using the station or profiles associated with the station). Switch stations and edit profiles as needed before deleting the station.

        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.

      • getManagementStation

        Future<GetManagementStationResponse> getManagementStation​(GetManagementStationRequest request,
                                                          AsyncHandler<GetManagementStationRequest,​GetManagementStationResponse> handler)
        Returns information about the specified management station.
        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.

      • listManagementStations

        Future<ListManagementStationsResponse> listManagementStations​(ListManagementStationsRequest request,
                                                              AsyncHandler<ListManagementStationsRequest,​ListManagementStationsResponse> handler)
        Lists management stations within the specified compartment.

        Filter the list against a variety of criteria including but not limited to name, status, and location.

        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.

      • listMirrors

        Future<ListMirrorsResponse> listMirrors​(ListMirrorsRequest request,
                                        AsyncHandler<ListMirrorsRequest,​ListMirrorsResponse> handler)
        Lists all software source mirrors associated with a specified management station.
        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.

      • synchronizeMirrors

        Future<SynchronizeMirrorsResponse> synchronizeMirrors​(SynchronizeMirrorsRequest request,
                                                      AsyncHandler<SynchronizeMirrorsRequest,​SynchronizeMirrorsResponse> handler)
        Synchronize the specified software sources mirrored on the management station.
        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.

      • synchronizeSingleMirrors

        Future<SynchronizeSingleMirrorsResponse> synchronizeSingleMirrors​(SynchronizeSingleMirrorsRequest request,
                                                                  AsyncHandler<SynchronizeSingleMirrorsRequest,​SynchronizeSingleMirrorsResponse> handler)
        Synchronize the specified software source mirrors on the management station.
        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.

      • updateManagementStation

        Future<UpdateManagementStationResponse> updateManagementStation​(UpdateManagementStationRequest request,
                                                                AsyncHandler<UpdateManagementStationRequest,​UpdateManagementStationResponse> handler)
        Updates the configuration of the specified management station.
        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.