@Generated(value="OracleSDKGenerator", comments="API Version: 20220901") public class ManagedInstanceClient extends BaseSyncClient implements ManagedInstance
Modifier and Type | Class and Description |
---|---|
static class |
ManagedInstanceClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ManagedInstance.
|
Constructor and 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. |
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for ManagedInstance.
@Deprecated public ManagedInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ManagedInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public ManagedInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ManagedInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public ManagedInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ManagedInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public ManagedInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
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
@Deprecated public ManagedInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
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
@Deprecated public ManagedInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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)
@Deprecated public ManagedInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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
public static ManagedInstanceClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
setRegion
in interface ManagedInstance
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface ManagedInstance
regionId
- The public region ID.public AttachSoftwareSourcesToManagedInstanceResponse attachSoftwareSourcesToManagedInstance(AttachSoftwareSourcesToManagedInstanceRequest request)
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.
attachSoftwareSourcesToManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic DetachSoftwareSourcesFromManagedInstanceResponse detachSoftwareSourcesFromManagedInstance(DetachSoftwareSourcesFromManagedInstanceRequest request)
ManagedInstance
Removes software sources from a managed instance. Packages will no longer be able to be installed from these software sources.
detachSoftwareSourcesFromManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic DisableModuleStreamOnManagedInstanceResponse disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request)
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.
disableModuleStreamOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic EnableModuleStreamOnManagedInstanceResponse enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request)
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.
enableModuleStreamOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic GetManagedInstanceResponse getManagedInstance(GetManagedInstanceRequest request)
ManagedInstance
Gets information about the specified managed instance.
getManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic InstallModuleStreamProfileOnManagedInstanceResponse installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request)
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.
installModuleStreamProfileOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic InstallPackagesOnManagedInstanceResponse installPackagesOnManagedInstance(InstallPackagesOnManagedInstanceRequest request)
ManagedInstance
Installs packages on a managed instance.
installPackagesOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceAvailablePackagesResponse listManagedInstanceAvailablePackages(ListManagedInstanceAvailablePackagesRequest request)
ManagedInstance
Returns a list of available packages for a managed instance.
listManagedInstanceAvailablePackages
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceAvailableSoftwareSourcesResponse listManagedInstanceAvailableSoftwareSources(ListManagedInstanceAvailableSoftwareSourcesRequest request)
ManagedInstance
Returns a list of available software sources for a managed instance.
listManagedInstanceAvailableSoftwareSources
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceErrataResponse listManagedInstanceErrata(ListManagedInstanceErrataRequest request)
ManagedInstance
Returns a list of applicable errata on the managed instance.
listManagedInstanceErrata
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceInstalledPackagesResponse listManagedInstanceInstalledPackages(ListManagedInstanceInstalledPackagesRequest request)
ManagedInstance
Lists the packages that are installed on the managed instance.
listManagedInstanceInstalledPackages
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceModulesResponse listManagedInstanceModules(ListManagedInstanceModulesRequest request)
ManagedInstance
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 \"
listManagedInstanceModules
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceUpdatablePackagesResponse listManagedInstanceUpdatablePackages(ListManagedInstanceUpdatablePackagesRequest request)
ManagedInstance
Returns a list of updatable packages for a managed instance.
listManagedInstanceUpdatablePackages
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstancesResponse listManagedInstances(ListManagedInstancesRequest request)
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.
listManagedInstances
in interface ManagedInstance
request
- The request object containing the details to sendpublic ManageModuleStreamsOnManagedInstanceResponse manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request)
ManagedInstance
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.
manageModuleStreamsOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic RefreshSoftwareOnManagedInstanceResponse refreshSoftwareOnManagedInstance(RefreshSoftwareOnManagedInstanceRequest request)
ManagedInstance
Refresh all installed and updatable software information on a managed instance.
refreshSoftwareOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic RemoveModuleStreamProfileFromManagedInstanceResponse removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request)
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.
removeModuleStreamProfileFromManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic RemovePackagesFromManagedInstanceResponse removePackagesFromManagedInstance(RemovePackagesFromManagedInstanceRequest request)
ManagedInstance
Removes an installed package from a managed instance.
removePackagesFromManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic SwitchModuleStreamOnManagedInstanceResponse switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request)
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.
switchModuleStreamOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic UpdateAllPackagesOnManagedInstancesInCompartmentResponse updateAllPackagesOnManagedInstancesInCompartment(UpdateAllPackagesOnManagedInstancesInCompartmentRequest request)
ManagedInstance
Install all of the available package updates for all of the managed instances in a compartment.
updateAllPackagesOnManagedInstancesInCompartment
in interface ManagedInstance
request
- The request object containing the details to sendpublic UpdateManagedInstanceResponse updateManagedInstance(UpdateManagedInstanceRequest request)
ManagedInstance
Updates the managed instance.
updateManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic UpdatePackagesOnManagedInstanceResponse updatePackagesOnManagedInstance(UpdatePackagesOnManagedInstanceRequest request)
ManagedInstance
Updates a package on a managed instance.
updatePackagesOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic ManagedInstancePaginators getPaginators()
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.
getPaginators
in interface ManagedInstance
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
Copyright © 2016–2023. All rights reserved.