Package com.oracle.bmc.osmanagementhub

Interface Onboarding

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

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • 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 service.

      • 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

      • attachLifecycleStageToProfile

        AttachLifecycleStageToProfileResponse attachLifecycleStageToProfile​(AttachLifecycleStageToProfileRequest request)
        Attaches the specified lifecycle stage to a profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/AttachLifecycleStageToProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachLifecycleStageToProfile API.

      • attachManagedInstanceGroupToProfile

        AttachManagedInstanceGroupToProfileResponse attachManagedInstanceGroupToProfile​(AttachManagedInstanceGroupToProfileRequest request)
        Attaches the specified managed instance group to a profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/AttachManagedInstanceGroupToProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachManagedInstanceGroupToProfile API.

      • attachManagementStationToProfile

        AttachManagementStationToProfileResponse attachManagementStationToProfile​(AttachManagementStationToProfileRequest request)
        Attaches the specified management station to a profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/AttachManagementStationToProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachManagementStationToProfile API.

      • attachSoftwareSourcesToProfile

        AttachSoftwareSourcesToProfileResponse attachSoftwareSourcesToProfile​(AttachSoftwareSourcesToProfileRequest request)
        Attaches the specified software sources to a profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/AttachSoftwareSourcesToProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachSoftwareSourcesToProfile API.

      • changeProfileCompartment

        ChangeProfileCompartmentResponse changeProfileCompartment​(ChangeProfileCompartmentRequest request)
        Moves the profile to a different compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/ChangeProfileCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeProfileCompartment API.

      • createProfile

        CreateProfileResponse createProfile​(CreateProfileRequest request)
        Creates a registration profile.

        A profile defines the content applied to the instance when registering it with the service.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/CreateProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateProfile API.

      • deleteProfile

        DeleteProfileResponse deleteProfile​(DeleteProfileRequest request)
        Deletes a specified registration profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/DeleteProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteProfile API.

      • detachSoftwareSourcesFromProfile

        DetachSoftwareSourcesFromProfileResponse detachSoftwareSourcesFromProfile​(DetachSoftwareSourcesFromProfileRequest request)
        Detaches the specified software sources from a profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/DetachSoftwareSourcesFromProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetachSoftwareSourcesFromProfile API.

      • getProfile

        GetProfileResponse getProfile​(GetProfileRequest request)
        Returns information about the specified registration profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/GetProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetProfile API.

      • getProfileVersion

        GetProfileVersionResponse getProfileVersion​(GetProfileVersionRequest request)
        Returns information about the version of the specified registration profile.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/GetProfileVersionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetProfileVersion API.

      • listProfileAvailableSoftwareSources

        ListProfileAvailableSoftwareSourcesResponse listProfileAvailableSoftwareSources​(ListProfileAvailableSoftwareSourcesRequest request)
        Lists available software sources for a specified profile.

        Filter the list against a variety of criteria including but not limited to the software source name. The results list only software sources that have not already been added to the profile.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/ListProfileAvailableSoftwareSourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProfileAvailableSoftwareSources API.

      • listProfiles

        ListProfilesResponse listProfiles​(ListProfilesRequest request)
        Lists registration profiles that match the specified compartment or profile OCID.

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

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/ListProfilesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProfiles API.

      • updateProfile

        UpdateProfileResponse updateProfile​(UpdateProfileRequest request)
        Updates the specified profile’s name, description, and tags.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/osmanagementhub/UpdateProfileExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateProfile API.

      • getWaiters

        OnboardingWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        OnboardingPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.