@Generated(value="OracleSDKGenerator", comments="API Version: 20190801") public interface OsManagementAsync extends AutoCloseable
API for the OS Management service. Use these API operations for working with Managed instances and Managed instance groups.
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion
.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.Future<AddPackagesToSoftwareSourceResponse> addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request, AsyncHandler<AddPackagesToSoftwareSourceRequest,AddPackagesToSoftwareSourceResponse> handler)
Adds a given list of Software Packages to a specific Software Source.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AttachChildSoftwareSourceToManagedInstanceResponse> attachChildSoftwareSourceToManagedInstance(AttachChildSoftwareSourceToManagedInstanceRequest request, AsyncHandler<AttachChildSoftwareSourceToManagedInstanceRequest,AttachChildSoftwareSourceToManagedInstanceResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AttachManagedInstanceToManagedInstanceGroupResponse> attachManagedInstanceToManagedInstanceGroup(AttachManagedInstanceToManagedInstanceGroupRequest request, AsyncHandler<AttachManagedInstanceToManagedInstanceGroupRequest,AttachManagedInstanceToManagedInstanceGroupResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AttachParentSoftwareSourceToManagedInstanceResponse> attachParentSoftwareSourceToManagedInstance(AttachParentSoftwareSourceToManagedInstanceRequest request, AsyncHandler<AttachParentSoftwareSourceToManagedInstanceRequest,AttachParentSoftwareSourceToManagedInstanceResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeManagedInstanceGroupCompartmentResponse> changeManagedInstanceGroupCompartment(ChangeManagedInstanceGroupCompartmentRequest request, AsyncHandler<ChangeManagedInstanceGroupCompartmentRequest,ChangeManagedInstanceGroupCompartmentResponse> handler)
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeScheduledJobCompartmentResponse> changeScheduledJobCompartment(ChangeScheduledJobCompartmentRequest request, AsyncHandler<ChangeScheduledJobCompartmentRequest,ChangeScheduledJobCompartmentResponse> handler)
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeSoftwareSourceCompartmentResponse> changeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request, AsyncHandler<ChangeSoftwareSourceCompartmentRequest,ChangeSoftwareSourceCompartmentResponse> handler)
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateManagedInstanceGroupResponse> createManagedInstanceGroup(CreateManagedInstanceGroupRequest request, AsyncHandler<CreateManagedInstanceGroupRequest,CreateManagedInstanceGroupResponse> handler)
Creates a new Managed Instance Group on the management system. This will not contain any managed instances after it is first created, and they must be added later.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateScheduledJobResponse> createScheduledJob(CreateScheduledJobRequest request, AsyncHandler<CreateScheduledJobRequest,CreateScheduledJobResponse> handler)
Creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups. Can be created as a one-time execution in the future, or as a recurring execution that repeats on a defined interval.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateSoftwareSourceResponse> createSoftwareSource(CreateSoftwareSourceRequest request, AsyncHandler<CreateSoftwareSourceRequest,CreateSoftwareSourceResponse> handler)
Creates a new custom Software Source on the management system. This will not contain any packages after it is first created, and they must be added later.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteManagedInstanceGroupResponse> deleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest request, AsyncHandler<DeleteManagedInstanceGroupRequest,DeleteManagedInstanceGroupResponse> handler)
Deletes a Managed Instance Group from the management system
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteScheduledJobResponse> deleteScheduledJob(DeleteScheduledJobRequest request, AsyncHandler<DeleteScheduledJobRequest,DeleteScheduledJobResponse> handler)
Cancels an existing Scheduled Job on the management system
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteSoftwareSourceResponse> deleteSoftwareSource(DeleteSoftwareSourceRequest request, AsyncHandler<DeleteSoftwareSourceRequest,DeleteSoftwareSourceResponse> handler)
Deletes a custom Software Source on the management system
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DetachChildSoftwareSourceFromManagedInstanceResponse> detachChildSoftwareSourceFromManagedInstance(DetachChildSoftwareSourceFromManagedInstanceRequest request, AsyncHandler<DetachChildSoftwareSourceFromManagedInstanceRequest,DetachChildSoftwareSourceFromManagedInstanceResponse> handler)
Removes a child software source from a managed instance. Packages will no longer be able to be installed from these software sources.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DetachManagedInstanceFromManagedInstanceGroupResponse> detachManagedInstanceFromManagedInstanceGroup(DetachManagedInstanceFromManagedInstanceGroupRequest request, AsyncHandler<DetachManagedInstanceFromManagedInstanceGroupRequest,DetachManagedInstanceFromManagedInstanceGroupResponse> handler)
Removes a Managed Instance from a Managed Instance Group.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DetachParentSoftwareSourceFromManagedInstanceResponse> detachParentSoftwareSourceFromManagedInstance(DetachParentSoftwareSourceFromManagedInstanceRequest request, AsyncHandler<DetachParentSoftwareSourceFromManagedInstanceRequest,DetachParentSoftwareSourceFromManagedInstanceResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetErratumResponse> getErratum(GetErratumRequest request, AsyncHandler<GetErratumRequest,GetErratumResponse> handler)
Returns a specific erratum.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetManagedInstanceResponse> getManagedInstance(GetManagedInstanceRequest request, AsyncHandler<GetManagedInstanceRequest,GetManagedInstanceResponse> handler)
Returns a specific Managed Instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetManagedInstanceGroupResponse> getManagedInstanceGroup(GetManagedInstanceGroupRequest request, AsyncHandler<GetManagedInstanceGroupRequest,GetManagedInstanceGroupResponse> handler)
Returns a specific Managed Instance Group.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetScheduledJobResponse> getScheduledJob(GetScheduledJobRequest request, AsyncHandler<GetScheduledJobRequest,GetScheduledJobResponse> handler)
Gets the detailed information for the Scheduled Job with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetSoftwarePackageResponse> getSoftwarePackage(GetSoftwarePackageRequest request, AsyncHandler<GetSoftwarePackageRequest,GetSoftwarePackageResponse> handler)
Returns a specific Software Package.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetSoftwareSourceResponse> getSoftwareSource(GetSoftwareSourceRequest request, AsyncHandler<GetSoftwareSourceRequest,GetSoftwareSourceResponse> handler)
Returns a specific Software Source.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWindowsUpdateResponse> getWindowsUpdate(GetWindowsUpdateRequest request, AsyncHandler<GetWindowsUpdateRequest,GetWindowsUpdateResponse> handler)
Returns a Windows Update object.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets the detailed information for the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<InstallAllPackageUpdatesOnManagedInstanceResponse> installAllPackageUpdatesOnManagedInstance(InstallAllPackageUpdatesOnManagedInstanceRequest request, AsyncHandler<InstallAllPackageUpdatesOnManagedInstanceRequest,InstallAllPackageUpdatesOnManagedInstanceResponse> handler)
Install all of the available package updates for the managed instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<InstallAllUpdatesOnManagedInstanceGroupResponse> installAllUpdatesOnManagedInstanceGroup(InstallAllUpdatesOnManagedInstanceGroupRequest request, AsyncHandler<InstallAllUpdatesOnManagedInstanceGroupRequest,InstallAllUpdatesOnManagedInstanceGroupResponse> handler)
Install all of the available updates for the Managed Instance Group.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<InstallAllWindowsUpdatesOnManagedInstanceResponse> installAllWindowsUpdatesOnManagedInstance(InstallAllWindowsUpdatesOnManagedInstanceRequest request, AsyncHandler<InstallAllWindowsUpdatesOnManagedInstanceRequest,InstallAllWindowsUpdatesOnManagedInstanceResponse> handler)
Install all of the available Windows updates for the managed instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<InstallPackageOnManagedInstanceResponse> installPackageOnManagedInstance(InstallPackageOnManagedInstanceRequest request, AsyncHandler<InstallPackageOnManagedInstanceRequest,InstallPackageOnManagedInstanceResponse> handler)
Installs a package on a managed instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<InstallPackageUpdateOnManagedInstanceResponse> installPackageUpdateOnManagedInstance(InstallPackageUpdateOnManagedInstanceRequest request, AsyncHandler<InstallPackageUpdateOnManagedInstanceRequest,InstallPackageUpdateOnManagedInstanceResponse> handler)
Updates a package on a managed instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<InstallWindowsUpdateOnManagedInstanceResponse> installWindowsUpdateOnManagedInstance(InstallWindowsUpdateOnManagedInstanceRequest request, AsyncHandler<InstallWindowsUpdateOnManagedInstanceRequest,InstallWindowsUpdateOnManagedInstanceResponse> handler)
Installs a Windows update on a managed instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAvailablePackagesForManagedInstanceResponse> listAvailablePackagesForManagedInstance(ListAvailablePackagesForManagedInstanceRequest request, AsyncHandler<ListAvailablePackagesForManagedInstanceRequest,ListAvailablePackagesForManagedInstanceResponse> handler)
Returns a list of packages available for install on the Managed Instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAvailableSoftwareSourcesForManagedInstanceResponse> listAvailableSoftwareSourcesForManagedInstance(ListAvailableSoftwareSourcesForManagedInstanceRequest request, AsyncHandler<ListAvailableSoftwareSourcesForManagedInstanceRequest,ListAvailableSoftwareSourcesForManagedInstanceResponse> handler)
Returns a list of available software sources for a Managed Instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAvailableUpdatesForManagedInstanceResponse> listAvailableUpdatesForManagedInstance(ListAvailableUpdatesForManagedInstanceRequest request, AsyncHandler<ListAvailableUpdatesForManagedInstanceRequest,ListAvailableUpdatesForManagedInstanceResponse> handler)
Returns a list of available updates for a Managed Instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAvailableWindowsUpdatesForManagedInstanceResponse> listAvailableWindowsUpdatesForManagedInstance(ListAvailableWindowsUpdatesForManagedInstanceRequest request, AsyncHandler<ListAvailableWindowsUpdatesForManagedInstanceRequest,ListAvailableWindowsUpdatesForManagedInstanceResponse> handler)
Returns a list of available Windows updates for a Managed Instance. This is only applicable to Windows instances.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListErrataResponse> listErrata(ListErrataRequest request, AsyncHandler<ListErrataRequest,ListErrataResponse> handler)
Returns a list of all of the currently available Errata in the system
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListManagedInstanceErrataResponse> listManagedInstanceErrata(ListManagedInstanceErrataRequest request, AsyncHandler<ListManagedInstanceErrataRequest,ListManagedInstanceErrataResponse> handler)
Returns a list of errata relevant to the Managed Instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListManagedInstanceGroupsResponse> listManagedInstanceGroups(ListManagedInstanceGroupsRequest request, AsyncHandler<ListManagedInstanceGroupsRequest,ListManagedInstanceGroupsResponse> handler)
Returns a list of all Managed Instance Groups.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListManagedInstancesResponse> listManagedInstances(ListManagedInstancesRequest request, AsyncHandler<ListManagedInstancesRequest,ListManagedInstancesResponse> handler)
Returns a list of all Managed Instances.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListPackagesInstalledOnManagedInstanceResponse> listPackagesInstalledOnManagedInstance(ListPackagesInstalledOnManagedInstanceRequest request, AsyncHandler<ListPackagesInstalledOnManagedInstanceRequest,ListPackagesInstalledOnManagedInstanceResponse> handler)
Returns a list of installed packages on the Managed Instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListScheduledJobsResponse> listScheduledJobs(ListScheduledJobsRequest request, AsyncHandler<ListScheduledJobsRequest,ListScheduledJobsResponse> handler)
Returns a list of all of the currently active Scheduled Jobs in the system
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListSoftwareSourcePackagesResponse> listSoftwareSourcePackages(ListSoftwareSourcePackagesRequest request, AsyncHandler<ListSoftwareSourcePackagesRequest,ListSoftwareSourcePackagesResponse> handler)
Lists Software Packages in a Software Source
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListSoftwareSourcesResponse> listSoftwareSources(ListSoftwareSourcesRequest request, AsyncHandler<ListSoftwareSourcesRequest,ListSoftwareSourcesResponse> handler)
Returns a list of all Software Sources.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListUpcomingScheduledJobsResponse> listUpcomingScheduledJobs(ListUpcomingScheduledJobsRequest request, AsyncHandler<ListUpcomingScheduledJobsRequest,ListUpcomingScheduledJobsResponse> handler)
Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWindowsUpdatesResponse> listWindowsUpdates(ListWindowsUpdatesRequest request, AsyncHandler<ListWindowsUpdatesRequest,ListWindowsUpdatesResponse> handler)
Returns a list of Windows Updates.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWindowsUpdatesInstalledOnManagedInstanceResponse> listWindowsUpdatesInstalledOnManagedInstance(ListWindowsUpdatesInstalledOnManagedInstanceRequest request, AsyncHandler<ListWindowsUpdatesInstalledOnManagedInstanceRequest,ListWindowsUpdatesInstalledOnManagedInstanceResponse> handler)
Returns a list of installed Windows updates for a Managed Instance. This is only applicable to Windows instances.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Gets the errors for the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Lists the log entries for the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RemovePackageFromManagedInstanceResponse> removePackageFromManagedInstance(RemovePackageFromManagedInstanceRequest request, AsyncHandler<RemovePackageFromManagedInstanceRequest,RemovePackageFromManagedInstanceResponse> handler)
Removes an installed package from a managed instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RemovePackagesFromSoftwareSourceResponse> removePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest request, AsyncHandler<RemovePackagesFromSoftwareSourceRequest,RemovePackagesFromSoftwareSourceResponse> handler)
Removes a given list of Software Packages from a specific Software Source.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RunScheduledJobNowResponse> runScheduledJobNow(RunScheduledJobNowRequest request, AsyncHandler<RunScheduledJobNowRequest,RunScheduledJobNowResponse> handler)
This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<SearchSoftwarePackagesResponse> searchSoftwarePackages(SearchSoftwarePackagesRequest request, AsyncHandler<SearchSoftwarePackagesRequest,SearchSoftwarePackagesResponse> handler)
Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<SkipNextScheduledJobExecutionResponse> skipNextScheduledJobExecution(SkipNextScheduledJobExecutionRequest request, AsyncHandler<SkipNextScheduledJobExecutionRequest,SkipNextScheduledJobExecutionResponse> handler)
This will force an already created Scheduled Job to skip its next regularly scheduled execution
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateManagedInstanceResponse> updateManagedInstance(UpdateManagedInstanceRequest request, AsyncHandler<UpdateManagedInstanceRequest,UpdateManagedInstanceResponse> handler)
Updates a specific Managed Instance.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateManagedInstanceGroupResponse> updateManagedInstanceGroup(UpdateManagedInstanceGroupRequest request, AsyncHandler<UpdateManagedInstanceGroupRequest,UpdateManagedInstanceGroupResponse> handler)
Updates a specific Managed Instance Group.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateScheduledJobResponse> updateScheduledJob(UpdateScheduledJobRequest request, AsyncHandler<UpdateScheduledJobRequest,UpdateScheduledJobResponse> handler)
Updates an existing Scheduled Job on the management system.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateSoftwareSourceResponse> updateSoftwareSource(UpdateSoftwareSourceRequest request, AsyncHandler<UpdateSoftwareSourceRequest,UpdateSoftwareSourceResponse> handler)
Updates an existing custom Software Source on the management system.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.