@Generated(value="OracleSDKGenerator", comments="API Version: 20190801") public class OsManagementAsyncClient extends BaseAsyncClient implements OsManagementAsync
Async client implementation for OsManagement service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response
to the call is an InputStream
, like getObject Api in object storage service,
developers need to process the stream in AsyncHandler, and not anywhere else, because the stream
will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done
with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or
the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the
AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine
whether or not the request was completed via Future.isDone/isCancelled.
Please refer to
https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
Modifier and Type | Class and Description |
---|---|
static class |
OsManagementAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for OsManagement.
|
Constructor and Description |
---|
OsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
OsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
OsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
OsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
OsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
OsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
OsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for OsManagement.
public final String clientCommonLibraryVersion
@Deprecated public OsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OsManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public OsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OsManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public OsManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OsManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public OsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OsManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public OsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OsManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public OsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OsManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public OsManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see OsManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
public static OsManagementAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
OsManagementAsync
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.
setRegion
in interface OsManagementAsync
region
- The region of the service.public void setRegion(String regionId)
OsManagementAsync
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
.
setRegion
in interface OsManagementAsync
regionId
- The public region ID.public Future<AddPackagesToSoftwareSourceResponse> addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request, AsyncHandler<AddPackagesToSoftwareSourceRequest,AddPackagesToSoftwareSourceResponse> handler)
OsManagementAsync
Adds a given list of Software Packages to a specific Software Source.
addPackagesToSoftwareSource
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AttachChildSoftwareSourceToManagedInstanceResponse> attachChildSoftwareSourceToManagedInstance(AttachChildSoftwareSourceToManagedInstanceRequest request, AsyncHandler<AttachChildSoftwareSourceToManagedInstanceRequest,AttachChildSoftwareSourceToManagedInstanceResponse> handler)
OsManagementAsync
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.
attachChildSoftwareSourceToManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AttachManagedInstanceToManagedInstanceGroupResponse> attachManagedInstanceToManagedInstanceGroup(AttachManagedInstanceToManagedInstanceGroupRequest request, AsyncHandler<AttachManagedInstanceToManagedInstanceGroupRequest,AttachManagedInstanceToManagedInstanceGroupResponse> handler)
OsManagementAsync
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.
attachManagedInstanceToManagedInstanceGroup
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<AttachParentSoftwareSourceToManagedInstanceResponse> attachParentSoftwareSourceToManagedInstance(AttachParentSoftwareSourceToManagedInstanceRequest request, AsyncHandler<AttachParentSoftwareSourceToManagedInstanceRequest,AttachParentSoftwareSourceToManagedInstanceResponse> handler)
OsManagementAsync
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.
attachParentSoftwareSourceToManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeManagedInstanceGroupCompartmentResponse> changeManagedInstanceGroupCompartment(ChangeManagedInstanceGroupCompartmentRequest request, AsyncHandler<ChangeManagedInstanceGroupCompartmentRequest,ChangeManagedInstanceGroupCompartmentResponse> handler)
OsManagementAsync
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeManagedInstanceGroupCompartment
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeScheduledJobCompartmentResponse> changeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest request, AsyncHandler<ChangeScheduledJobCompartmentRequest,ChangeScheduledJobCompartmentResponse> handler)
OsManagementAsync
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeScheduledJobCompartment
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeSoftwareSourceCompartmentResponse> changeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request, AsyncHandler<ChangeSoftwareSourceCompartmentRequest,ChangeSoftwareSourceCompartmentResponse> handler)
OsManagementAsync
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeSoftwareSourceCompartment
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateManagedInstanceGroupResponse> createManagedInstanceGroup(CreateManagedInstanceGroupRequest request, AsyncHandler<CreateManagedInstanceGroupRequest,CreateManagedInstanceGroupResponse> handler)
OsManagementAsync
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.
createManagedInstanceGroup
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateScheduledJobResponse> createScheduledJob(CreateScheduledJobRequest request, AsyncHandler<CreateScheduledJobRequest,CreateScheduledJobResponse> handler)
OsManagementAsync
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.
createScheduledJob
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateSoftwareSourceResponse> createSoftwareSource(CreateSoftwareSourceRequest request, AsyncHandler<CreateSoftwareSourceRequest,CreateSoftwareSourceResponse> handler)
OsManagementAsync
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.
createSoftwareSource
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteManagedInstanceGroupResponse> deleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest request, AsyncHandler<DeleteManagedInstanceGroupRequest,DeleteManagedInstanceGroupResponse> handler)
OsManagementAsync
Deletes a Managed Instance Group from the management system
deleteManagedInstanceGroup
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteScheduledJobResponse> deleteScheduledJob(DeleteScheduledJobRequest request, AsyncHandler<DeleteScheduledJobRequest,DeleteScheduledJobResponse> handler)
OsManagementAsync
Cancels an existing Scheduled Job on the management system
deleteScheduledJob
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteSoftwareSourceResponse> deleteSoftwareSource(DeleteSoftwareSourceRequest request, AsyncHandler<DeleteSoftwareSourceRequest,DeleteSoftwareSourceResponse> handler)
OsManagementAsync
Deletes a custom Software Source on the management system
deleteSoftwareSource
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DetachChildSoftwareSourceFromManagedInstanceResponse> detachChildSoftwareSourceFromManagedInstance(DetachChildSoftwareSourceFromManagedInstanceRequest request, AsyncHandler<DetachChildSoftwareSourceFromManagedInstanceRequest,DetachChildSoftwareSourceFromManagedInstanceResponse> handler)
OsManagementAsync
Removes a child software source from a managed instance. Packages will no longer be able to be installed from these software sources.
detachChildSoftwareSourceFromManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DetachManagedInstanceFromManagedInstanceGroupResponse> detachManagedInstanceFromManagedInstanceGroup(DetachManagedInstanceFromManagedInstanceGroupRequest request, AsyncHandler<DetachManagedInstanceFromManagedInstanceGroupRequest,DetachManagedInstanceFromManagedInstanceGroupResponse> handler)
OsManagementAsync
Removes a Managed Instance from a Managed Instance Group.
detachManagedInstanceFromManagedInstanceGroup
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DetachParentSoftwareSourceFromManagedInstanceResponse> detachParentSoftwareSourceFromManagedInstance(DetachParentSoftwareSourceFromManagedInstanceRequest request, AsyncHandler<DetachParentSoftwareSourceFromManagedInstanceRequest,DetachParentSoftwareSourceFromManagedInstanceResponse> handler)
OsManagementAsync
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.
detachParentSoftwareSourceFromManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DisableModuleStreamOnManagedInstanceResponse> disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request, AsyncHandler<DisableModuleStreamOnManagedInstanceRequest,DisableModuleStreamOnManagedInstanceResponse> handler)
OsManagementAsync
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.
disableModuleStreamOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<EnableModuleStreamOnManagedInstanceResponse> enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request, AsyncHandler<EnableModuleStreamOnManagedInstanceRequest,EnableModuleStreamOnManagedInstanceResponse> handler)
OsManagementAsync
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.
enableModuleStreamOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetErratumResponse> getErratum(GetErratumRequest request, AsyncHandler<GetErratumRequest,GetErratumResponse> handler)
OsManagementAsync
Returns a specific erratum.
getErratum
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetManagedInstanceResponse> getManagedInstance(GetManagedInstanceRequest request, AsyncHandler<GetManagedInstanceRequest,GetManagedInstanceResponse> handler)
OsManagementAsync
Returns a specific Managed Instance.
getManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetManagedInstanceGroupResponse> getManagedInstanceGroup(GetManagedInstanceGroupRequest request, AsyncHandler<GetManagedInstanceGroupRequest,GetManagedInstanceGroupResponse> handler)
OsManagementAsync
Returns a specific Managed Instance Group.
getManagedInstanceGroup
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetModuleStreamResponse> getModuleStream(GetModuleStreamRequest request, AsyncHandler<GetModuleStreamRequest,GetModuleStreamResponse> handler)
OsManagementAsync
Retrieve a detailed description of a module stream from a software source.
getModuleStream
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetModuleStreamProfileResponse> getModuleStreamProfile(GetModuleStreamProfileRequest request, AsyncHandler<GetModuleStreamProfileRequest,GetModuleStreamProfileResponse> handler)
OsManagementAsync
Retrieve a detailed description of a module stream profile from a software source.
getModuleStreamProfile
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetScheduledJobResponse> getScheduledJob(GetScheduledJobRequest request, AsyncHandler<GetScheduledJobRequest,GetScheduledJobResponse> handler)
OsManagementAsync
Gets the detailed information for the Scheduled Job with the given ID.
getScheduledJob
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetSoftwarePackageResponse> getSoftwarePackage(GetSoftwarePackageRequest request, AsyncHandler<GetSoftwarePackageRequest,GetSoftwarePackageResponse> handler)
OsManagementAsync
Returns a specific Software Package.
getSoftwarePackage
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetSoftwareSourceResponse> getSoftwareSource(GetSoftwareSourceRequest request, AsyncHandler<GetSoftwareSourceRequest,GetSoftwareSourceResponse> handler)
OsManagementAsync
Returns a specific Software Source.
getSoftwareSource
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWindowsUpdateResponse> getWindowsUpdate(GetWindowsUpdateRequest request, AsyncHandler<GetWindowsUpdateRequest,GetWindowsUpdateResponse> handler)
OsManagementAsync
Returns a Windows Update object.
getWindowsUpdate
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
OsManagementAsync
Gets the detailed information for the work request with the given ID.
getWorkRequest
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<InstallAllPackageUpdatesOnManagedInstanceResponse> installAllPackageUpdatesOnManagedInstance(InstallAllPackageUpdatesOnManagedInstanceRequest request, AsyncHandler<InstallAllPackageUpdatesOnManagedInstanceRequest,InstallAllPackageUpdatesOnManagedInstanceResponse> handler)
OsManagementAsync
Install all of the available package updates for the managed instance.
installAllPackageUpdatesOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<InstallAllUpdatesOnManagedInstanceGroupResponse> installAllUpdatesOnManagedInstanceGroup(InstallAllUpdatesOnManagedInstanceGroupRequest request, AsyncHandler<InstallAllUpdatesOnManagedInstanceGroupRequest,InstallAllUpdatesOnManagedInstanceGroupResponse> handler)
OsManagementAsync
Install all of the available updates for the Managed Instance Group.
installAllUpdatesOnManagedInstanceGroup
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<InstallAllWindowsUpdatesOnManagedInstanceResponse> installAllWindowsUpdatesOnManagedInstance(InstallAllWindowsUpdatesOnManagedInstanceRequest request, AsyncHandler<InstallAllWindowsUpdatesOnManagedInstanceRequest,InstallAllWindowsUpdatesOnManagedInstanceResponse> handler)
OsManagementAsync
Install all of the available Windows updates for the managed instance.
installAllWindowsUpdatesOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<InstallModuleStreamProfileOnManagedInstanceResponse> installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request, AsyncHandler<InstallModuleStreamProfileOnManagedInstanceRequest,InstallModuleStreamProfileOnManagedInstanceResponse> handler)
OsManagementAsync
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.
installModuleStreamProfileOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<InstallPackageOnManagedInstanceResponse> installPackageOnManagedInstance(InstallPackageOnManagedInstanceRequest request, AsyncHandler<InstallPackageOnManagedInstanceRequest,InstallPackageOnManagedInstanceResponse> handler)
OsManagementAsync
Installs a package on a managed instance.
installPackageOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<InstallPackageUpdateOnManagedInstanceResponse> installPackageUpdateOnManagedInstance(InstallPackageUpdateOnManagedInstanceRequest request, AsyncHandler<InstallPackageUpdateOnManagedInstanceRequest,InstallPackageUpdateOnManagedInstanceResponse> handler)
OsManagementAsync
Updates a package on a managed instance.
installPackageUpdateOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<InstallWindowsUpdateOnManagedInstanceResponse> installWindowsUpdateOnManagedInstance(InstallWindowsUpdateOnManagedInstanceRequest request, AsyncHandler<InstallWindowsUpdateOnManagedInstanceRequest,InstallWindowsUpdateOnManagedInstanceResponse> handler)
OsManagementAsync
Installs a Windows update on a managed instance.
installWindowsUpdateOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAvailablePackagesForManagedInstanceResponse> listAvailablePackagesForManagedInstance(ListAvailablePackagesForManagedInstanceRequest request, AsyncHandler<ListAvailablePackagesForManagedInstanceRequest,ListAvailablePackagesForManagedInstanceResponse> handler)
OsManagementAsync
Returns a list of packages available for install on the Managed Instance.
listAvailablePackagesForManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAvailableSoftwareSourcesForManagedInstanceResponse> listAvailableSoftwareSourcesForManagedInstance(ListAvailableSoftwareSourcesForManagedInstanceRequest request, AsyncHandler<ListAvailableSoftwareSourcesForManagedInstanceRequest,ListAvailableSoftwareSourcesForManagedInstanceResponse> handler)
OsManagementAsync
Returns a list of available software sources for a Managed Instance.
listAvailableSoftwareSourcesForManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAvailableUpdatesForManagedInstanceResponse> listAvailableUpdatesForManagedInstance(ListAvailableUpdatesForManagedInstanceRequest request, AsyncHandler<ListAvailableUpdatesForManagedInstanceRequest,ListAvailableUpdatesForManagedInstanceResponse> handler)
OsManagementAsync
Returns a list of available updates for a Managed Instance.
listAvailableUpdatesForManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListAvailableWindowsUpdatesForManagedInstanceResponse> listAvailableWindowsUpdatesForManagedInstance(ListAvailableWindowsUpdatesForManagedInstanceRequest request, AsyncHandler<ListAvailableWindowsUpdatesForManagedInstanceRequest,ListAvailableWindowsUpdatesForManagedInstanceResponse> handler)
OsManagementAsync
Returns a list of available Windows updates for a Managed Instance. This is only applicable to Windows instances.
listAvailableWindowsUpdatesForManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListErrataResponse> listErrata(ListErrataRequest request, AsyncHandler<ListErrataRequest,ListErrataResponse> handler)
OsManagementAsync
Returns a list of all of the currently available Errata in the system
listErrata
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListManagedInstanceErrataResponse> listManagedInstanceErrata(ListManagedInstanceErrataRequest request, AsyncHandler<ListManagedInstanceErrataRequest,ListManagedInstanceErrataResponse> handler)
OsManagementAsync
Returns a list of errata relevant to the Managed Instance.
listManagedInstanceErrata
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListManagedInstanceGroupsResponse> listManagedInstanceGroups(ListManagedInstanceGroupsRequest request, AsyncHandler<ListManagedInstanceGroupsRequest,ListManagedInstanceGroupsResponse> handler)
OsManagementAsync
Returns a list of all Managed Instance Groups.
listManagedInstanceGroups
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListManagedInstancesResponse> listManagedInstances(ListManagedInstancesRequest request, AsyncHandler<ListManagedInstancesRequest,ListManagedInstancesResponse> handler)
OsManagementAsync
Returns a list of all Managed Instances.
listManagedInstances
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListModuleStreamProfilesResponse> listModuleStreamProfiles(ListModuleStreamProfilesRequest request, AsyncHandler<ListModuleStreamProfilesRequest,ListModuleStreamProfilesResponse> handler)
OsManagementAsync
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\".
listModuleStreamProfiles
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListModuleStreamProfilesOnManagedInstanceResponse> listModuleStreamProfilesOnManagedInstance(ListModuleStreamProfilesOnManagedInstanceRequest request, AsyncHandler<ListModuleStreamProfilesOnManagedInstanceRequest,ListModuleStreamProfilesOnManagedInstanceResponse> handler)
OsManagementAsync
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.
listModuleStreamProfilesOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListModuleStreamsResponse> listModuleStreams(ListModuleStreamsRequest request, AsyncHandler<ListModuleStreamsRequest,ListModuleStreamsResponse> handler)
OsManagementAsync
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 \" When sorting by display name, the result set is sorted first by module name, then by
stream name.
listModuleStreams
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListModuleStreamsOnManagedInstanceResponse> listModuleStreamsOnManagedInstance(ListModuleStreamsOnManagedInstanceRequest request, AsyncHandler<ListModuleStreamsOnManagedInstanceRequest,ListModuleStreamsOnManagedInstanceResponse> handler)
OsManagementAsync
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 \" 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.
listModuleStreamsOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListPackagesInstalledOnManagedInstanceResponse> listPackagesInstalledOnManagedInstance(ListPackagesInstalledOnManagedInstanceRequest request, AsyncHandler<ListPackagesInstalledOnManagedInstanceRequest,ListPackagesInstalledOnManagedInstanceResponse> handler)
OsManagementAsync
Returns a list of installed packages on the Managed Instance.
listPackagesInstalledOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListScheduledJobsResponse> listScheduledJobs(ListScheduledJobsRequest request, AsyncHandler<ListScheduledJobsRequest,ListScheduledJobsResponse> handler)
OsManagementAsync
Returns a list of all of the currently active Scheduled Jobs in the system
listScheduledJobs
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListSoftwareSourcePackagesResponse> listSoftwareSourcePackages(ListSoftwareSourcePackagesRequest request, AsyncHandler<ListSoftwareSourcePackagesRequest,ListSoftwareSourcePackagesResponse> handler)
OsManagementAsync
Lists Software Packages in a Software Source
listSoftwareSourcePackages
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListSoftwareSourcesResponse> listSoftwareSources(ListSoftwareSourcesRequest request, AsyncHandler<ListSoftwareSourcesRequest,ListSoftwareSourcesResponse> handler)
OsManagementAsync
Returns a list of all Software Sources.
listSoftwareSources
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListUpcomingScheduledJobsResponse> listUpcomingScheduledJobs(ListUpcomingScheduledJobsRequest request, AsyncHandler<ListUpcomingScheduledJobsRequest,ListUpcomingScheduledJobsResponse> handler)
OsManagementAsync
Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.
listUpcomingScheduledJobs
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWindowsUpdatesResponse> listWindowsUpdates(ListWindowsUpdatesRequest request, AsyncHandler<ListWindowsUpdatesRequest,ListWindowsUpdatesResponse> handler)
OsManagementAsync
Returns a list of Windows Updates.
listWindowsUpdates
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWindowsUpdatesInstalledOnManagedInstanceResponse> listWindowsUpdatesInstalledOnManagedInstance(ListWindowsUpdatesInstalledOnManagedInstanceRequest request, AsyncHandler<ListWindowsUpdatesInstalledOnManagedInstanceRequest,ListWindowsUpdatesInstalledOnManagedInstanceResponse> handler)
OsManagementAsync
Returns a list of installed Windows updates for a Managed Instance. This is only applicable to Windows instances.
listWindowsUpdatesInstalledOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
OsManagementAsync
Gets the errors for the work request with the given ID.
listWorkRequestErrors
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
OsManagementAsync
Lists the log entries for the work request with the given ID.
listWorkRequestLogs
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
OsManagementAsync
Lists the work requests in a compartment.
listWorkRequests
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ManageModuleStreamsOnManagedInstanceResponse> manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request, AsyncHandler<ManageModuleStreamsOnManagedInstanceRequest,ManageModuleStreamsOnManagedInstanceResponse> handler)
OsManagementAsync
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.
manageModuleStreamsOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemoveModuleStreamProfileFromManagedInstanceResponse> removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request, AsyncHandler<RemoveModuleStreamProfileFromManagedInstanceRequest,RemoveModuleStreamProfileFromManagedInstanceResponse> handler)
OsManagementAsync
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.
removeModuleStreamProfileFromManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemovePackageFromManagedInstanceResponse> removePackageFromManagedInstance(RemovePackageFromManagedInstanceRequest request, AsyncHandler<RemovePackageFromManagedInstanceRequest,RemovePackageFromManagedInstanceResponse> handler)
OsManagementAsync
Removes an installed package from a managed instance.
removePackageFromManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RemovePackagesFromSoftwareSourceResponse> removePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest request, AsyncHandler<RemovePackagesFromSoftwareSourceRequest,RemovePackagesFromSoftwareSourceResponse> handler)
OsManagementAsync
Removes a given list of Software Packages from a specific Software Source.
removePackagesFromSoftwareSource
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RunScheduledJobNowResponse> runScheduledJobNow(RunScheduledJobNowRequest request, AsyncHandler<RunScheduledJobNowRequest,RunScheduledJobNowResponse> handler)
OsManagementAsync
This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.
runScheduledJobNow
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<SearchSoftwarePackagesResponse> searchSoftwarePackages(SearchSoftwarePackagesRequest request, AsyncHandler<SearchSoftwarePackagesRequest,SearchSoftwarePackagesResponse> handler)
OsManagementAsync
Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.
searchSoftwarePackages
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<SkipNextScheduledJobExecutionResponse> skipNextScheduledJobExecution(SkipNextScheduledJobExecutionRequest request, AsyncHandler<SkipNextScheduledJobExecutionRequest,SkipNextScheduledJobExecutionResponse> handler)
OsManagementAsync
This will force an already created Scheduled Job to skip its next regularly scheduled execution
skipNextScheduledJobExecution
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<SwitchModuleStreamOnManagedInstanceResponse> switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request, AsyncHandler<SwitchModuleStreamOnManagedInstanceRequest,SwitchModuleStreamOnManagedInstanceResponse> handler)
OsManagementAsync
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.
switchModuleStreamOnManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateManagedInstanceResponse> updateManagedInstance(UpdateManagedInstanceRequest request, AsyncHandler<UpdateManagedInstanceRequest,UpdateManagedInstanceResponse> handler)
OsManagementAsync
Updates a specific Managed Instance.
updateManagedInstance
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateManagedInstanceGroupResponse> updateManagedInstanceGroup(UpdateManagedInstanceGroupRequest request, AsyncHandler<UpdateManagedInstanceGroupRequest,UpdateManagedInstanceGroupResponse> handler)
OsManagementAsync
Updates a specific Managed Instance Group.
updateManagedInstanceGroup
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateScheduledJobResponse> updateScheduledJob(UpdateScheduledJobRequest request, AsyncHandler<UpdateScheduledJobRequest,UpdateScheduledJobResponse> handler)
OsManagementAsync
Updates an existing Scheduled Job on the management system.
updateScheduledJob
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateSoftwareSourceResponse> updateSoftwareSource(UpdateSoftwareSourceRequest request, AsyncHandler<UpdateSoftwareSourceRequest,UpdateSoftwareSourceResponse> handler)
OsManagementAsync
Updates an existing custom Software Source on the management system.
updateSoftwareSource
in interface OsManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
Copyright © 2016–2024. All rights reserved.