com.oracle.bmc.osmanagementhub

Class ManagedInstanceGroupClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osmanagementhub.ManagedInstanceGroupClient

All Implemented Interfaces:

ManagedInstanceGroup, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AttachManagedInstancesToManagedInstanceGroupResponse	attachManagedInstancesToManagedInstanceGroup(AttachManagedInstancesToManagedInstanceGroupRequest request) Adds managed instances to the specified managed instance group.
AttachSoftwareSourcesToManagedInstanceGroupResponse	attachSoftwareSourcesToManagedInstanceGroup(AttachSoftwareSourcesToManagedInstanceGroupRequest request) Attaches software sources to the specified managed instance group.
static ManagedInstanceGroupClient.Builder	builder() Create a builder for this client.
void	close()
CreateManagedInstanceGroupResponse	createManagedInstanceGroup(CreateManagedInstanceGroupRequest request) Creates a new managed instance group.
DeleteManagedInstanceGroupResponse	deleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest request) Deletes a specified managed instance group.
DetachManagedInstancesFromManagedInstanceGroupResponse	detachManagedInstancesFromManagedInstanceGroup(DetachManagedInstancesFromManagedInstanceGroupRequest request) Removes a managed instance from the specified managed instance group.
DetachSoftwareSourcesFromManagedInstanceGroupResponse	detachSoftwareSourcesFromManagedInstanceGroup(DetachSoftwareSourcesFromManagedInstanceGroupRequest request) Detaches software sources from a group.
DisableModuleStreamOnManagedInstanceGroupResponse	disableModuleStreamOnManagedInstanceGroup(DisableModuleStreamOnManagedInstanceGroupRequest request) Disables a module stream on a managed instance group.
EnableModuleStreamOnManagedInstanceGroupResponse	enableModuleStreamOnManagedInstanceGroup(EnableModuleStreamOnManagedInstanceGroupRequest request) Enables a module stream on a managed instance group.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetManagedInstanceGroupResponse	getManagedInstanceGroup(GetManagedInstanceGroupRequest request) Gets information about the specified managed instance group.
ManagedInstanceGroupPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ManagedInstanceGroupWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
InstallModuleStreamProfileOnManagedInstanceGroupResponse	installModuleStreamProfileOnManagedInstanceGroup(InstallModuleStreamProfileOnManagedInstanceGroupRequest request) Installs a profile for an module stream.
InstallPackagesOnManagedInstanceGroupResponse	installPackagesOnManagedInstanceGroup(InstallPackagesOnManagedInstanceGroupRequest request) Installs package(s) on each managed instance in a managed instance group.
ListManagedInstanceGroupAvailableModulesResponse	listManagedInstanceGroupAvailableModules(ListManagedInstanceGroupAvailableModulesRequest request) Lists available modules that for the specified managed instance group.
ListManagedInstanceGroupAvailablePackagesResponse	listManagedInstanceGroupAvailablePackages(ListManagedInstanceGroupAvailablePackagesRequest request) Lists available packages on the specified managed instances group.
ListManagedInstanceGroupAvailableSoftwareSourcesResponse	listManagedInstanceGroupAvailableSoftwareSources(ListManagedInstanceGroupAvailableSoftwareSourcesRequest request) Lists available software sources for a specified managed instance group.
ListManagedInstanceGroupInstalledPackagesResponse	listManagedInstanceGroupInstalledPackages(ListManagedInstanceGroupInstalledPackagesRequest request) Lists installed packages on the specified managed instances group.
ListManagedInstanceGroupModulesResponse	listManagedInstanceGroupModules(ListManagedInstanceGroupModulesRequest request) Retrieve a list of module streams, along with a summary of their status, from a managed instance group.
ListManagedInstanceGroupsResponse	listManagedInstanceGroups(ListManagedInstanceGroupsRequest request) Lists managed instance groups that match the specified compartment or managed instance group OCID.
ManageModuleStreamsOnManagedInstanceGroupResponse	manageModuleStreamsOnManagedInstanceGroup(ManageModuleStreamsOnManagedInstanceGroupRequest request) Perform an operation involving modules, streams, and profiles on a managed instance group.
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.
RemoveModuleStreamProfileFromManagedInstanceGroupResponse	removeModuleStreamProfileFromManagedInstanceGroup(RemoveModuleStreamProfileFromManagedInstanceGroupRequest request) Removes a profile for a module stream that is installed on a managed instance group.
RemovePackagesFromManagedInstanceGroupResponse	removePackagesFromManagedInstanceGroup(RemovePackagesFromManagedInstanceGroupRequest request) Removes package(s) from each managed instance in a specified managed instance group.
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’).
UpdateAllPackagesOnManagedInstanceGroupResponse	updateAllPackagesOnManagedInstanceGroup(UpdateAllPackagesOnManagedInstanceGroupRequest request) Updates all packages on each managed instance in the specified managed instance group.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateManagedInstanceGroupResponse	updateManagedInstanceGroup(UpdateManagedInstanceGroupRequest request) Updates the specified managed instance group’s name, description, and tags.
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 com.oracle.bmc.osmanagementhub.ManagedInstanceGroup

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ManagedInstanceGroup.

Constructor Detail

ManagedInstanceGroupClient

@Deprecated
public ManagedInstanceGroupClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ManagedInstanceGroupClient

@Deprecated
public ManagedInstanceGroupClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ManagedInstanceGroupClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ManagedInstanceGroupClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagedInstanceGroupClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagedInstanceGroupClient

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

ManagedInstanceGroupClient

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

ManagedInstanceGroupClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

executorService - ManagedInstanceGroupClient.Builder.executorService

Method Detail

builder

public static ManagedInstanceGroupClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ManagedInstanceGroup

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 ManagedInstanceGroup

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ManagedInstanceGroup

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 ManagedInstanceGroup

Parameters:

regionId - The public region ID.

attachManagedInstancesToManagedInstanceGroup

public AttachManagedInstancesToManagedInstanceGroupResponse attachManagedInstancesToManagedInstanceGroup(AttachManagedInstancesToManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Adds managed instances to the specified managed instance group. After the managed instances have been added, then operations can be performed on the managed instance group which will then apply to all managed instances in the group.

Specified by:

attachManagedInstancesToManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

attachSoftwareSourcesToManagedInstanceGroup

public AttachSoftwareSourcesToManagedInstanceGroupResponse attachSoftwareSourcesToManagedInstanceGroup(AttachSoftwareSourcesToManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Attaches software sources to the specified managed instance group. The software sources must be compatible with the content for the managed instance group.

Specified by:

attachSoftwareSourcesToManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createManagedInstanceGroup

public CreateManagedInstanceGroupResponse createManagedInstanceGroup(CreateManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Creates a new managed instance group.

Specified by:

createManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteManagedInstanceGroup

public DeleteManagedInstanceGroupResponse deleteManagedInstanceGroup(DeleteManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Deletes a specified managed instance group.

Specified by:

deleteManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachManagedInstancesFromManagedInstanceGroup

public DetachManagedInstancesFromManagedInstanceGroupResponse detachManagedInstancesFromManagedInstanceGroup(DetachManagedInstancesFromManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Removes a managed instance from the specified managed instance group.

Specified by:

detachManagedInstancesFromManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachSoftwareSourcesFromManagedInstanceGroup

public DetachSoftwareSourcesFromManagedInstanceGroupResponse detachSoftwareSourcesFromManagedInstanceGroup(DetachSoftwareSourcesFromManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Detaches software sources from a group.

Specified by:

detachSoftwareSourcesFromManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

disableModuleStreamOnManagedInstanceGroup

public DisableModuleStreamOnManagedInstanceGroupResponse disableModuleStreamOnManagedInstanceGroup(DisableModuleStreamOnManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Disables a module stream on a managed instance group. 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:

disableModuleStreamOnManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

enableModuleStreamOnManagedInstanceGroup

public EnableModuleStreamOnManagedInstanceGroupResponse enableModuleStreamOnManagedInstanceGroup(EnableModuleStreamOnManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Enables a module stream on a managed instance group. 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:

enableModuleStreamOnManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getManagedInstanceGroup

public GetManagedInstanceGroupResponse getManagedInstanceGroup(GetManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Gets information about the specified managed instance group.

Specified by:

getManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

installModuleStreamProfileOnManagedInstanceGroup

public InstallModuleStreamProfileOnManagedInstanceGroupResponse installModuleStreamProfileOnManagedInstanceGroup(InstallModuleStreamProfileOnManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

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:

installModuleStreamProfileOnManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

installPackagesOnManagedInstanceGroup

public InstallPackagesOnManagedInstanceGroupResponse installPackagesOnManagedInstanceGroup(InstallPackagesOnManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Installs package(s) on each managed instance in a managed instance group. The package must be compatible with the instances in the managed instance group.

Specified by:

installPackagesOnManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceGroupAvailableModules

public ListManagedInstanceGroupAvailableModulesResponse listManagedInstanceGroupAvailableModules(ListManagedInstanceGroupAvailableModulesRequest request)

Description copied from interface: ManagedInstanceGroup

Lists available modules that for the specified managed instance group. Filter the list against a variety of criteria including but not limited to its name.

Specified by:

listManagedInstanceGroupAvailableModules in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceGroupAvailablePackages

public ListManagedInstanceGroupAvailablePackagesResponse listManagedInstanceGroupAvailablePackages(ListManagedInstanceGroupAvailablePackagesRequest request)

Description copied from interface: ManagedInstanceGroup

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.

Specified by:

listManagedInstanceGroupAvailablePackages in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceGroupAvailableSoftwareSources

public ListManagedInstanceGroupAvailableSoftwareSourcesResponse listManagedInstanceGroupAvailableSoftwareSources(ListManagedInstanceGroupAvailableSoftwareSourcesRequest request)

Description copied from interface: ManagedInstanceGroup

Lists available software sources for a specified managed instance group. Filter the list against a variety of criteria including but not limited to its name.

Specified by:

listManagedInstanceGroupAvailableSoftwareSources in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceGroupInstalledPackages

public ListManagedInstanceGroupInstalledPackagesResponse listManagedInstanceGroupInstalledPackages(ListManagedInstanceGroupInstalledPackagesRequest request)

Description copied from interface: ManagedInstanceGroup

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.

Specified by:

listManagedInstanceGroupInstalledPackages in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceGroupModules

public ListManagedInstanceGroupModulesResponse listManagedInstanceGroupModules(ListManagedInstanceGroupModulesRequest request)

Description copied from interface: ManagedInstanceGroup

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.

Specified by:

listManagedInstanceGroupModules in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstanceGroups

public ListManagedInstanceGroupsResponse listManagedInstanceGroups(ListManagedInstanceGroupsRequest request)

Description copied from interface: ManagedInstanceGroup

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 its name, status, architecture, and OS family.

Specified by:

listManagedInstanceGroups in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

manageModuleStreamsOnManagedInstanceGroup

public ManageModuleStreamsOnManagedInstanceGroupResponse manageModuleStreamsOnManagedInstanceGroup(ManageModuleStreamsOnManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Perform an operation involving modules, streams, and profiles on a managed instance group. 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 group 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 group.

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 work requests. 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 group. 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 work request resulting from a dry run behaves differently than a work request resulting from a committable operation. Dry run work requests 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:

manageModuleStreamsOnManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeModuleStreamProfileFromManagedInstanceGroup

public RemoveModuleStreamProfileFromManagedInstanceGroupResponse removeModuleStreamProfileFromManagedInstanceGroup(RemoveModuleStreamProfileFromManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Removes a profile for a module stream that is installed on a managed instance group. 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:

removeModuleStreamProfileFromManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removePackagesFromManagedInstanceGroup

public RemovePackagesFromManagedInstanceGroupResponse removePackagesFromManagedInstanceGroup(RemovePackagesFromManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Removes package(s) from each managed instance in a specified managed instance group.

Specified by:

removePackagesFromManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAllPackagesOnManagedInstanceGroup

public UpdateAllPackagesOnManagedInstanceGroupResponse updateAllPackagesOnManagedInstanceGroup(UpdateAllPackagesOnManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Updates all packages on each managed instance in the specified managed instance group.

Specified by:

updateAllPackagesOnManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateManagedInstanceGroup

public UpdateManagedInstanceGroupResponse updateManagedInstanceGroup(UpdateManagedInstanceGroupRequest request)

Description copied from interface: ManagedInstanceGroup

Updates the specified managed instance group’s name, description, and tags.

Specified by:

updateManagedInstanceGroup in interface ManagedInstanceGroup

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ManagedInstanceGroupWaiters getWaiters()

Description copied from interface: ManagedInstanceGroup

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface ManagedInstanceGroup

Returns:

The service waiters.

getPaginators

public ManagedInstanceGroupPaginators getPaginators()

Description copied from interface: ManagedInstanceGroup

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 ManagedInstanceGroup

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