@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 |
---|---|
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 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.
public final String clientCommonLibraryVersion
@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 AttachProfileToManagedInstanceResponse attachProfileToManagedInstance(AttachProfileToManagedInstanceRequest request)
ManagedInstance
Adds profile to a managed instance. After the profile has been added, the instance can be registered as a managed instance.
attachProfileToManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic 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 DeleteManagedInstanceResponse deleteManagedInstance(DeleteManagedInstanceRequest request)
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.
deleteManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic DetachProfileFromManagedInstanceResponse detachProfileFromManagedInstance(DetachProfileFromManagedInstanceRequest request)
ManagedInstance
Detaches profile from a managed instance. After the profile has been removed, the instance cannot be registered as a managed instance.
detachProfileFromManagedInstance
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 GetWindowsUpdateResponse getWindowsUpdate(GetWindowsUpdateRequest request)
ManagedInstance
Returns a Windows Update object.
getWindowsUpdate
in interface ManagedInstance
request
- The request object containing the details to sendpublic InstallAllWindowsUpdatesOnManagedInstancesInCompartmentResponse installAllWindowsUpdatesOnManagedInstancesInCompartment(InstallAllWindowsUpdatesOnManagedInstancesInCompartmentRequest request)
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.
installAllWindowsUpdatesOnManagedInstancesInCompartment
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 InstallWindowsUpdatesOnManagedInstanceResponse installWindowsUpdatesOnManagedInstance(InstallWindowsUpdatesOnManagedInstanceRequest request)
ManagedInstance
Installs Windows updates on the specified managed instance.
installWindowsUpdatesOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceAvailablePackagesResponse listManagedInstanceAvailablePackages(ListManagedInstanceAvailablePackagesRequest request)
ManagedInstance
Returns a list of packages that are available for installation on 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 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.
listManagedInstanceAvailableSoftwareSources
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceAvailableWindowsUpdatesResponse listManagedInstanceAvailableWindowsUpdates(ListManagedInstanceAvailableWindowsUpdatesRequest request)
ManagedInstance
Returns a list of Windows updates that can be installed on the specified managed instance.
listManagedInstanceAvailableWindowsUpdates
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 ListManagedInstanceInstalledWindowsUpdatesResponse listManagedInstanceInstalledWindowsUpdates(ListManagedInstanceInstalledWindowsUpdatesRequest request)
ManagedInstance
Returns a list of Windows updates that have been installed on the specified managed instance.
listManagedInstanceInstalledWindowsUpdates
in interface ManagedInstance
request
- The request object containing the details to sendpublic ListManagedInstanceModulesResponse listManagedInstanceModules(ListManagedInstanceModulesRequest request)
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.
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 ListWindowsUpdatesResponse listWindowsUpdates(ListWindowsUpdatesRequest request)
ManagedInstance
Lists Windows updates that have been reported to the service.
listWindowsUpdates
in interface ManagedInstance
request
- The request object containing the details to sendpublic ManageModuleStreamsOnManagedInstanceResponse manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request)
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.
manageModuleStreamsOnManagedInstance
in interface ManagedInstance
request
- The request object containing the details to sendpublic RefreshSoftwareOnManagedInstanceResponse refreshSoftwareOnManagedInstance(RefreshSoftwareOnManagedInstanceRequest request)
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.
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. This applies only to standalone non-Windows instances. This will not update instances that belong to a group or lifecycle environment.
updateAllPackagesOnManagedInstancesInCompartment
in interface ManagedInstance
request
- The request object containing the details to sendpublic UpdateManagedInstanceResponse updateManagedInstance(UpdateManagedInstanceRequest request)
ManagedInstance
Updates the specified managed instance information, such as description, ONS topic, and associated management station.
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
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.