Package com.oracle.bmc.osmanagementhub

Interface SoftwareSourceAsync

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

      • addPackagesToSoftwareSource

        Future<AddPackagesToSoftwareSourceResponse> addPackagesToSoftwareSource​(AddPackagesToSoftwareSourceRequest request,
                                                                        AsyncHandler<AddPackagesToSoftwareSourceRequest,​AddPackagesToSoftwareSourceResponse> handler)
        Adds packages to a software source.

        This operation can only be done for custom and versioned custom software sources that are not created using filters. For a versioned custom software source, you can only add packages when the source is created. Once content is added to a versioned custom software source, it is immutable. Packages can be of the format: * name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added. * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64) * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)

        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.

      • createEntitlement

        Future<CreateEntitlementResponse> createEntitlement​(CreateEntitlementRequest request,
                                                    AsyncHandler<CreateEntitlementRequest,​CreateEntitlementResponse> handler)
        Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.
        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.

      • createSoftwareSource

        Future<CreateSoftwareSourceResponse> createSoftwareSource​(CreateSoftwareSourceRequest request,
                                                          AsyncHandler<CreateSoftwareSourceRequest,​CreateSoftwareSourceResponse> handler)
        Creates a new software source.
        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.

      • deleteSoftwareSource

        Future<DeleteSoftwareSourceResponse> deleteSoftwareSource​(DeleteSoftwareSourceRequest request,
                                                          AsyncHandler<DeleteSoftwareSourceRequest,​DeleteSoftwareSourceResponse> handler)
        Deletes the specified software source.
        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.

      • getErratum

        Future<GetErratumResponse> getErratum​(GetErratumRequest request,
                                      AsyncHandler<GetErratumRequest,​GetErratumResponse> handler)
        Returns information about the specified erratum based on its advisory 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.

      • getModuleStream

        Future<GetModuleStreamResponse> getModuleStream​(GetModuleStreamRequest request,
                                                AsyncHandler<GetModuleStreamRequest,​GetModuleStreamResponse> handler)
        Returns information about the specified module stream in a software source.
        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.

      • getModuleStreamProfile

        Future<GetModuleStreamProfileResponse> getModuleStreamProfile​(GetModuleStreamProfileRequest request,
                                                              AsyncHandler<GetModuleStreamProfileRequest,​GetModuleStreamProfileResponse> handler)
        Returns information about the specified module stream profile in a software source.
        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.

      • getPackageGroup

        Future<GetPackageGroupResponse> getPackageGroup​(GetPackageGroupRequest request,
                                                AsyncHandler<GetPackageGroupRequest,​GetPackageGroupResponse> handler)
        Returns information about the specified package group from a software source.
        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.

      • getSoftwarePackage

        Future<GetSoftwarePackageResponse> getSoftwarePackage​(GetSoftwarePackageRequest request,
                                                      AsyncHandler<GetSoftwarePackageRequest,​GetSoftwarePackageResponse> handler)
        Returns information about the specified software package.
        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.

      • getSoftwarePackageByName

        Future<GetSoftwarePackageByNameResponse> getSoftwarePackageByName​(GetSoftwarePackageByNameRequest request,
                                                                  AsyncHandler<GetSoftwarePackageByNameRequest,​GetSoftwarePackageByNameResponse> handler)
        Returns information about the specified software package based on its fully qualified name (NVRA or NEVRA).
        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.

      • getSoftwareSource

        Future<GetSoftwareSourceResponse> getSoftwareSource​(GetSoftwareSourceRequest request,
                                                    AsyncHandler<GetSoftwareSourceRequest,​GetSoftwareSourceResponse> handler)
        Returns information about the specified software source.
        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.

      • getSoftwareSourceManifest

        Future<GetSoftwareSourceManifestResponse> getSoftwareSourceManifest​(GetSoftwareSourceManifestRequest request,
                                                                    AsyncHandler<GetSoftwareSourceManifestRequest,​GetSoftwareSourceManifestResponse> handler)
        Returns an archive containing the list of packages in the software source.
        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.

      • listAllSoftwarePackages

        Future<ListAllSoftwarePackagesResponse> listAllSoftwarePackages​(ListAllSoftwarePackagesRequest request,
                                                                AsyncHandler<ListAllSoftwarePackagesRequest,​ListAllSoftwarePackagesResponse> handler)
        Lists software packages available through the OS Management Hub service.

        Filter the list against a variety of criteria including but not limited to its 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.

      • listAvailableSoftwarePackages

        Future<ListAvailableSoftwarePackagesResponse> listAvailableSoftwarePackages​(ListAvailableSoftwarePackagesRequest request,
                                                                            AsyncHandler<ListAvailableSoftwarePackagesRequest,​ListAvailableSoftwarePackagesResponse> handler)
        Lists software packages that are available to be added to a custom software source of type MANIFEST.

        Filter the list against a variety of criteria including but not limited to its 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.

      • listEntitlements

        Future<ListEntitlementsResponse> listEntitlements​(ListEntitlementsRequest request,
                                                  AsyncHandler<ListEntitlementsRequest,​ListEntitlementsResponse> handler)
        Lists entitlements in the specified tenancy OCID.

        Filter the list against a variety of criteria including but not limited to its Customer Support Identifier (CSI), and vendor 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.

      • listErrata

        Future<ListErrataResponse> listErrata​(ListErrataRequest request,
                                      AsyncHandler<ListErrataRequest,​ListErrataResponse> handler)
        Lists all of the currently available errata.

        Filter the list against a variety of criteria including but not limited to its name, classification type, advisory severity, 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.

      • listModuleStreamProfiles

        Future<ListModuleStreamProfilesResponse> listModuleStreamProfiles​(ListModuleStreamProfilesRequest request,
                                                                  AsyncHandler<ListModuleStreamProfilesRequest,​ListModuleStreamProfilesResponse> handler)
        Lists module stream profiles from the specified software source OCID.

        Filter the list against a variety of criteria including but not limited to its module name, stream name, and profile 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.

      • listModuleStreams

        Future<ListModuleStreamsResponse> listModuleStreams​(ListModuleStreamsRequest request,
                                                    AsyncHandler<ListModuleStreamsRequest,​ListModuleStreamsResponse> handler)
        Lists module streams from the specified software source OCID.

        Filter the list against a variety of criteria including but not limited to its module name and (stream) 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.

      • listPackageGroups

        Future<ListPackageGroupsResponse> listPackageGroups​(ListPackageGroupsRequest request,
                                                    AsyncHandler<ListPackageGroupsRequest,​ListPackageGroupsResponse> handler)
        Lists package groups that are associated with the specified software source OCID.

        Filter the list against a variety of criteria including but not limited to its name, and package group type.

        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.

      • listSoftwarePackages

        Future<ListSoftwarePackagesResponse> listSoftwarePackages​(ListSoftwarePackagesRequest request,
                                                          AsyncHandler<ListSoftwarePackagesRequest,​ListSoftwarePackagesResponse> handler)
        Lists software packages in the specified software source.

        Filter the list against a variety of criteria including but not limited to its 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.

      • listSoftwareSourceVendors

        Future<ListSoftwareSourceVendorsResponse> listSoftwareSourceVendors​(ListSoftwareSourceVendorsRequest request,
                                                                    AsyncHandler<ListSoftwareSourceVendorsRequest,​ListSoftwareSourceVendorsResponse> handler)
        Lists available software source vendors.

        Filter the list against a variety of criteria including but not limited to its 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.

      • listSoftwareSources

        Future<ListSoftwareSourcesResponse> listSoftwareSources​(ListSoftwareSourcesRequest request,
                                                        AsyncHandler<ListSoftwareSourcesRequest,​ListSoftwareSourcesResponse> handler)
        Lists software sources that match the specified tenancy or software source 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.

      • removePackagesFromSoftwareSource

        Future<RemovePackagesFromSoftwareSourceResponse> removePackagesFromSoftwareSource​(RemovePackagesFromSoftwareSourceRequest request,
                                                                                  AsyncHandler<RemovePackagesFromSoftwareSourceRequest,​RemovePackagesFromSoftwareSourceResponse> handler)
        Removes packages from a software source.

        This operation can only be done for custom software sources that are not created using filters. Packages can be of the format: * name (for example: git). This removes all versions of the package. * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64) * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)

        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.

      • replacePackagesInSoftwareSource

        Future<ReplacePackagesInSoftwareSourceResponse> replacePackagesInSoftwareSource​(ReplacePackagesInSoftwareSourceRequest request,
                                                                                AsyncHandler<ReplacePackagesInSoftwareSourceRequest,​ReplacePackagesInSoftwareSourceResponse> handler)
        Replaces packages in a software source with the provided list of packages.

        This operation can only be done for custom software sources that are not created using filters. Packages can be of the format: * name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added. * name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64) * name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)

        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.

      • searchSoftwareSourceModules

        Future<SearchSoftwareSourceModulesResponse> searchSoftwareSourceModules​(SearchSoftwareSourceModulesRequest request,
                                                                        AsyncHandler<SearchSoftwareSourceModulesRequest,​SearchSoftwareSourceModulesResponse> handler)
        Lists modules from a list of software sources.

        Filter the list against a variety of criteria including the module 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.

      • updateSoftwareSource

        Future<UpdateSoftwareSourceResponse> updateSoftwareSource​(UpdateSoftwareSourceRequest request,
                                                          AsyncHandler<UpdateSoftwareSourceRequest,​UpdateSoftwareSourceResponse> handler)
        Updates the specified software source’s details, including but not limited to name, description, and tags.
        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.