com.oracle.bmc.osmanagementhub

Class ManagedInstanceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.osmanagementhub.ManagedInstanceAsyncClient

All Implemented Interfaces:

ManagedInstanceAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class ManagedInstanceAsyncClient
extends BaseAsyncClient
implements ManagedInstanceAsync

Async client implementation for ManagedInstance 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManagedInstanceAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for ManagedInstance.

Constructor Summary

Constructors

Constructor and Description
ManagedInstanceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
ManagedInstanceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
ManagedInstanceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ManagedInstanceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ManagedInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
ManagedInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
ManagedInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
Future<AttachSoftwareSourcesToManagedInstanceResponse>	attachSoftwareSourcesToManagedInstance(AttachSoftwareSourcesToManagedInstanceRequest request, AsyncHandler<AttachSoftwareSourcesToManagedInstanceRequest,AttachSoftwareSourcesToManagedInstanceResponse> handler) Adds software sources to a managed instance.
static ManagedInstanceAsyncClient.Builder	builder() Create a builder for this client.
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)
void	close()
Future<DetachSoftwareSourcesFromManagedInstanceResponse>	detachSoftwareSourcesFromManagedInstance(DetachSoftwareSourcesFromManagedInstanceRequest request, AsyncHandler<DetachSoftwareSourcesFromManagedInstanceRequest,DetachSoftwareSourcesFromManagedInstanceResponse> handler) Removes software sources from a managed instance.
Future<DisableModuleStreamOnManagedInstanceResponse>	disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request, AsyncHandler<DisableModuleStreamOnManagedInstanceRequest,DisableModuleStreamOnManagedInstanceResponse> handler) Disables a module stream on a managed instance.
Future<EnableModuleStreamOnManagedInstanceResponse>	enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request, AsyncHandler<EnableModuleStreamOnManagedInstanceRequest,EnableModuleStreamOnManagedInstanceResponse> handler) Enables a module stream on a managed instance.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetManagedInstanceResponse>	getManagedInstance(GetManagedInstanceRequest request, AsyncHandler<GetManagedInstanceRequest,GetManagedInstanceResponse> handler) Gets information about the specified managed instance.
Future<InstallModuleStreamProfileOnManagedInstanceResponse>	installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request, AsyncHandler<InstallModuleStreamProfileOnManagedInstanceRequest,InstallModuleStreamProfileOnManagedInstanceResponse> handler) Installs a profile for an module stream.
Future<InstallPackagesOnManagedInstanceResponse>	installPackagesOnManagedInstance(InstallPackagesOnManagedInstanceRequest request, AsyncHandler<InstallPackagesOnManagedInstanceRequest,InstallPackagesOnManagedInstanceResponse> handler) Installs packages on a managed instance.
Future<ListManagedInstanceAvailablePackagesResponse>	listManagedInstanceAvailablePackages(ListManagedInstanceAvailablePackagesRequest request, AsyncHandler<ListManagedInstanceAvailablePackagesRequest,ListManagedInstanceAvailablePackagesResponse> handler) Returns a list of available packages for a managed instance.
Future<ListManagedInstanceAvailableSoftwareSourcesResponse>	listManagedInstanceAvailableSoftwareSources(ListManagedInstanceAvailableSoftwareSourcesRequest request, AsyncHandler<ListManagedInstanceAvailableSoftwareSourcesRequest,ListManagedInstanceAvailableSoftwareSourcesResponse> handler) Returns a list of available software sources for a managed instance.
Future<ListManagedInstanceErrataResponse>	listManagedInstanceErrata(ListManagedInstanceErrataRequest request, AsyncHandler<ListManagedInstanceErrataRequest,ListManagedInstanceErrataResponse> handler) Returns a list of applicable errata on the managed instance.
Future<ListManagedInstanceInstalledPackagesResponse>	listManagedInstanceInstalledPackages(ListManagedInstanceInstalledPackagesRequest request, AsyncHandler<ListManagedInstanceInstalledPackagesRequest,ListManagedInstanceInstalledPackagesResponse> handler) Lists the packages that are installed on the managed instance.
Future<ListManagedInstanceModulesResponse>	listManagedInstanceModules(ListManagedInstanceModulesRequest request, AsyncHandler<ListManagedInstanceModulesRequest,ListManagedInstanceModulesResponse> handler) Retrieve a list of modules, along with streams of the modules, from a managed instance.
Future<ListManagedInstancesResponse>	listManagedInstances(ListManagedInstancesRequest request, AsyncHandler<ListManagedInstancesRequest,ListManagedInstancesResponse> handler) Lists managed instances that match the specified compartment or managed instance OCID.
Future<ListManagedInstanceUpdatablePackagesResponse>	listManagedInstanceUpdatablePackages(ListManagedInstanceUpdatablePackagesRequest request, AsyncHandler<ListManagedInstanceUpdatablePackagesRequest,ListManagedInstanceUpdatablePackagesResponse> handler) Returns a list of updatable packages for a managed instance.
Future<ManageModuleStreamsOnManagedInstanceResponse>	manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request, AsyncHandler<ManageModuleStreamsOnManagedInstanceRequest,ManageModuleStreamsOnManagedInstanceResponse> handler) Perform an operation involving modules, streams, and profiles on a managed instance.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
Future<RefreshSoftwareOnManagedInstanceResponse>	refreshSoftwareOnManagedInstance(RefreshSoftwareOnManagedInstanceRequest request, AsyncHandler<RefreshSoftwareOnManagedInstanceRequest,RefreshSoftwareOnManagedInstanceResponse> handler) Refresh all installed and updatable software information on a managed instance.
Future<RemoveModuleStreamProfileFromManagedInstanceResponse>	removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request, AsyncHandler<RemoveModuleStreamProfileFromManagedInstanceRequest,RemoveModuleStreamProfileFromManagedInstanceResponse> handler) Removes a profile for a module stream that is installed on a managed instance.
Future<RemovePackagesFromManagedInstanceResponse>	removePackagesFromManagedInstance(RemovePackagesFromManagedInstanceRequest request, AsyncHandler<RemovePackagesFromManagedInstanceRequest,RemovePackagesFromManagedInstanceResponse> handler) Removes an installed package from a managed instance.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<SwitchModuleStreamOnManagedInstanceResponse>	switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request, AsyncHandler<SwitchModuleStreamOnManagedInstanceRequest,SwitchModuleStreamOnManagedInstanceResponse> handler) Enables a new stream for a module that already has a stream enabled.
Future<UpdateAllPackagesOnManagedInstancesInCompartmentResponse>	updateAllPackagesOnManagedInstancesInCompartment(UpdateAllPackagesOnManagedInstancesInCompartmentRequest request, AsyncHandler<UpdateAllPackagesOnManagedInstancesInCompartmentRequest,UpdateAllPackagesOnManagedInstancesInCompartmentResponse> handler) Install all of the available package updates for all of the managed instances in a compartment.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateManagedInstanceResponse>	updateManagedInstance(UpdateManagedInstanceRequest request, AsyncHandler<UpdateManagedInstanceRequest,UpdateManagedInstanceResponse> handler) Updates the managed instance.
Future<UpdatePackagesOnManagedInstanceResponse>	updatePackagesOnManagedInstance(UpdatePackagesOnManagedInstanceRequest request, AsyncHandler<UpdatePackagesOnManagedInstanceRequest,UpdatePackagesOnManagedInstanceResponse> handler) Updates a package on a managed instance.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.osmanagementhub.ManagedInstanceAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ManagedInstance.

Constructor Detail

ManagedInstanceAsyncClient

@Deprecated
public ManagedInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagedInstanceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ManagedInstanceAsyncClient

@Deprecated
public ManagedInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagedInstanceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ManagedInstanceAsyncClient

@Deprecated
public ManagedInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagedInstanceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ManagedInstanceAsyncClient

@Deprecated
public ManagedInstanceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagedInstanceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagedInstanceAsyncClient

@Deprecated
public ManagedInstanceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagedInstanceAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagedInstanceAsyncClient

@Deprecated
public ManagedInstanceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              List<ClientConfigurator> additionalClientConfigurators,
                                              String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagedInstanceAsyncClient.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)

ManagedInstanceAsyncClient

@Deprecated
public ManagedInstanceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration,
                                              ClientConfigurator clientConfigurator,
                                              RequestSignerFactory defaultRequestSignerFactory,
                                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                              List<ClientConfigurator> additionalClientConfigurators,
                                              String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ManagedInstanceAsyncClient.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

Method Detail

builder

public static ManagedInstanceAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ManagedInstanceAsync

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface ManagedInstanceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ManagedInstanceAsync

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface ManagedInstanceAsync

Parameters:

regionId - The public region ID.

attachSoftwareSourcesToManagedInstance

public Future<AttachSoftwareSourcesToManagedInstanceResponse> attachSoftwareSourcesToManagedInstance(AttachSoftwareSourcesToManagedInstanceRequest request,
                                                                                                     AsyncHandler<AttachSoftwareSourcesToManagedInstanceRequest,AttachSoftwareSourcesToManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Adds software sources to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance.

Specified by:

attachSoftwareSourcesToManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

detachSoftwareSourcesFromManagedInstance

public Future<DetachSoftwareSourcesFromManagedInstanceResponse> detachSoftwareSourcesFromManagedInstance(DetachSoftwareSourcesFromManagedInstanceRequest request,
                                                                                                         AsyncHandler<DetachSoftwareSourcesFromManagedInstanceRequest,DetachSoftwareSourcesFromManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Removes software sources from a managed instance. Packages will no longer be able to be installed from these software sources.

Specified by:

detachSoftwareSourcesFromManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

disableModuleStreamOnManagedInstance

public Future<DisableModuleStreamOnManagedInstanceResponse> disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request,
                                                                                                 AsyncHandler<DisableModuleStreamOnManagedInstanceRequest,DisableModuleStreamOnManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

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

Specified by:

disableModuleStreamOnManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

enableModuleStreamOnManagedInstance

public Future<EnableModuleStreamOnManagedInstanceResponse> enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request,
                                                                                               AsyncHandler<EnableModuleStreamOnManagedInstanceRequest,EnableModuleStreamOnManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Enables a module stream on a managed instance. After the stream is enabled, it is possible to install the profiles that are contained by the stream. Enabling a stream that is already enabled will succeed. Attempting to enable a different stream for a module that already has a stream enabled results in an error.

Specified by:

enableModuleStreamOnManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getManagedInstance

public Future<GetManagedInstanceResponse> getManagedInstance(GetManagedInstanceRequest request,
                                                             AsyncHandler<GetManagedInstanceRequest,GetManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Gets information about the specified managed instance.

Specified by:

getManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

installModuleStreamProfileOnManagedInstance

public Future<InstallModuleStreamProfileOnManagedInstanceResponse> installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request,
                                                                                                               AsyncHandler<InstallModuleStreamProfileOnManagedInstanceRequest,InstallModuleStreamProfileOnManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Installs a profile for an module stream. The stream must be enabled before a profile can be installed. If a module stream defines multiple profiles, each one can be installed independently.

Specified by:

installModuleStreamProfileOnManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

installPackagesOnManagedInstance

public Future<InstallPackagesOnManagedInstanceResponse> installPackagesOnManagedInstance(InstallPackagesOnManagedInstanceRequest request,
                                                                                         AsyncHandler<InstallPackagesOnManagedInstanceRequest,InstallPackagesOnManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Installs packages on a managed instance.

Specified by:

installPackagesOnManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedInstanceAvailablePackages

public Future<ListManagedInstanceAvailablePackagesResponse> listManagedInstanceAvailablePackages(ListManagedInstanceAvailablePackagesRequest request,
                                                                                                 AsyncHandler<ListManagedInstanceAvailablePackagesRequest,ListManagedInstanceAvailablePackagesResponse> handler)

Description copied from interface: ManagedInstanceAsync

Returns a list of available packages for a managed instance.

Specified by:

listManagedInstanceAvailablePackages in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedInstanceAvailableSoftwareSources

public Future<ListManagedInstanceAvailableSoftwareSourcesResponse> listManagedInstanceAvailableSoftwareSources(ListManagedInstanceAvailableSoftwareSourcesRequest request,
                                                                                                               AsyncHandler<ListManagedInstanceAvailableSoftwareSourcesRequest,ListManagedInstanceAvailableSoftwareSourcesResponse> handler)

Description copied from interface: ManagedInstanceAsync

Returns a list of available software sources for a managed instance.

Specified by:

listManagedInstanceAvailableSoftwareSources in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedInstanceErrata

public Future<ListManagedInstanceErrataResponse> listManagedInstanceErrata(ListManagedInstanceErrataRequest request,
                                                                           AsyncHandler<ListManagedInstanceErrataRequest,ListManagedInstanceErrataResponse> handler)

Description copied from interface: ManagedInstanceAsync

Returns a list of applicable errata on the managed instance.

Specified by:

listManagedInstanceErrata in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedInstanceInstalledPackages

public Future<ListManagedInstanceInstalledPackagesResponse> listManagedInstanceInstalledPackages(ListManagedInstanceInstalledPackagesRequest request,
                                                                                                 AsyncHandler<ListManagedInstanceInstalledPackagesRequest,ListManagedInstanceInstalledPackagesResponse> handler)

Description copied from interface: ManagedInstanceAsync

Lists the packages that are installed on the managed instance.

Specified by:

listManagedInstanceInstalledPackages in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedInstanceModules

public Future<ListManagedInstanceModulesResponse> listManagedInstanceModules(ListManagedInstanceModulesRequest request,
                                                                             AsyncHandler<ListManagedInstanceModulesRequest,ListManagedInstanceModulesResponse> handler)

Description copied from interface: ManagedInstanceAsync

Retrieve a list of modules, along with streams of the modules, from a managed instance. Filters may be applied to select a subset of modules based on the filter criteria.

The 'name' attribute filters against the name of a module. It accepts strings of the format \"\".

The 'nameContains' attribute filters against the name of a module based on partial match. It accepts strings of the format \"\". If this attribute is defined, only matching modules are included in the result set. If it is not defined, the request is not subject to this filter.

Specified by:

listManagedInstanceModules in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedInstanceUpdatablePackages

public Future<ListManagedInstanceUpdatablePackagesResponse> listManagedInstanceUpdatablePackages(ListManagedInstanceUpdatablePackagesRequest request,
                                                                                                 AsyncHandler<ListManagedInstanceUpdatablePackagesRequest,ListManagedInstanceUpdatablePackagesResponse> handler)

Description copied from interface: ManagedInstanceAsync

Returns a list of updatable packages for a managed instance.

Specified by:

listManagedInstanceUpdatablePackages in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listManagedInstances

public Future<ListManagedInstancesResponse> listManagedInstances(ListManagedInstancesRequest request,
                                                                 AsyncHandler<ListManagedInstancesRequest,ListManagedInstancesResponse> handler)

Description copied from interface: ManagedInstanceAsync

Lists managed instances that match the specified compartment or managed instance OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS version.

Specified by:

listManagedInstances in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

manageModuleStreamsOnManagedInstance

public Future<ManageModuleStreamsOnManagedInstanceResponse> manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request,
                                                                                                 AsyncHandler<ManageModuleStreamsOnManagedInstanceRequest,ManageModuleStreamsOnManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

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 work request object. The returned work request 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 Hub 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 work requests. The impact of operations that are allowed by the OS Management Hub service are communicated as one or more work request log entries. Operations that are not allowed by the OS Management Hub service are communicated as one or more work request error entries. Each entry, for either logs or errors, contains a structured message containing the results of one or more operations.

Specified by:

manageModuleStreamsOnManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

refreshSoftwareOnManagedInstance

public Future<RefreshSoftwareOnManagedInstanceResponse> refreshSoftwareOnManagedInstance(RefreshSoftwareOnManagedInstanceRequest request,
                                                                                         AsyncHandler<RefreshSoftwareOnManagedInstanceRequest,RefreshSoftwareOnManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Refresh all installed and updatable software information on a managed instance.

Specified by:

refreshSoftwareOnManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

removeModuleStreamProfileFromManagedInstance

public Future<RemoveModuleStreamProfileFromManagedInstanceResponse> removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request,
                                                                                                                 AsyncHandler<RemoveModuleStreamProfileFromManagedInstanceRequest,RemoveModuleStreamProfileFromManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Removes a profile for a module stream that is installed on a managed instance. If a module stream is provided, rather than a fully qualified profile, all profiles that have been installed for the module stream will be removed.

Specified by:

removeModuleStreamProfileFromManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

removePackagesFromManagedInstance

public Future<RemovePackagesFromManagedInstanceResponse> removePackagesFromManagedInstance(RemovePackagesFromManagedInstanceRequest request,
                                                                                           AsyncHandler<RemovePackagesFromManagedInstanceRequest,RemovePackagesFromManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Removes an installed package from a managed instance.

Specified by:

removePackagesFromManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

switchModuleStreamOnManagedInstance

public Future<SwitchModuleStreamOnManagedInstanceResponse> switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request,
                                                                                               AsyncHandler<SwitchModuleStreamOnManagedInstanceRequest,SwitchModuleStreamOnManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

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

Specified by:

switchModuleStreamOnManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateAllPackagesOnManagedInstancesInCompartment

public Future<UpdateAllPackagesOnManagedInstancesInCompartmentResponse> updateAllPackagesOnManagedInstancesInCompartment(UpdateAllPackagesOnManagedInstancesInCompartmentRequest request,
                                                                                                                         AsyncHandler<UpdateAllPackagesOnManagedInstancesInCompartmentRequest,UpdateAllPackagesOnManagedInstancesInCompartmentResponse> handler)

Description copied from interface: ManagedInstanceAsync

Install all of the available package updates for all of the managed instances in a compartment.

Specified by:

updateAllPackagesOnManagedInstancesInCompartment in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateManagedInstance

public Future<UpdateManagedInstanceResponse> updateManagedInstance(UpdateManagedInstanceRequest request,
                                                                   AsyncHandler<UpdateManagedInstanceRequest,UpdateManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Updates the managed instance.

Specified by:

updateManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updatePackagesOnManagedInstance

public Future<UpdatePackagesOnManagedInstanceResponse> updatePackagesOnManagedInstance(UpdatePackagesOnManagedInstanceRequest request,
                                                                                       AsyncHandler<UpdatePackagesOnManagedInstanceRequest,UpdatePackagesOnManagedInstanceResponse> handler)

Description copied from interface: ManagedInstanceAsync

Updates a package on a managed instance.

Specified by:

updatePackagesOnManagedInstance in interface ManagedInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

clientCall

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)