Package com.oracle.bmc.osmanagementhub

Interface DynamicSet

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

      • changeDynamicSetCompartment

        ChangeDynamicSetCompartmentResponse changeDynamicSetCompartment​(ChangeDynamicSetCompartmentRequest request)
        Move the specified Dynamic Set 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/latest/osmanagementhub/ChangeDynamicSetCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDynamicSetCompartment API.

      • createDynamicSet

        CreateDynamicSetResponse createDynamicSet​(CreateDynamicSetRequest request)
        Creates a new dynamic set.
        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/latest/osmanagementhub/CreateDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDynamicSet API.

      • deleteDynamicSet

        DeleteDynamicSetResponse deleteDynamicSet​(DeleteDynamicSetRequest request)
        Deletes the specific dynamic set
        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/latest/osmanagementhub/DeleteDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDynamicSet API.

      • getDynamicSet

        GetDynamicSetResponse getDynamicSet​(GetDynamicSetRequest request)
        Gets information about the specified dynamic set.
        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/latest/osmanagementhub/GetDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDynamicSet API.

      • installPackagesOnDynamicSet

        InstallPackagesOnDynamicSetResponse installPackagesOnDynamicSet​(InstallPackagesOnDynamicSetRequest request)
        Installs specified software packages on all managed instances in the dynamic set.
        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/latest/osmanagementhub/InstallPackagesOnDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use InstallPackagesOnDynamicSet API.

      • listDynamicSets

        ListDynamicSetsResponse listDynamicSets​(ListDynamicSetsRequest request)
        Lists dynamic sets that match the specified compartment or dynamic set OCID.

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

        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/latest/osmanagementhub/ListDynamicSetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDynamicSets API.

      • listManagedInstancesInDynamicSet

        ListManagedInstancesInDynamicSetResponse listManagedInstancesInDynamicSet​(ListManagedInstancesInDynamicSetRequest request)
        Retrieves a list of managed instances associated with a specified dynamic set.
        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/latest/osmanagementhub/ListManagedInstancesInDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagedInstancesInDynamicSet API.

      • previewManagedInstances

        PreviewManagedInstancesResponse previewManagedInstances​(PreviewManagedInstancesRequest request)
        Preview a dynamic set
        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/latest/osmanagementhub/PreviewManagedInstancesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PreviewManagedInstances API.

      • rebootDynamicSet

        RebootDynamicSetResponse rebootDynamicSet​(RebootDynamicSetRequest request)
        Initiates a reboot of all managed instances within the specified dynamic set.
        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/latest/osmanagementhub/RebootDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RebootDynamicSet API.

      • removePackagesFromDynamicSet

        RemovePackagesFromDynamicSetResponse removePackagesFromDynamicSet​(RemovePackagesFromDynamicSetRequest request)
        Removes specified software packages from all managed instances in the dynamic set.
        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/latest/osmanagementhub/RemovePackagesFromDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemovePackagesFromDynamicSet API.

      • updateDynamicSet

        UpdateDynamicSetResponse updateDynamicSet​(UpdateDynamicSetRequest request)
        Updates the specified dynamic set.
        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/latest/osmanagementhub/UpdateDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDynamicSet API.

      • updatePackagesOnDynamicSet

        UpdatePackagesOnDynamicSetResponse updatePackagesOnDynamicSet​(UpdatePackagesOnDynamicSetRequest request)
        Updates all installed software packages on managed instances in the dynamic set.
        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/latest/osmanagementhub/UpdatePackagesOnDynamicSetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePackagesOnDynamicSet API.

      • getWaiters

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

      • getPaginators

        DynamicSetPaginators 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.