OsManagementClient (Oracle Cloud Infrastructure SDK

java.lang.Object
- com.oracle.bmc.osmanagement.OsManagementClient

All Implemented Interfaces:: OsManagement, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190801")
public class OsManagementClient
extends Object
implements OsManagement

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OsManagementClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OsManagementClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for OsManagement.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for OsManagement.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`OsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`OsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`OsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddPackagesToSoftwareSourceResponse`	`addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request)` Adds a given list of Software Packages to a specific Software Source.
`AttachChildSoftwareSourceToManagedInstanceResponse`	`attachChildSoftwareSourceToManagedInstance(AttachChildSoftwareSourceToManagedInstanceRequest request)` Adds a child software source to a managed instance.
`AttachManagedInstanceToManagedInstanceGroupResponse`	`attachManagedInstanceToManagedInstanceGroup(AttachManagedInstanceToManagedInstanceGroupRequest request)` Adds a Managed Instance to a Managed Instance Group.
`AttachParentSoftwareSourceToManagedInstanceResponse`	`attachParentSoftwareSourceToManagedInstance(AttachParentSoftwareSourceToManagedInstanceRequest request)` Adds a parent software source to a managed instance.
`static OsManagementClient.Builder`	`builder()` Create a builder for this client.
`ChangeManagedInstanceGroupCompartmentResponse`	`changeManagedInstanceGroupCompartment(ChangeManagedInstanceGroupCompartmentRequest request)` Moves a resource into a different compartment.
`ChangeScheduledJobCompartmentResponse`	`changeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest request)` Moves a resource into a different compartment.
`ChangeSoftwareSourceCompartmentResponse`	`changeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request)` Moves a resource into a different compartment.
`void`	`close()`
`CreateManagedInstanceGroupResponse`	`createManagedInstanceGroup(CreateManagedInstanceGroupRequest request)` Creates a new Managed Instance Group on the management system.
`CreateScheduledJobResponse`	`createScheduledJob(CreateScheduledJobRequest request)` Creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups.
`CreateSoftwareSourceResponse`	`createSoftwareSource(CreateSoftwareSourceRequest request)` Creates a new custom Software Source on the management system.
`DeleteManagedInstanceGroupResponse`	`deleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest request)` Deletes a Managed Instance Group from the management system
`DeleteScheduledJobResponse`	`deleteScheduledJob(DeleteScheduledJobRequest request)` Cancels an existing Scheduled Job on the management system
`DeleteSoftwareSourceResponse`	`deleteSoftwareSource(DeleteSoftwareSourceRequest request)` Deletes a custom Software Source on the management system
`DetachChildSoftwareSourceFromManagedInstanceResponse`	`detachChildSoftwareSourceFromManagedInstance(DetachChildSoftwareSourceFromManagedInstanceRequest request)` Removes a child software source from a managed instance.
`DetachManagedInstanceFromManagedInstanceGroupResponse`	`detachManagedInstanceFromManagedInstanceGroup(DetachManagedInstanceFromManagedInstanceGroupRequest request)` Removes a Managed Instance from a Managed Instance Group.
`DetachParentSoftwareSourceFromManagedInstanceResponse`	`detachParentSoftwareSourceFromManagedInstance(DetachParentSoftwareSourceFromManagedInstanceRequest request)` Removes a software source from a managed instance.
`DisableModuleStreamOnManagedInstanceResponse`	`disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request)` Disables a module stream on a managed instance.
`EnableModuleStreamOnManagedInstanceResponse`	`enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request)` Enables a module stream on a managed instance.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetErratumResponse`	`getErratum(GetErratumRequest request)` Returns a specific erratum.
`GetManagedInstanceResponse`	`getManagedInstance(GetManagedInstanceRequest request)` Returns a specific Managed Instance.
`GetManagedInstanceGroupResponse`	`getManagedInstanceGroup(GetManagedInstanceGroupRequest request)` Returns a specific Managed Instance Group.
`GetModuleStreamResponse`	`getModuleStream(GetModuleStreamRequest request)` Retrieve a detailed description of a module stream from a software source.
`GetModuleStreamProfileResponse`	`getModuleStreamProfile(GetModuleStreamProfileRequest request)` Retrieve a detailed description of a module stream profile from a software source.
`OsManagementPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetScheduledJobResponse`	`getScheduledJob(GetScheduledJobRequest request)` Gets the detailed information for the Scheduled Job with the given ID.
`GetSoftwarePackageResponse`	`getSoftwarePackage(GetSoftwarePackageRequest request)` Returns a specific Software Package.
`GetSoftwareSourceResponse`	`getSoftwareSource(GetSoftwareSourceRequest request)` Returns a specific Software Source.
`OsManagementWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`GetWindowsUpdateResponse`	`getWindowsUpdate(GetWindowsUpdateRequest request)` Returns a Windows Update object.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)` Gets the detailed information for the work request with the given ID.
`InstallAllPackageUpdatesOnManagedInstanceResponse`	`installAllPackageUpdatesOnManagedInstance(InstallAllPackageUpdatesOnManagedInstanceRequest request)` Install all of the available package updates for the managed instance.
`InstallAllUpdatesOnManagedInstanceGroupResponse`	`installAllUpdatesOnManagedInstanceGroup(InstallAllUpdatesOnManagedInstanceGroupRequest request)` Install all of the available updates for the Managed Instance Group.
`InstallAllWindowsUpdatesOnManagedInstanceResponse`	`installAllWindowsUpdatesOnManagedInstance(InstallAllWindowsUpdatesOnManagedInstanceRequest request)` Install all of the available Windows updates for the managed instance.
`InstallModuleStreamProfileOnManagedInstanceResponse`	`installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request)` Installs a profile for an module stream.
`InstallPackageOnManagedInstanceResponse`	`installPackageOnManagedInstance(InstallPackageOnManagedInstanceRequest request)` Installs a package on a managed instance.
`InstallPackageUpdateOnManagedInstanceResponse`	`installPackageUpdateOnManagedInstance(InstallPackageUpdateOnManagedInstanceRequest request)` Updates a package on a managed instance.
`InstallWindowsUpdateOnManagedInstanceResponse`	`installWindowsUpdateOnManagedInstance(InstallWindowsUpdateOnManagedInstanceRequest request)` Installs a Windows update on a managed instance.
`ListAvailablePackagesForManagedInstanceResponse`	`listAvailablePackagesForManagedInstance(ListAvailablePackagesForManagedInstanceRequest request)` Returns a list of packages available for install on the Managed Instance.
`ListAvailableSoftwareSourcesForManagedInstanceResponse`	`listAvailableSoftwareSourcesForManagedInstance(ListAvailableSoftwareSourcesForManagedInstanceRequest request)` Returns a list of available software sources for a Managed Instance.
`ListAvailableUpdatesForManagedInstanceResponse`	`listAvailableUpdatesForManagedInstance(ListAvailableUpdatesForManagedInstanceRequest request)` Returns a list of available updates for a Managed Instance.
`ListAvailableWindowsUpdatesForManagedInstanceResponse`	`listAvailableWindowsUpdatesForManagedInstance(ListAvailableWindowsUpdatesForManagedInstanceRequest request)` Returns a list of available Windows updates for a Managed Instance.
`ListErrataResponse`	`listErrata(ListErrataRequest request)` Returns a list of all of the currently available Errata in the system
`ListManagedInstanceErrataResponse`	`listManagedInstanceErrata(ListManagedInstanceErrataRequest request)` Returns a list of errata relevant to the Managed Instance.
`ListManagedInstanceGroupsResponse`	`listManagedInstanceGroups(ListManagedInstanceGroupsRequest request)` Returns a list of all Managed Instance Groups.
`ListManagedInstancesResponse`	`listManagedInstances(ListManagedInstancesRequest request)` Returns a list of all Managed Instances.
`ListModuleStreamProfilesResponse`	`listModuleStreamProfiles(ListModuleStreamProfilesRequest request)` Retrieve a list of module stream profiles from a software source.
`ListModuleStreamProfilesOnManagedInstanceResponse`	`listModuleStreamProfilesOnManagedInstance(ListModuleStreamProfilesOnManagedInstanceRequest request)` Retrieve a list of module stream profiles, along with a summary of their of their status, from a managed instance.
`ListModuleStreamsResponse`	`listModuleStreams(ListModuleStreamsRequest request)` Retrieve a list of module streams from a software source.
`ListModuleStreamsOnManagedInstanceResponse`	`listModuleStreamsOnManagedInstance(ListModuleStreamsOnManagedInstanceRequest request)` Retrieve a list of module streams, along with a summary of their status, from a managed instance.
`ListPackagesInstalledOnManagedInstanceResponse`	`listPackagesInstalledOnManagedInstance(ListPackagesInstalledOnManagedInstanceRequest request)` Returns a list of installed packages on the Managed Instance.
`ListScheduledJobsResponse`	`listScheduledJobs(ListScheduledJobsRequest request)` Returns a list of all of the currently active Scheduled Jobs in the system
`ListSoftwareSourcePackagesResponse`	`listSoftwareSourcePackages(ListSoftwareSourcePackagesRequest request)` Lists Software Packages in a Software Source
`ListSoftwareSourcesResponse`	`listSoftwareSources(ListSoftwareSourcesRequest request)` Returns a list of all Software Sources.
`ListUpcomingScheduledJobsResponse`	`listUpcomingScheduledJobs(ListUpcomingScheduledJobsRequest request)` Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.
`ListWindowsUpdatesResponse`	`listWindowsUpdates(ListWindowsUpdatesRequest request)` Returns a list of Windows Updates.
`ListWindowsUpdatesInstalledOnManagedInstanceResponse`	`listWindowsUpdatesInstalledOnManagedInstance(ListWindowsUpdatesInstalledOnManagedInstanceRequest request)` Returns a list of installed Windows updates for a Managed Instance.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)` Gets the errors for the work request with the given ID.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)` Lists the log entries for the work request with the given ID.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)` Lists the work requests in a compartment.
`ManageModuleStreamsOnManagedInstanceResponse`	`manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request)` Perform an operation involving modules, streams, and profiles on a managed instance.
`void`	`refreshClient()` Rebuilds the client from scratch.
`RemoveModuleStreamProfileFromManagedInstanceResponse`	`removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request)` Removes a profile for a module stream that is installed on a managed instance.
`RemovePackageFromManagedInstanceResponse`	`removePackageFromManagedInstance(RemovePackageFromManagedInstanceRequest request)` Removes an installed package from a managed instance.
`RemovePackagesFromSoftwareSourceResponse`	`removePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest request)` Removes a given list of Software Packages from a specific Software Source.
`RunScheduledJobNowResponse`	`runScheduledJobNow(RunScheduledJobNowRequest request)` This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.
`SearchSoftwarePackagesResponse`	`searchSoftwarePackages(SearchSoftwarePackagesRequest request)` Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`SkipNextScheduledJobExecutionResponse`	`skipNextScheduledJobExecution(SkipNextScheduledJobExecutionRequest request)` This will force an already created Scheduled Job to skip its next regularly scheduled execution
`SwitchModuleStreamOnManagedInstanceResponse`	`switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request)` Enables a new stream for a module that already has a stream enabled.
`UpdateManagedInstanceResponse`	`updateManagedInstance(UpdateManagedInstanceRequest request)` Updates a specific Managed Instance.
`UpdateManagedInstanceGroupResponse`	`updateManagedInstanceGroup(UpdateManagedInstanceGroupRequest request)` Updates a specific Managed Instance Group.
`UpdateScheduledJobResponse`	`updateScheduledJob(UpdateScheduledJobRequest request)` Updates an existing Scheduled Job on the management system.
`UpdateSoftwareSourceResponse`	`updateSoftwareSource(UpdateSoftwareSourceRequest request)` Updates an existing custom Software Source on the management system.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for OsManagement.
- Constructor Detail
  - OsManagementClient
```
public OsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - OsManagementClient
```
public OsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - OsManagementClient
```
public OsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - OsManagementClient
```
public OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - OsManagementClient
```
public OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - OsManagementClient
```
public OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - OsManagementClient
```
public OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - OsManagementClient
```
public OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint,
                          ExecutorService executorService)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - OsManagementClient
```
protected OsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             ExecutorService executorService,
                             RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the OsManagementClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static OsManagementClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: OsManagement
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface OsManagement
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: OsManagement
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface OsManagement
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: OsManagement
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface OsManagement
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    setRegion in interface OsManagement
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    setRegion in interface OsManagement
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - addPackagesToSoftwareSource
```
public AddPackagesToSoftwareSourceResponse addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request)
```
    Description copied from interface: OsManagement
    
    Adds a given list of Software Packages to a specific Software Source.
    
    Specified by:
    
    addPackagesToSoftwareSource in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - attachChildSoftwareSourceToManagedInstance
```
public AttachChildSoftwareSourceToManagedInstanceResponse attachChildSoftwareSourceToManagedInstance(AttachChildSoftwareSourceToManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Adds a child software source to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance.
    
    Specified by:
    
    attachChildSoftwareSourceToManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - attachManagedInstanceToManagedInstanceGroup
```
public AttachManagedInstanceToManagedInstanceGroupResponse attachManagedInstanceToManagedInstanceGroup(AttachManagedInstanceToManagedInstanceGroupRequest request)
```
    Description copied from interface: OsManagement
    
    Adds a Managed Instance to a Managed Instance Group. After the Managed Instance has been added, then operations can be performed on the Managed Instance Group which will then apply to all Managed Instances in the group.
    
    Specified by:
    
    attachManagedInstanceToManagedInstanceGroup in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - attachParentSoftwareSourceToManagedInstance
```
public AttachParentSoftwareSourceToManagedInstanceResponse attachParentSoftwareSourceToManagedInstance(AttachParentSoftwareSourceToManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Adds a parent software source to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance. Software sources that have this software source as a parent will be able to be added to this managed instance.
    
    Specified by:
    
    attachParentSoftwareSourceToManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeManagedInstanceGroupCompartment
```
public ChangeManagedInstanceGroupCompartmentResponse changeManagedInstanceGroupCompartment(ChangeManagedInstanceGroupCompartmentRequest request)
```
    Description copied from interface: OsManagement
    
    Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    changeManagedInstanceGroupCompartment in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeScheduledJobCompartment
```
public ChangeScheduledJobCompartmentResponse changeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest request)
```
    Description copied from interface: OsManagement
    
    Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    changeScheduledJobCompartment in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeSoftwareSourceCompartment
```
public ChangeSoftwareSourceCompartmentResponse changeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request)
```
    Description copied from interface: OsManagement
    
    Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    changeSoftwareSourceCompartment in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createManagedInstanceGroup
```
public CreateManagedInstanceGroupResponse createManagedInstanceGroup(CreateManagedInstanceGroupRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    createManagedInstanceGroup in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createScheduledJob
```
public CreateScheduledJobResponse createScheduledJob(CreateScheduledJobRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    createScheduledJob in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createSoftwareSource
```
public CreateSoftwareSourceResponse createSoftwareSource(CreateSoftwareSourceRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    createSoftwareSource in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteManagedInstanceGroup
```
public DeleteManagedInstanceGroupResponse deleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest request)
```
    Description copied from interface: OsManagement
    
    Deletes a Managed Instance Group from the management system
    
    Specified by:
    
    deleteManagedInstanceGroup in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteScheduledJob
```
public DeleteScheduledJobResponse deleteScheduledJob(DeleteScheduledJobRequest request)
```
    Description copied from interface: OsManagement
    
    Cancels an existing Scheduled Job on the management system
    
    Specified by:
    
    deleteScheduledJob in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteSoftwareSource
```
public DeleteSoftwareSourceResponse deleteSoftwareSource(DeleteSoftwareSourceRequest request)
```
    Description copied from interface: OsManagement
    
    Deletes a custom Software Source on the management system
    
    Specified by:
    
    deleteSoftwareSource in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - detachChildSoftwareSourceFromManagedInstance
```
public DetachChildSoftwareSourceFromManagedInstanceResponse detachChildSoftwareSourceFromManagedInstance(DetachChildSoftwareSourceFromManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Removes a child software source from a managed instance. Packages will no longer be able to be installed from these software sources.
    
    Specified by:
    
    detachChildSoftwareSourceFromManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - detachManagedInstanceFromManagedInstanceGroup
```
public DetachManagedInstanceFromManagedInstanceGroupResponse detachManagedInstanceFromManagedInstanceGroup(DetachManagedInstanceFromManagedInstanceGroupRequest request)
```
    Description copied from interface: OsManagement
    
    Removes a Managed Instance from a Managed Instance Group.
    
    Specified by:
    
    detachManagedInstanceFromManagedInstanceGroup in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - detachParentSoftwareSourceFromManagedInstance
```
public DetachParentSoftwareSourceFromManagedInstanceResponse detachParentSoftwareSourceFromManagedInstance(DetachParentSoftwareSourceFromManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Removes a software source from a managed instance. All child software sources will also be removed from the managed instance. Packages will no longer be able to be installed from these software sources.
    
    Specified by:
    
    detachParentSoftwareSourceFromManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - disableModuleStreamOnManagedInstance
```
public DisableModuleStreamOnManagedInstanceResponse disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    disableModuleStreamOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - enableModuleStreamOnManagedInstance
```
public EnableModuleStreamOnManagedInstanceResponse enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    enableModuleStreamOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getErratum
```
public GetErratumResponse getErratum(GetErratumRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a specific erratum.
    
    Specified by:
    
    getErratum in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getManagedInstance
```
public GetManagedInstanceResponse getManagedInstance(GetManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a specific Managed Instance.
    
    Specified by:
    
    getManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getManagedInstanceGroup
```
public GetManagedInstanceGroupResponse getManagedInstanceGroup(GetManagedInstanceGroupRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a specific Managed Instance Group.
    
    Specified by:
    
    getManagedInstanceGroup in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getModuleStream
```
public GetModuleStreamResponse getModuleStream(GetModuleStreamRequest request)
```
    Description copied from interface: OsManagement
    
    Retrieve a detailed description of a module stream from a software source.
    
    Specified by:
    
    getModuleStream in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getModuleStreamProfile
```
public GetModuleStreamProfileResponse getModuleStreamProfile(GetModuleStreamProfileRequest request)
```
    Description copied from interface: OsManagement
    
    Retrieve a detailed description of a module stream profile from a software source.
    
    Specified by:
    
    getModuleStreamProfile in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getScheduledJob
```
public GetScheduledJobResponse getScheduledJob(GetScheduledJobRequest request)
```
    Description copied from interface: OsManagement
    
    Gets the detailed information for the Scheduled Job with the given ID.
    
    Specified by:
    
    getScheduledJob in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSoftwarePackage
```
public GetSoftwarePackageResponse getSoftwarePackage(GetSoftwarePackageRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a specific Software Package.
    
    Specified by:
    
    getSoftwarePackage in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSoftwareSource
```
public GetSoftwareSourceResponse getSoftwareSource(GetSoftwareSourceRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a specific Software Source.
    
    Specified by:
    
    getSoftwareSource in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWindowsUpdate
```
public GetWindowsUpdateResponse getWindowsUpdate(GetWindowsUpdateRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a Windows Update object.
    
    Specified by:
    
    getWindowsUpdate in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: OsManagement
    
    Gets the detailed information for the work request with the given ID.
    
    Specified by:
    
    getWorkRequest in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - installAllPackageUpdatesOnManagedInstance
```
public InstallAllPackageUpdatesOnManagedInstanceResponse installAllPackageUpdatesOnManagedInstance(InstallAllPackageUpdatesOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Install all of the available package updates for the managed instance.
    
    Specified by:
    
    installAllPackageUpdatesOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - installAllUpdatesOnManagedInstanceGroup
```
public InstallAllUpdatesOnManagedInstanceGroupResponse installAllUpdatesOnManagedInstanceGroup(InstallAllUpdatesOnManagedInstanceGroupRequest request)
```
    Description copied from interface: OsManagement
    
    Install all of the available updates for the Managed Instance Group.
    
    Specified by:
    
    installAllUpdatesOnManagedInstanceGroup in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - installAllWindowsUpdatesOnManagedInstance
```
public InstallAllWindowsUpdatesOnManagedInstanceResponse installAllWindowsUpdatesOnManagedInstance(InstallAllWindowsUpdatesOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Install all of the available Windows updates for the managed instance.
    
    Specified by:
    
    installAllWindowsUpdatesOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - installModuleStreamProfileOnManagedInstance
```
public InstallModuleStreamProfileOnManagedInstanceResponse installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Installs a profile for an module stream. The stream must be enabled before a profile can be installed. If a module stream defines multiple profiles, each one can be installed independently.
    
    Specified by:
    
    installModuleStreamProfileOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - installPackageOnManagedInstance
```
public InstallPackageOnManagedInstanceResponse installPackageOnManagedInstance(InstallPackageOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Installs a package on a managed instance.
    
    Specified by:
    
    installPackageOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - installPackageUpdateOnManagedInstance
```
public InstallPackageUpdateOnManagedInstanceResponse installPackageUpdateOnManagedInstance(InstallPackageUpdateOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Updates a package on a managed instance.
    
    Specified by:
    
    installPackageUpdateOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - installWindowsUpdateOnManagedInstance
```
public InstallWindowsUpdateOnManagedInstanceResponse installWindowsUpdateOnManagedInstance(InstallWindowsUpdateOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Installs a Windows update on a managed instance.
    
    Specified by:
    
    installWindowsUpdateOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listAvailablePackagesForManagedInstance
```
public ListAvailablePackagesForManagedInstanceResponse listAvailablePackagesForManagedInstance(ListAvailablePackagesForManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of packages available for install on the Managed Instance.
    
    Specified by:
    
    listAvailablePackagesForManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listAvailableSoftwareSourcesForManagedInstance
```
public ListAvailableSoftwareSourcesForManagedInstanceResponse listAvailableSoftwareSourcesForManagedInstance(ListAvailableSoftwareSourcesForManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of available software sources for a Managed Instance.
    
    Specified by:
    
    listAvailableSoftwareSourcesForManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listAvailableUpdatesForManagedInstance
```
public ListAvailableUpdatesForManagedInstanceResponse listAvailableUpdatesForManagedInstance(ListAvailableUpdatesForManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of available updates for a Managed Instance.
    
    Specified by:
    
    listAvailableUpdatesForManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listAvailableWindowsUpdatesForManagedInstance
```
public ListAvailableWindowsUpdatesForManagedInstanceResponse listAvailableWindowsUpdatesForManagedInstance(ListAvailableWindowsUpdatesForManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of available Windows updates for a Managed Instance. This is only applicable to Windows instances.
    
    Specified by:
    
    listAvailableWindowsUpdatesForManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listErrata
```
public ListErrataResponse listErrata(ListErrataRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of all of the currently available Errata in the system
    
    Specified by:
    
    listErrata in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listManagedInstanceErrata
```
public ListManagedInstanceErrataResponse listManagedInstanceErrata(ListManagedInstanceErrataRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of errata relevant to the Managed Instance.
    
    Specified by:
    
    listManagedInstanceErrata in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listManagedInstanceGroups
```
public ListManagedInstanceGroupsResponse listManagedInstanceGroups(ListManagedInstanceGroupsRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of all Managed Instance Groups.
    
    Specified by:
    
    listManagedInstanceGroups in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listManagedInstances
```
public ListManagedInstancesResponse listManagedInstances(ListManagedInstancesRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of all Managed Instances.
    
    Specified by:
    
    listManagedInstances in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listModuleStreamProfiles
```
public ListModuleStreamProfilesResponse listModuleStreamProfiles(ListModuleStreamProfilesRequest request)
```
    Description copied from interface: OsManagement
    
    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\".
    
    Specified by:
    
    listModuleStreamProfiles in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listModuleStreamProfilesOnManagedInstance
```
public ListModuleStreamProfilesOnManagedInstanceResponse listModuleStreamProfilesOnManagedInstance(ListModuleStreamProfilesOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    listModuleStreamProfilesOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listModuleStreams
```
public ListModuleStreamsResponse listModuleStreams(ListModuleStreamsRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    listModuleStreams in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listModuleStreamsOnManagedInstance
```
public ListModuleStreamsOnManagedInstanceResponse listModuleStreamsOnManagedInstance(ListModuleStreamsOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    listModuleStreamsOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listPackagesInstalledOnManagedInstance
```
public ListPackagesInstalledOnManagedInstanceResponse listPackagesInstalledOnManagedInstance(ListPackagesInstalledOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of installed packages on the Managed Instance.
    
    Specified by:
    
    listPackagesInstalledOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listScheduledJobs
```
public ListScheduledJobsResponse listScheduledJobs(ListScheduledJobsRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of all of the currently active Scheduled Jobs in the system
    
    Specified by:
    
    listScheduledJobs in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSoftwareSourcePackages
```
public ListSoftwareSourcePackagesResponse listSoftwareSourcePackages(ListSoftwareSourcePackagesRequest request)
```
    Description copied from interface: OsManagement
    
    Lists Software Packages in a Software Source
    
    Specified by:
    
    listSoftwareSourcePackages in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSoftwareSources
```
public ListSoftwareSourcesResponse listSoftwareSources(ListSoftwareSourcesRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of all Software Sources.
    
    Specified by:
    
    listSoftwareSources in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listUpcomingScheduledJobs
```
public ListUpcomingScheduledJobsResponse listUpcomingScheduledJobs(ListUpcomingScheduledJobsRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.
    
    Specified by:
    
    listUpcomingScheduledJobs in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWindowsUpdates
```
public ListWindowsUpdatesResponse listWindowsUpdates(ListWindowsUpdatesRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of Windows Updates.
    
    Specified by:
    
    listWindowsUpdates in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWindowsUpdatesInstalledOnManagedInstance
```
public ListWindowsUpdatesInstalledOnManagedInstanceResponse listWindowsUpdatesInstalledOnManagedInstance(ListWindowsUpdatesInstalledOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Returns a list of installed Windows updates for a Managed Instance. This is only applicable to Windows instances.
    
    Specified by:
    
    listWindowsUpdatesInstalledOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: OsManagement
    
    Gets the errors for the work request with the given ID.
    
    Specified by:
    
    listWorkRequestErrors in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: OsManagement
    
    Lists the log entries for the work request with the given ID.
    
    Specified by:
    
    listWorkRequestLogs in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: OsManagement
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - manageModuleStreamsOnManagedInstance
```
public ManageModuleStreamsOnManagedInstanceResponse manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    manageModuleStreamsOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeModuleStreamProfileFromManagedInstance
```
public RemoveModuleStreamProfileFromManagedInstanceResponse removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Removes a profile for a module stream that is installed on a managed instance. If a module stream is provided, rather than a fully qualified profile, all profiles that have been installed for the module stream will be removed.
    
    Specified by:
    
    removeModuleStreamProfileFromManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removePackageFromManagedInstance
```
public RemovePackageFromManagedInstanceResponse removePackageFromManagedInstance(RemovePackageFromManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Removes an installed package from a managed instance.
    
    Specified by:
    
    removePackageFromManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removePackagesFromSoftwareSource
```
public RemovePackagesFromSoftwareSourceResponse removePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest request)
```
    Description copied from interface: OsManagement
    
    Removes a given list of Software Packages from a specific Software Source.
    
    Specified by:
    
    removePackagesFromSoftwareSource in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - runScheduledJobNow
```
public RunScheduledJobNowResponse runScheduledJobNow(RunScheduledJobNowRequest request)
```
    Description copied from interface: OsManagement
    
    This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.
    
    Specified by:
    
    runScheduledJobNow in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - searchSoftwarePackages
```
public SearchSoftwarePackagesResponse searchSoftwarePackages(SearchSoftwarePackagesRequest request)
```
    Description copied from interface: OsManagement
    
    Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.
    
    Specified by:
    
    searchSoftwarePackages in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - skipNextScheduledJobExecution
```
public SkipNextScheduledJobExecutionResponse skipNextScheduledJobExecution(SkipNextScheduledJobExecutionRequest request)
```
    Description copied from interface: OsManagement
    
    This will force an already created Scheduled Job to skip its next regularly scheduled execution
    
    Specified by:
    
    skipNextScheduledJobExecution in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - switchModuleStreamOnManagedInstance
```
public SwitchModuleStreamOnManagedInstanceResponse switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    switchModuleStreamOnManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateManagedInstance
```
public UpdateManagedInstanceResponse updateManagedInstance(UpdateManagedInstanceRequest request)
```
    Description copied from interface: OsManagement
    
    Updates a specific Managed Instance.
    
    Specified by:
    
    updateManagedInstance in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateManagedInstanceGroup
```
public UpdateManagedInstanceGroupResponse updateManagedInstanceGroup(UpdateManagedInstanceGroupRequest request)
```
    Description copied from interface: OsManagement
    
    Updates a specific Managed Instance Group.
    
    Specified by:
    
    updateManagedInstanceGroup in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateScheduledJob
```
public UpdateScheduledJobResponse updateScheduledJob(UpdateScheduledJobRequest request)
```
    Description copied from interface: OsManagement
    
    Updates an existing Scheduled Job on the management system.
    
    Specified by:
    
    updateScheduledJob in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateSoftwareSource
```
public UpdateSoftwareSourceResponse updateSoftwareSource(UpdateSoftwareSourceRequest request)
```
    Description copied from interface: OsManagement
    
    Updates an existing custom Software Source on the management system.
    
    Specified by:
    
    updateSoftwareSource in interface OsManagement
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public OsManagementWaiters getWaiters()
```
    Description copied from interface: OsManagement
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface OsManagement
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public OsManagementPaginators getPaginators()
```
    Description copied from interface: OsManagement
    
    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.
    
    Specified by:
    
    getPaginators in interface OsManagement
    
    Returns:
    
    The service paginators.

Class OsManagementClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

OsManagementClient

OsManagementClient

OsManagementClient

OsManagementClient

OsManagementClient

OsManagementClient

OsManagementClient

OsManagementClient

OsManagementClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

addPackagesToSoftwareSource

attachChildSoftwareSourceToManagedInstance

attachManagedInstanceToManagedInstanceGroup

attachParentSoftwareSourceToManagedInstance

changeManagedInstanceGroupCompartment

changeScheduledJobCompartment

changeSoftwareSourceCompartment

createManagedInstanceGroup

createScheduledJob

createSoftwareSource

deleteManagedInstanceGroup

deleteScheduledJob

deleteSoftwareSource

detachChildSoftwareSourceFromManagedInstance

detachManagedInstanceFromManagedInstanceGroup

detachParentSoftwareSourceFromManagedInstance

disableModuleStreamOnManagedInstance

enableModuleStreamOnManagedInstance

getErratum

getManagedInstance

getManagedInstanceGroup

getModuleStream

getModuleStreamProfile

getScheduledJob

getSoftwarePackage

getSoftwareSource

getWindowsUpdate

getWorkRequest

installAllPackageUpdatesOnManagedInstance

installAllUpdatesOnManagedInstanceGroup

installAllWindowsUpdatesOnManagedInstance

installModuleStreamProfileOnManagedInstance

installPackageOnManagedInstance

installPackageUpdateOnManagedInstance

installWindowsUpdateOnManagedInstance

listAvailablePackagesForManagedInstance

listAvailableSoftwareSourcesForManagedInstance

listAvailableUpdatesForManagedInstance

listAvailableWindowsUpdatesForManagedInstance

listErrata

listManagedInstanceErrata

listManagedInstanceGroups

listManagedInstances

listModuleStreamProfiles

listModuleStreamProfilesOnManagedInstance

listModuleStreams

listModuleStreamsOnManagedInstance

listPackagesInstalledOnManagedInstance

listScheduledJobs

listSoftwareSourcePackages

listSoftwareSources

listUpcomingScheduledJobs

listWindowsUpdates

listWindowsUpdatesInstalledOnManagedInstance