Interface ManagedInstanceGroupAsync
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
ManagedInstanceGroupAsyncClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20220901") public interface ManagedInstanceGroupAsync extends AutoCloseable
Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds.For more information, see Overview of OS Management Hub.
-
-
Method Summary
-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the serice.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpoint
after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Parameters:
region
- The region of the service.
-
setRegion
void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
attachManagedInstancesToManagedInstanceGroup
Future<AttachManagedInstancesToManagedInstanceGroupResponse> attachManagedInstancesToManagedInstanceGroup(AttachManagedInstancesToManagedInstanceGroupRequest request, AsyncHandler<AttachManagedInstancesToManagedInstanceGroupRequest,AttachManagedInstancesToManagedInstanceGroupResponse> handler)
Adds managed instances to the specified managed instance group.After adding instances to the group, any operation applied to the group will be applied to all instances in the group.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
attachSoftwareSourcesToManagedInstanceGroup
Future<AttachSoftwareSourcesToManagedInstanceGroupResponse> attachSoftwareSourcesToManagedInstanceGroup(AttachSoftwareSourcesToManagedInstanceGroupRequest request, AsyncHandler<AttachSoftwareSourcesToManagedInstanceGroupRequest,AttachSoftwareSourcesToManagedInstanceGroupResponse> handler)
Attaches software sources to the specified managed instance group.The software sources must be compatible with the type of instances in the group.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
changeManagedInstanceGroupCompartment
Future<ChangeManagedInstanceGroupCompartmentResponse> changeManagedInstanceGroupCompartment(ChangeManagedInstanceGroupCompartmentRequest request, AsyncHandler<ChangeManagedInstanceGroupCompartmentRequest,ChangeManagedInstanceGroupCompartmentResponse> handler)
Moves the specified managed instance group to a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createManagedInstanceGroup
Future<CreateManagedInstanceGroupResponse> createManagedInstanceGroup(CreateManagedInstanceGroupRequest request, AsyncHandler<CreateManagedInstanceGroupRequest,CreateManagedInstanceGroupResponse> handler)
Creates a new managed instance group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteManagedInstanceGroup
Future<DeleteManagedInstanceGroupResponse> deleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest request, AsyncHandler<DeleteManagedInstanceGroupRequest,DeleteManagedInstanceGroupResponse> handler)
Deletes the specified managed instance group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
detachManagedInstancesFromManagedInstanceGroup
Future<DetachManagedInstancesFromManagedInstanceGroupResponse> detachManagedInstancesFromManagedInstanceGroup(DetachManagedInstancesFromManagedInstanceGroupRequest request, AsyncHandler<DetachManagedInstancesFromManagedInstanceGroupRequest,DetachManagedInstancesFromManagedInstanceGroupResponse> handler)
Removes a managed instance from the specified managed instance group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
detachSoftwareSourcesFromManagedInstanceGroup
Future<DetachSoftwareSourcesFromManagedInstanceGroupResponse> detachSoftwareSourcesFromManagedInstanceGroup(DetachSoftwareSourcesFromManagedInstanceGroupRequest request, AsyncHandler<DetachSoftwareSourcesFromManagedInstanceGroupRequest,DetachSoftwareSourcesFromManagedInstanceGroupResponse> handler)
Detaches the specified software sources from a managed instance group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
disableModuleStreamOnManagedInstanceGroup
Future<DisableModuleStreamOnManagedInstanceGroupResponse> disableModuleStreamOnManagedInstanceGroup(DisableModuleStreamOnManagedInstanceGroupRequest request, AsyncHandler<DisableModuleStreamOnManagedInstanceGroupRequest,DisableModuleStreamOnManagedInstanceGroupResponse> handler)
Disables a module stream on a managed instance group.After the stream is disabled, you can no longer install the profiles contained by the stream. Before removing the stream, you must remove all installed profiles for the stream by using the
removeModuleStreamProfileFromManagedInstanceGroup
operation.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
enableModuleStreamOnManagedInstanceGroup
Future<EnableModuleStreamOnManagedInstanceGroupResponse> enableModuleStreamOnManagedInstanceGroup(EnableModuleStreamOnManagedInstanceGroupRequest request, AsyncHandler<EnableModuleStreamOnManagedInstanceGroupRequest,EnableModuleStreamOnManagedInstanceGroupResponse> handler)
Enables a module stream on a managed instance group.After the stream is enabled, you can install a module stream profile. Enabling a stream that is already enabled will succeed. Enabling a different stream for a module that already has a stream enabled results in an error. Instead, use the
switchModuleStreamOnManagedInstanceGroup
operation.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getManagedInstanceGroup
Future<GetManagedInstanceGroupResponse> getManagedInstanceGroup(GetManagedInstanceGroupRequest request, AsyncHandler<GetManagedInstanceGroupRequest,GetManagedInstanceGroupResponse> handler)
Gets information about the specified managed instance group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
installModuleStreamProfileOnManagedInstanceGroup
Future<InstallModuleStreamProfileOnManagedInstanceGroupResponse> installModuleStreamProfileOnManagedInstanceGroup(InstallModuleStreamProfileOnManagedInstanceGroupRequest request, AsyncHandler<InstallModuleStreamProfileOnManagedInstanceGroupRequest,InstallModuleStreamProfileOnManagedInstanceGroupResponse> handler)
Installs a profile for an enabled module stream.If a module stream defines multiple profiles, you can install each one independently.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
installPackagesOnManagedInstanceGroup
Future<InstallPackagesOnManagedInstanceGroupResponse> installPackagesOnManagedInstanceGroup(InstallPackagesOnManagedInstanceGroupRequest request, AsyncHandler<InstallPackagesOnManagedInstanceGroupRequest,InstallPackagesOnManagedInstanceGroupResponse> handler)
Installs the specified packages on each managed instance in a managed instance group.The package must be compatible with the instances in the group.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
installWindowsUpdatesOnManagedInstanceGroup
Future<InstallWindowsUpdatesOnManagedInstanceGroupResponse> installWindowsUpdatesOnManagedInstanceGroup(InstallWindowsUpdatesOnManagedInstanceGroupRequest request, AsyncHandler<InstallWindowsUpdatesOnManagedInstanceGroupRequest,InstallWindowsUpdatesOnManagedInstanceGroupResponse> handler)
Installs Windows updates on each managed instance in the managed instance group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedInstanceGroupAvailableModules
Future<ListManagedInstanceGroupAvailableModulesResponse> listManagedInstanceGroupAvailableModules(ListManagedInstanceGroupAvailableModulesRequest request, AsyncHandler<ListManagedInstanceGroupAvailableModulesRequest,ListManagedInstanceGroupAvailableModulesResponse> handler)
List modules that are available for installation on the specified managed instance group.Filter the list against a variety of criteria including but not limited to module name.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedInstanceGroupAvailablePackages
Future<ListManagedInstanceGroupAvailablePackagesResponse> listManagedInstanceGroupAvailablePackages(ListManagedInstanceGroupAvailablePackagesRequest request, AsyncHandler<ListManagedInstanceGroupAvailablePackagesRequest,ListManagedInstanceGroupAvailablePackagesResponse> handler)
Lists available packages on the specified managed instances group.Filter the list against a variety of criteria including but not limited to the package name.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedInstanceGroupAvailableSoftwareSources
Future<ListManagedInstanceGroupAvailableSoftwareSourcesResponse> listManagedInstanceGroupAvailableSoftwareSources(ListManagedInstanceGroupAvailableSoftwareSourcesRequest request, AsyncHandler<ListManagedInstanceGroupAvailableSoftwareSourcesRequest,ListManagedInstanceGroupAvailableSoftwareSourcesResponse> handler)
Lists available software sources for a specified managed instance group.Filter the list against a variety of criteria including but not limited to the software source name. The results list only software sources that have not already been added to the group.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedInstanceGroupInstalledPackages
Future<ListManagedInstanceGroupInstalledPackagesResponse> listManagedInstanceGroupInstalledPackages(ListManagedInstanceGroupInstalledPackagesRequest request, AsyncHandler<ListManagedInstanceGroupInstalledPackagesRequest,ListManagedInstanceGroupInstalledPackagesResponse> handler)
Lists installed packages on the specified managed instances group.Filter the list against a variety of criteria including but not limited to the package name.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedInstanceGroupModules
Future<ListManagedInstanceGroupModulesResponse> listManagedInstanceGroupModules(ListManagedInstanceGroupModulesRequest request, AsyncHandler<ListManagedInstanceGroupModulesRequest,ListManagedInstanceGroupModulesResponse> handler)
Retrieve a list of module streams, along with a summary of their status, from a managed instance group.Filters may be applied to select a subset of module streams based on the filter criteria.
The 'moduleName' attribute filters against the name of a module. It accepts strings of the format \"
\". If this attribute is defined, only streams that belong to the specified module are included in the result set. If it is not defined, the request is not subject to this filter. The \"status\" attribute filters against the state of a module stream. Valid values are \"ENABLED\", \"DISABLED\", and \"ACTIVE\". If the attribute is set to \"ENABLED\", only module streams that are enabled are included in the result set. If the attribute is set to \"DISABLED\", only module streams that are not enabled are included in the result set. If the attribute is set to \"ACTIVE\", only module streams that are active are included in the result set. If the attribute is not defined, the request is not subject to this filter.
When sorting by the display name, the result set is sorted first by the module name and then by the stream name.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listManagedInstanceGroups
Future<ListManagedInstanceGroupsResponse> listManagedInstanceGroups(ListManagedInstanceGroupsRequest request, AsyncHandler<ListManagedInstanceGroupsRequest,ListManagedInstanceGroupsResponse> handler)
Lists managed instance groups that match the specified compartment or managed instance group OCID.Filter the list against a variety of criteria including but not limited to name, status, architecture, and OS family.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
manageModuleStreamsOnManagedInstanceGroup
Future<ManageModuleStreamsOnManagedInstanceGroupResponse> manageModuleStreamsOnManagedInstanceGroup(ManageModuleStreamsOnManagedInstanceGroupRequest request, AsyncHandler<ManageModuleStreamsOnManagedInstanceGroupRequest,ManageModuleStreamsOnManagedInstanceGroupResponse> handler)
Enables or disables module streams and installs or removes module stream profiles.Once complete, the state of the modules, streams, and profiles will match the state indicated in the operation. See
manageModuleStreamsOnManagedInstanceGroupDetails
for more information. You can preform this operation as a dry run. For a dry run, the service evaluates the operation against the current module, stream, and profile state on the managed instance, but does not commit the changes. Instead, the service returns work request log or error entries indicating the impact of the operation.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
rebootManagedInstanceGroup
Future<RebootManagedInstanceGroupResponse> rebootManagedInstanceGroup(RebootManagedInstanceGroupRequest request, AsyncHandler<RebootManagedInstanceGroupRequest,RebootManagedInstanceGroupResponse> handler)
Reboots all managed instances in the specified group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
removeModuleStreamProfileFromManagedInstanceGroup
Future<RemoveModuleStreamProfileFromManagedInstanceGroupResponse> removeModuleStreamProfileFromManagedInstanceGroup(RemoveModuleStreamProfileFromManagedInstanceGroupRequest request, AsyncHandler<RemoveModuleStreamProfileFromManagedInstanceGroupRequest,RemoveModuleStreamProfileFromManagedInstanceGroupResponse> handler)
Removes a profile for a module stream that is installed on a managed instance group.Providing the module stream name (without specifying a profile name) removes all profiles that have been installed for the module stream.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
removePackagesFromManagedInstanceGroup
Future<RemovePackagesFromManagedInstanceGroupResponse> removePackagesFromManagedInstanceGroup(RemovePackagesFromManagedInstanceGroupRequest request, AsyncHandler<RemovePackagesFromManagedInstanceGroupRequest,RemovePackagesFromManagedInstanceGroupResponse> handler)
Removes the specified packages from each managed instance in a managed instance group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
switchModuleStreamOnManagedInstanceGroup
Future<SwitchModuleStreamOnManagedInstanceGroupResponse> switchModuleStreamOnManagedInstanceGroup(SwitchModuleStreamOnManagedInstanceGroupRequest request, AsyncHandler<SwitchModuleStreamOnManagedInstanceGroupRequest,SwitchModuleStreamOnManagedInstanceGroupResponse> handler)
Enables a new stream for a module that already has a stream enabled.If any profiles or packages from the original module are installed, switching to a new stream will remove the existing packages and install their counterparts in the new stream.
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateAllPackagesOnManagedInstanceGroup
Future<UpdateAllPackagesOnManagedInstanceGroupResponse> updateAllPackagesOnManagedInstanceGroup(UpdateAllPackagesOnManagedInstanceGroupRequest request, AsyncHandler<UpdateAllPackagesOnManagedInstanceGroupRequest,UpdateAllPackagesOnManagedInstanceGroupResponse> handler)
Updates all packages on each managed instance in the specified managed instance group.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateManagedInstanceGroup
Future<UpdateManagedInstanceGroupResponse> updateManagedInstanceGroup(UpdateManagedInstanceGroupRequest request, AsyncHandler<UpdateManagedInstanceGroupRequest,UpdateManagedInstanceGroupResponse> handler)
Updates the specified managed instance group’s name, description, and tags.- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
-