Interface OsManagementAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OsManagementAsyncClient

    @Generated(value="OracleSDKGenerator",
               comments="API Version: 20190801")
    public interface OsManagementAsync
    extends AutoCloseable
    API for the OS Management service.

    Use these API operations for working with Managed instances and Managed instance groups.

    • 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
      • createManagedInstanceGroup

        Future<CreateManagedInstanceGroupResponse> createManagedInstanceGroup​(CreateManagedInstanceGroupRequest request,
                                                                              AsyncHandler<CreateManagedInstanceGroupRequest,​CreateManagedInstanceGroupResponse> handler)
        Creates a new Managed Instance Group on the management system.

        This will not contain any managed instances after it is first created, and they must be added later.

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

        Future<CreateScheduledJobResponse> createScheduledJob​(CreateScheduledJobRequest request,
                                                              AsyncHandler<CreateScheduledJobRequest,​CreateScheduledJobResponse> handler)
        Creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups.

        Can be created as a one-time execution in the future, or as a recurring execution that repeats on a defined interval.

        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 custom Software Source on the management system.

        This will not contain any packages after it is first created, and they must be added later.

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

        Future<DeleteScheduledJobResponse> deleteScheduledJob​(DeleteScheduledJobRequest request,
                                                              AsyncHandler<DeleteScheduledJobRequest,​DeleteScheduledJobResponse> handler)
        Cancels an existing Scheduled Job on the management system
        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 a custom Software Source on the management system
        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.
      • disableModuleStreamOnManagedInstance

        Future<DisableModuleStreamOnManagedInstanceResponse> disableModuleStreamOnManagedInstance​(DisableModuleStreamOnManagedInstanceRequest request,
                                                                                                  AsyncHandler<DisableModuleStreamOnManagedInstanceRequest,​DisableModuleStreamOnManagedInstanceResponse> handler)
        Disables a module stream on a managed instance.

        After the stream is disabled, it is no longer possible to install the profiles that are contained by the stream. All installed profiles must be removed prior to disabling a module stream.

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

        Future<EnableModuleStreamOnManagedInstanceResponse> enableModuleStreamOnManagedInstance​(EnableModuleStreamOnManagedInstanceRequest request,
                                                                                                AsyncHandler<EnableModuleStreamOnManagedInstanceRequest,​EnableModuleStreamOnManagedInstanceResponse> handler)
        Enables a module stream on a managed instance.

        After the stream is enabled, it is possible to install the profiles that are contained by the stream. Enabling a stream that is already enabled will succeed. Attempting to enable a different stream for a module that already has a stream enabled results in 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.
      • getErratum

        Future<GetErratumResponse> getErratum​(GetErratumRequest request,
                                              AsyncHandler<GetErratumRequest,​GetErratumResponse> handler)
        Returns a specific erratum.
        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.
      • getManagedInstance

        Future<GetManagedInstanceResponse> getManagedInstance​(GetManagedInstanceRequest request,
                                                              AsyncHandler<GetManagedInstanceRequest,​GetManagedInstanceResponse> handler)
        Returns a specific Managed Instance.
        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)
        Retrieve a detailed description of a module stream 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.
      • getModuleStreamProfile

        Future<GetModuleStreamProfileResponse> getModuleStreamProfile​(GetModuleStreamProfileRequest request,
                                                                      AsyncHandler<GetModuleStreamProfileRequest,​GetModuleStreamProfileResponse> handler)
        Retrieve a detailed description of a module stream profile 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.
      • getScheduledJob

        Future<GetScheduledJobResponse> getScheduledJob​(GetScheduledJobRequest request,
                                                        AsyncHandler<GetScheduledJobRequest,​GetScheduledJobResponse> handler)
        Gets the detailed information for the Scheduled Job with the given ID.
        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 a specific 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.
      • getSoftwareSource

        Future<GetSoftwareSourceResponse> getSoftwareSource​(GetSoftwareSourceRequest request,
                                                            AsyncHandler<GetSoftwareSourceRequest,​GetSoftwareSourceResponse> handler)
        Returns a specific 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.
      • getWindowsUpdate

        Future<GetWindowsUpdateResponse> getWindowsUpdate​(GetWindowsUpdateRequest request,
                                                          AsyncHandler<GetWindowsUpdateRequest,​GetWindowsUpdateResponse> handler)
        Returns a Windows Update object.
        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.
      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                                      AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Gets the detailed information for the work request with the given ID.
        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)
        Returns a list of all of the currently available Errata in the system
        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.
      • listManagedInstances

        Future<ListManagedInstancesResponse> listManagedInstances​(ListManagedInstancesRequest request,
                                                                  AsyncHandler<ListManagedInstancesRequest,​ListManagedInstancesResponse> handler)
        Returns a list of all Managed Instances.
        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)
        Retrieve a list of module stream profiles from a software source.

        Filters may be applied to select a subset of module stream profiles based on the filter criteria.

        The \"moduleName\", \"streamName\", and \"profileName\" attributes combine to form a set of filters on the list of module stream profiles. If a \"moduleName\" is provided, only profiles that belong to that module are returned. If both a \"moduleName\" and \"streamName\" are given, only profiles belonging to that module stream are returned. Finally, if all three are given then only the particular profile indicated by the triple is returned. It is not valid to supply a \"streamName\" without a \"moduleName\". It is also not valid to supply a \"profileName\" without a \"streamName\".

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

        Future<ListModuleStreamProfilesOnManagedInstanceResponse> listModuleStreamProfilesOnManagedInstance​(ListModuleStreamProfilesOnManagedInstanceRequest request,
                                                                                                            AsyncHandler<ListModuleStreamProfilesOnManagedInstanceRequest,​ListModuleStreamProfilesOnManagedInstanceResponse> handler)
        Retrieve a list of module stream profiles, along with a summary of their of their status, from a managed instance.

        Filters may be applied to select a subset of profiles based on the filter criteria.

        The \"moduleName\", \"streamName\", and \"profileName\" attributes combine to form a set of filters on the list of module stream profiles. If a \"modulName\" is provided, only profiles that belong to that module are returned. If both a \"moduleName\" and \"streamName\" are given, only profiles belonging to that module stream are returned. Finally, if all three are given then only the particular profile indicated by the triple is returned. It is not valid to supply a \"streamName\" without a \"moduleName\". It is also not valid to supply a \"profileName\" without a \"streamName\".

        The \"status\" attribute filters against the state of a module stream profile. Valid values are \"INSTALLED\" and \"AVAILABLE\". If the attribute is set to \"INSTALLED\", only module stream profiles that are installed are included in the result set. If the attribute is set to \"AVAILABLE\", only module stream profiles that are not installed are included in the result set. If the attribute is not defined, the request is not subject to this filter.

        When sorting by display name, the result set is sorted first by module name, then by stream name, and finally by 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)
        Retrieve a list of module streams from a software source.

        Filters may be applied to select a subset of module streams based on the filter criteria.

        The 'moduleName' attribute filters against the name of a module. It accepts strings of the format \"\". If this attribute is defined, only streams that belong to the specified module are included in the result set. If it is not defined, the request is not subject to this filter. The 'streamName' attribute filters against the name of a stream of a module. If this attribute is defined, only the particular module stream that matches both the module and stream names is included in the result set. It is not valid to supply 'streamName' without also supplying a 'moduleName'.

        When sorting by display name, the result set is sorted first by module name, then by 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.
      • listModuleStreamsOnManagedInstance

        Future<ListModuleStreamsOnManagedInstanceResponse> listModuleStreamsOnManagedInstance​(ListModuleStreamsOnManagedInstanceRequest request,
                                                                                              AsyncHandler<ListModuleStreamsOnManagedInstanceRequest,​ListModuleStreamsOnManagedInstanceResponse> handler)
        Retrieve a list of module streams, along with a summary of their status, from a managed instance.

        Filters may be applied to select a subset of module streams based on the filter criteria.

        The 'moduleName' attribute filters against the name of a module. It accepts strings of the format \"\". If this attribute is defined, only streams that belong to the specified module are included in the result set. If it is not defined, the request is not subject to this filter.

        The \"status\" attribute filters against the state of a module stream. Valid values are \"ENABLED\", \"DISABLED\", and \"ACTIVE\". If the attribute is set to \"ENABLED\", only module streams that are enabled are included in the result set. If the attribute is set to \"DISABLED\", only module streams that are not enabled are included in the result set. If the attribute is set to \"ACTIVE\", only module streams that are active are included in the result set. If the attribute is not defined, the request is not subject to this filter.

        When sorting by the display name, the result set is sorted first by the module name and then by the 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.
      • listScheduledJobs

        Future<ListScheduledJobsResponse> listScheduledJobs​(ListScheduledJobsRequest request,
                                                            AsyncHandler<ListScheduledJobsRequest,​ListScheduledJobsResponse> handler)
        Returns a list of all of the currently active Scheduled Jobs in the system
        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)
        Returns a list of all Software Sources.
        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.
      • listUpcomingScheduledJobs

        Future<ListUpcomingScheduledJobsResponse> listUpcomingScheduledJobs​(ListUpcomingScheduledJobsRequest request,
                                                                            AsyncHandler<ListUpcomingScheduledJobsRequest,​ListUpcomingScheduledJobsResponse> handler)
        Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.
        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.
      • listWindowsUpdates

        Future<ListWindowsUpdatesResponse> listWindowsUpdates​(ListWindowsUpdatesRequest request,
                                                              AsyncHandler<ListWindowsUpdatesRequest,​ListWindowsUpdatesResponse> handler)
        Returns a list of Windows Updates.
        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.
      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                                    AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Gets the errors for the work request with the given ID.
        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.
      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                                AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Lists the log entries for the work request with the given ID.
        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.
      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                          AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists the work requests in a compartment.
        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.
      • manageModuleStreamsOnManagedInstance

        Future<ManageModuleStreamsOnManagedInstanceResponse> manageModuleStreamsOnManagedInstance​(ManageModuleStreamsOnManagedInstanceRequest request,
                                                                                                  AsyncHandler<ManageModuleStreamsOnManagedInstanceRequest,​ManageModuleStreamsOnManagedInstanceResponse> handler)
        Perform an operation involving modules, streams, and profiles on a managed instance.

        Each operation may enable or disable an arbitrary amount of module streams, and install or remove an arbitrary number of module stream profiles. When the operation is complete, the state of the modules, streams, and profiles on the managed instance will match the state indicated in the operation.

        Each module stream specified in the list of module streams to enable will be in the \"ENABLED\" state upon completion of the operation. If there was already a stream of that module enabled, any work required to switch from the current stream to the new stream is performed implicitly.

        Each module stream specified in the list of module streams to disable will be in the \"DISABLED\" state upon completion of the operation. Any profiles that are installed for the module stream will be removed as part of the operation.

        Each module stream profile specified in the list of profiles to install will be in the \"INSTALLED\" state upon completion of the operation, indicating that any packages that are part of the profile are installed on the managed instance. If the module stream containing the profile is not enabled, it will be enabled as part of the operation. There is an exception when attempting to install a stream of a profile when another stream of the same module is enabled. It is an error to attempt to install a profile of another module stream, unless enabling the new module stream is explicitly included in this operation.

        Each module stream profile specified in the list of profiles to remove will be in the \"AVAILABLE\" state upon completion of the operation. The status of packages within the profile after the operation is complete is defined by the package manager on the managed instance.

        Operations that contain one or more elements that are not allowed are rejected.

        The result of this request is a WorkRequest object. The returned WorkRequest is the parent of a structure of other WorkRequests. Taken as a whole, this structure indicates the entire set of work to be performed to complete the operation.

        This interface can also be used to perform a dry run of the operation rather than committing it to a managed instance. If a dry run is requested, the OS Management Service will evaluate the operation against the current module, stream, and profile state on the managed instance. It will calculate the impact of the operation on all modules, streams, and profiles on the managed instance, including those that are implicitly impacted by the operation.

        The WorkRequest resulting from a dry run behaves differently than a WorkRequest resulting from a committable operation. Dry run WorkRequests are always singletons and never have children. The impact of the operation is returned using the log and error facilities of WorkRequests. The impact of operations that are allowed by the OS Management Service are communicated as one or more work request log entries. Operations that are not allowed by the OS Management Service are communicated as one or more work requst error entries. Each entry, for either logs or errors, contains a structured message containing the results of one or more operations.

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

        Future<RunScheduledJobNowResponse> runScheduledJobNow​(RunScheduledJobNowRequest request,
                                                              AsyncHandler<RunScheduledJobNowRequest,​RunScheduledJobNowResponse> handler)
        This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.
        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.
      • searchSoftwarePackages

        Future<SearchSoftwarePackagesResponse> searchSoftwarePackages​(SearchSoftwarePackagesRequest request,
                                                                      AsyncHandler<SearchSoftwarePackagesRequest,​SearchSoftwarePackagesResponse> handler)
        Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.
        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.
      • switchModuleStreamOnManagedInstance

        Future<SwitchModuleStreamOnManagedInstanceResponse> switchModuleStreamOnManagedInstance​(SwitchModuleStreamOnManagedInstanceRequest request,
                                                                                                AsyncHandler<SwitchModuleStreamOnManagedInstanceRequest,​SwitchModuleStreamOnManagedInstanceResponse> handler)
        Enables a new stream for a module that already has a stream enabled.

        If any profiles or packages from the original module are installed, switching to a new stream will remove the existing packages and install their counterparts in the new stream.

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

        Future<UpdateManagedInstanceResponse> updateManagedInstance​(UpdateManagedInstanceRequest request,
                                                                    AsyncHandler<UpdateManagedInstanceRequest,​UpdateManagedInstanceResponse> handler)
        Updates a specific Managed Instance.
        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.
      • updateScheduledJob

        Future<UpdateScheduledJobResponse> updateScheduledJob​(UpdateScheduledJobRequest request,
                                                              AsyncHandler<UpdateScheduledJobRequest,​UpdateScheduledJobResponse> handler)
        Updates an existing Scheduled Job on the management system.
        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 an existing custom Software Source on the management system.
        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.