Package com.oracle.bmc.osmanagementhub

Interface LifecycleEnvironmentAsync

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

      • createLifecycleEnvironment

        Future<CreateLifecycleEnvironmentResponse> createLifecycleEnvironment​(CreateLifecycleEnvironmentRequest request,
                                                                      AsyncHandler<CreateLifecycleEnvironmentRequest,​CreateLifecycleEnvironmentResponse> handler)
        Creates a lifecycle environment.

        A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.

        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.

      • getLifecycleEnvironment

        Future<GetLifecycleEnvironmentResponse> getLifecycleEnvironment​(GetLifecycleEnvironmentRequest request,
                                                                AsyncHandler<GetLifecycleEnvironmentRequest,​GetLifecycleEnvironmentResponse> handler)
        Gets information about the specified lifecycle environment.
        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.

      • getLifecycleStage

        Future<GetLifecycleStageResponse> getLifecycleStage​(GetLifecycleStageRequest request,
                                                    AsyncHandler<GetLifecycleStageRequest,​GetLifecycleStageResponse> handler)
        Returns information about the specified lifecycle stage.
        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.

      • listLifecycleEnvironments

        Future<ListLifecycleEnvironmentsResponse> listLifecycleEnvironments​(ListLifecycleEnvironmentsRequest request,
                                                                    AsyncHandler<ListLifecycleEnvironmentsRequest,​ListLifecycleEnvironmentsResponse> handler)
        Lists lifecycle environments that match the specified compartment or lifecycle environment OCID.

        Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

        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.

      • listLifecycleStages

        Future<ListLifecycleStagesResponse> listLifecycleStages​(ListLifecycleStagesRequest request,
                                                        AsyncHandler<ListLifecycleStagesRequest,​ListLifecycleStagesResponse> handler)
        Lists lifecycle stages that match the specified compartment or lifecycle stage OCID.

        Filter the list against

        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.

      • promoteSoftwareSourceToLifecycleStage

        Future<PromoteSoftwareSourceToLifecycleStageResponse> promoteSoftwareSourceToLifecycleStage​(PromoteSoftwareSourceToLifecycleStageRequest request,
                                                                                            AsyncHandler<PromoteSoftwareSourceToLifecycleStageRequest,​PromoteSoftwareSourceToLifecycleStageResponse> handler)
        Updates the versioned custom software source content to the specified lifecycle stage.

        A versioned custom software source OCID (softwareSourceId) is required when promoting content to the first lifecycle stage. You must promote content to the first stage before promoting to subsequent stages, otherwise the service returns an error. The softwareSourceId is optional when promoting content to the second, third, forth, or fifth stages. If you provide a softwareSourceId, the service validates that it matches the softwareSourceId of the previous stage. If it does not match, the service returns an error. If you don’t provide a softwareSourceId, the service promotes the versioned software source from the previous lifecycle stage. If the previous lifecycle stage has no software source, the service returns an error.

        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.

      • rebootLifecycleStage

        Future<RebootLifecycleStageResponse> rebootLifecycleStage​(RebootLifecycleStageRequest request,
                                                          AsyncHandler<RebootLifecycleStageRequest,​RebootLifecycleStageResponse> handler)
        Reboots all managed instances in the specified lifecycle stage.
        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.