Package com.oracle.bmc.osmanagementhub

Class ManagedInstanceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osmanagementhub.ManagedInstanceClient

All Implemented Interfaces:

ManagedInstance, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class ManagedInstanceClient
extends BaseSyncClient
implements ManagedInstance

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for ManagedInstance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AssociateManagedInstancesWithManagementStationResponse	associateManagedInstancesWithManagementStation(AssociateManagedInstancesWithManagementStationRequest request)	Associates managed instances to the specified management station
AttachProfileToManagedInstanceResponse	attachProfileToManagedInstance(AttachProfileToManagedInstanceRequest request)	Adds profile to a managed instance.
AttachSoftwareSourcesToManagedInstanceResponse	attachSoftwareSourcesToManagedInstance(AttachSoftwareSourcesToManagedInstanceRequest request)	Adds software sources to a managed instance.
static ManagedInstanceClient.Builder	builder()	Create a builder for this client.
void	close()
DeleteManagedInstanceResponse	deleteManagedInstance(DeleteManagedInstanceRequest request)	Unregisters the specified managed instance from the service.
DetachProfileFromManagedInstanceResponse	detachProfileFromManagedInstance(DetachProfileFromManagedInstanceRequest request)	Detaches profile from a managed instance.
DetachSoftwareSourcesFromManagedInstanceResponse	detachSoftwareSourcesFromManagedInstance(DetachSoftwareSourcesFromManagedInstanceRequest request)	Removes software sources from a managed instance.
DisableModuleStreamOnManagedInstanceResponse	disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request)	Disables a module stream on a managed instance.
EnableModuleStreamOnManagedInstanceResponse	enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request)	Enables a module stream on a managed instance.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetManagedInstanceResponse	getManagedInstance(GetManagedInstanceRequest request)	Gets information about the specified managed instance.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
ManagedInstancePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetWindowsUpdateResponse	getWindowsUpdate(GetWindowsUpdateRequest request)	Returns a Windows Update object.
InstallAllWindowsUpdatesOnManagedInstancesInCompartmentResponse	installAllWindowsUpdatesOnManagedInstancesInCompartment(InstallAllWindowsUpdatesOnManagedInstancesInCompartmentRequest request)	Installs all of the available Windows updates for managed instances in a compartment.
InstallModuleStreamProfileOnManagedInstanceResponse	installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request)	Installs a profile for an module stream.
InstallPackagesOnManagedInstanceResponse	installPackagesOnManagedInstance(InstallPackagesOnManagedInstanceRequest request)	Installs packages on a managed instance.
InstallWindowsUpdatesOnManagedInstanceResponse	installWindowsUpdatesOnManagedInstance(InstallWindowsUpdatesOnManagedInstanceRequest request)	Installs Windows updates on the specified managed instance.
ListManagedInstanceAvailablePackagesResponse	listManagedInstanceAvailablePackages(ListManagedInstanceAvailablePackagesRequest request)	Returns a list of packages that are available for installation on a managed instance.
ListManagedInstanceAvailableSoftwareSourcesResponse	listManagedInstanceAvailableSoftwareSources(ListManagedInstanceAvailableSoftwareSourcesRequest request)	Returns a list of software sources that can be attached to the specified managed instance.
ListManagedInstanceAvailableWindowsUpdatesResponse	listManagedInstanceAvailableWindowsUpdates(ListManagedInstanceAvailableWindowsUpdatesRequest request)	Returns a list of Windows updates that can be installed on the specified managed instance.
ListManagedInstanceErrataResponse	listManagedInstanceErrata(ListManagedInstanceErrataRequest request)	Returns a list of applicable errata on the managed instance.
ListManagedInstanceInstalledPackagesResponse	listManagedInstanceInstalledPackages(ListManagedInstanceInstalledPackagesRequest request)	Lists the packages that are installed on the managed instance.
ListManagedInstanceInstalledWindowsUpdatesResponse	listManagedInstanceInstalledWindowsUpdates(ListManagedInstanceInstalledWindowsUpdatesRequest request)	Returns a list of Windows updates that have been installed on the specified managed instance.
ListManagedInstanceModulesResponse	listManagedInstanceModules(ListManagedInstanceModulesRequest request)	Retrieves a list of modules, along with streams of the modules, from a managed instance.
ListManagedInstancesResponse	listManagedInstances(ListManagedInstancesRequest request)	Lists managed instances that match the specified compartment or managed instance OCID.
ListManagedInstanceUpdatablePackagesResponse	listManagedInstanceUpdatablePackages(ListManagedInstanceUpdatablePackagesRequest request)	Returns a list of updatable packages for a managed instance.
ListWindowsUpdatesResponse	listWindowsUpdates(ListWindowsUpdatesRequest request)	Lists Windows updates that have been reported to the service.
ManageModuleStreamsOnManagedInstanceResponse	manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request)	Enables or disables module streams and installs or removes module stream profiles.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
RebootManagedInstanceResponse	rebootManagedInstance(RebootManagedInstanceRequest request)	Initiates a reboot of the specified managed instance.
void	refreshClient()	Rebuild the backing HttpClient.
RefreshSoftwareOnManagedInstanceResponse	refreshSoftwareOnManagedInstance(RefreshSoftwareOnManagedInstanceRequest request)	Refreshes the package or Windows update information on a managed instance with the latest data from the software source.
RemoveModuleStreamProfileFromManagedInstanceResponse	removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request)	Removes a profile for a module stream that is installed on a managed instance.
RemovePackagesFromManagedInstanceResponse	removePackagesFromManagedInstance(RemovePackagesFromManagedInstanceRequest request)	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’).
SwitchModuleStreamOnManagedInstanceResponse	switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request)	Enables a new stream for a module that already has a stream enabled.
UpdateAllPackagesOnManagedInstancesInCompartmentResponse	updateAllPackagesOnManagedInstancesInCompartment(UpdateAllPackagesOnManagedInstancesInCompartmentRequest request)	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.
UpdateManagedInstanceResponse	updateManagedInstance(UpdateManagedInstanceRequest request)	Updates the specified managed instance information, such as description, ONS topic, and associated management station.
UpdatePackagesOnManagedInstanceResponse	updatePackagesOnManagedInstance(UpdatePackagesOnManagedInstanceRequest request)	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 com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

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

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ManagedInstance.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ManagedInstanceClient

@Deprecated
public ManagedInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

ManagedInstanceClient

@Deprecated
public ManagedInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ManagedInstanceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ManagedInstanceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagedInstanceClient

@Deprecated
public ManagedInstanceClient(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 ManagedInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagedInstanceClient

@Deprecated
public ManagedInstanceClient(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 ManagedInstanceClient.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)

ManagedInstanceClient

@Deprecated
public ManagedInstanceClient(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 ManagedInstanceClient.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 ManagedInstanceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

regionId - The public region ID.

associateManagedInstancesWithManagementStation

public AssociateManagedInstancesWithManagementStationResponse associateManagedInstancesWithManagementStation(AssociateManagedInstancesWithManagementStationRequest request)

Description copied from interface: ManagedInstance

Associates managed instances to the specified management station

Specified by:

associateManagedInstancesWithManagementStation in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

attachProfileToManagedInstance

public AttachProfileToManagedInstanceResponse attachProfileToManagedInstance(AttachProfileToManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Adds profile to a managed instance.

After the profile has been added, the instance can be registered as a managed instance.

Specified by:

attachProfileToManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

attachSoftwareSourcesToManagedInstance

public AttachSoftwareSourcesToManagedInstanceResponse attachSoftwareSourcesToManagedInstance(AttachSoftwareSourcesToManagedInstanceRequest request)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteManagedInstance

public DeleteManagedInstanceResponse deleteManagedInstance(DeleteManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Unregisters the specified managed instance from the service.

Once unregistered, the service will no longer manage the instance. For Linux instances, yum or DNF repository files will be restored to their state prior to registration.

Specified by:

deleteManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachProfileFromManagedInstance

public DetachProfileFromManagedInstanceResponse detachProfileFromManagedInstance(DetachProfileFromManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Detaches profile from a managed instance.

After the profile has been removed, the instance cannot be registered as a managed instance.

Specified by:

detachProfileFromManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachSoftwareSourcesFromManagedInstance

public DetachSoftwareSourcesFromManagedInstanceResponse detachSoftwareSourcesFromManagedInstance(DetachSoftwareSourcesFromManagedInstanceRequest request)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

disableModuleStreamOnManagedInstance

public DisableModuleStreamOnManagedInstanceResponse disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

enableModuleStreamOnManagedInstance

public EnableModuleStreamOnManagedInstanceResponse enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getManagedInstance

public GetManagedInstanceResponse getManagedInstance(GetManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Gets information about the specified managed instance.

Specified by:

getManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWindowsUpdate

public GetWindowsUpdateResponse getWindowsUpdate(GetWindowsUpdateRequest request)

Description copied from interface: ManagedInstance

Returns a Windows Update object.

Specified by:

getWindowsUpdate in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

installAllWindowsUpdatesOnManagedInstancesInCompartment

public InstallAllWindowsUpdatesOnManagedInstancesInCompartmentResponse installAllWindowsUpdatesOnManagedInstancesInCompartment(InstallAllWindowsUpdatesOnManagedInstancesInCompartmentRequest request)

Description copied from interface: ManagedInstance

Installs all of the available Windows updates for managed instances in a compartment.

This applies only to standalone Windows instances. This will not update instances that belong to a group.

Specified by:

installAllWindowsUpdatesOnManagedInstancesInCompartment in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

installModuleStreamProfileOnManagedInstance

public InstallModuleStreamProfileOnManagedInstanceResponse installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

installPackagesOnManagedInstance

public InstallPackagesOnManagedInstanceResponse installPackagesOnManagedInstance(InstallPackagesOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Installs packages on a managed instance.

Specified by:

installPackagesOnManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

installWindowsUpdatesOnManagedInstance

public InstallWindowsUpdatesOnManagedInstanceResponse installWindowsUpdatesOnManagedInstance(InstallWindowsUpdatesOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Installs Windows updates on the specified managed instance.

Specified by:

installWindowsUpdatesOnManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceAvailablePackages

public ListManagedInstanceAvailablePackagesResponse listManagedInstanceAvailablePackages(ListManagedInstanceAvailablePackagesRequest request)

Description copied from interface: ManagedInstance

Returns a list of packages that are available for installation on a managed instance.

Specified by:

listManagedInstanceAvailablePackages in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceAvailableSoftwareSources

public ListManagedInstanceAvailableSoftwareSourcesResponse listManagedInstanceAvailableSoftwareSources(ListManagedInstanceAvailableSoftwareSourcesRequest request)

Description copied from interface: ManagedInstance

Returns a list of software sources that can be attached to the specified managed instance.

Any software sources already attached to the instance are not included in the list.

Specified by:

listManagedInstanceAvailableSoftwareSources in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceAvailableWindowsUpdates

public ListManagedInstanceAvailableWindowsUpdatesResponse listManagedInstanceAvailableWindowsUpdates(ListManagedInstanceAvailableWindowsUpdatesRequest request)

Description copied from interface: ManagedInstance

Returns a list of Windows updates that can be installed on the specified managed instance.

Specified by:

listManagedInstanceAvailableWindowsUpdates in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceErrata

public ListManagedInstanceErrataResponse listManagedInstanceErrata(ListManagedInstanceErrataRequest request)

Description copied from interface: ManagedInstance

Returns a list of applicable errata on the managed instance.

Specified by:

listManagedInstanceErrata in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceInstalledPackages

public ListManagedInstanceInstalledPackagesResponse listManagedInstanceInstalledPackages(ListManagedInstanceInstalledPackagesRequest request)

Description copied from interface: ManagedInstance

Lists the packages that are installed on the managed instance.

Specified by:

listManagedInstanceInstalledPackages in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceInstalledWindowsUpdates

public ListManagedInstanceInstalledWindowsUpdatesResponse listManagedInstanceInstalledWindowsUpdates(ListManagedInstanceInstalledWindowsUpdatesRequest request)

Description copied from interface: ManagedInstance

Returns a list of Windows updates that have been installed on the specified managed instance.

Specified by:

listManagedInstanceInstalledWindowsUpdates in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceModules

public ListManagedInstanceModulesResponse listManagedInstanceModules(ListManagedInstanceModulesRequest request)

Description copied from interface: ManagedInstance

Retrieves 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.

Specified by:

listManagedInstanceModules in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceUpdatablePackages

public ListManagedInstanceUpdatablePackagesResponse listManagedInstanceUpdatablePackages(ListManagedInstanceUpdatablePackagesRequest request)

Description copied from interface: ManagedInstance

Returns a list of updatable packages for a managed instance.

Specified by:

listManagedInstanceUpdatablePackages in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstances

public ListManagedInstancesResponse listManagedInstances(ListManagedInstancesRequest request)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWindowsUpdates

public ListWindowsUpdatesResponse listWindowsUpdates(ListWindowsUpdatesRequest request)

Description copied from interface: ManagedInstance

Lists Windows updates that have been reported to the service.

Specified by:

listWindowsUpdates in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

manageModuleStreamsOnManagedInstance

public ManageModuleStreamsOnManagedInstanceResponse manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

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 manageModuleStreamsOnManagedInstanceDetails 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.

Specified by:

manageModuleStreamsOnManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rebootManagedInstance

public RebootManagedInstanceResponse rebootManagedInstance(RebootManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Initiates a reboot of the specified managed instance.

You can also specify the number of minutes the service waits before marking the reboot operation as failed.

Specified by:

rebootManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

refreshSoftwareOnManagedInstance

public RefreshSoftwareOnManagedInstanceResponse refreshSoftwareOnManagedInstance(RefreshSoftwareOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Refreshes the package or Windows update information on a managed instance with the latest data from the software source.

This does not update packages on the instance. It provides the service with the latest package data.

Specified by:

refreshSoftwareOnManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeModuleStreamProfileFromManagedInstance

public RemoveModuleStreamProfileFromManagedInstanceResponse removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removePackagesFromManagedInstance

public RemovePackagesFromManagedInstanceResponse removePackagesFromManagedInstance(RemovePackagesFromManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Removes an installed package from a managed instance.

Specified by:

removePackagesFromManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

switchModuleStreamOnManagedInstance

public SwitchModuleStreamOnManagedInstanceResponse switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

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 ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAllPackagesOnManagedInstancesInCompartment

public UpdateAllPackagesOnManagedInstancesInCompartmentResponse updateAllPackagesOnManagedInstancesInCompartment(UpdateAllPackagesOnManagedInstancesInCompartmentRequest request)

Description copied from interface: ManagedInstance

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

This applies only to standalone non-Windows instances. This will not update instances that belong to a group or lifecycle environment.

Specified by:

updateAllPackagesOnManagedInstancesInCompartment in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateManagedInstance

public UpdateManagedInstanceResponse updateManagedInstance(UpdateManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Updates the specified managed instance information, such as description, ONS topic, and associated management station.

Specified by:

updateManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePackagesOnManagedInstance

public UpdatePackagesOnManagedInstanceResponse updatePackagesOnManagedInstance(UpdatePackagesOnManagedInstanceRequest request)

Description copied from interface: ManagedInstance

Updates a package on a managed instance.

Specified by:

updatePackagesOnManagedInstance in interface ManagedInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public ManagedInstancePaginators getPaginators()

Description copied from interface: ManagedInstance

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface ManagedInstance

Returns:

The service paginators.

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

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()