com.oracle.bmc.managementagent

Class ManagementAgentAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.managementagent.ManagementAgentAsyncClient

All Implemented Interfaces:

ManagementAgentAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200202")
public class ManagementAgentAsyncClient
extends BaseAsyncClient
implements ManagementAgentAsync

Async client implementation for ManagementAgent service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ManagementAgentAsyncClient.Builder	builder() Create a builder for this client.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateDataSourceResponse>	createDataSource(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResponse> handler) Datasource creation request to given Management Agent.
Future<CreateManagementAgentInstallKeyResponse>	createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request, AsyncHandler<CreateManagementAgentInstallKeyRequest,CreateManagementAgentInstallKeyResponse> handler) User creates a new install key as part of this API.
Future<DeleteDataSourceResponse>	deleteDataSource(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResponse> handler) Datasource delete request to given Management Agent.
Future<DeleteManagementAgentResponse>	deleteManagementAgent(DeleteManagementAgentRequest request, AsyncHandler<DeleteManagementAgentRequest,DeleteManagementAgentResponse> handler) Deletes a Management Agent resource by identifier
Future<DeleteManagementAgentInstallKeyResponse>	deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request, AsyncHandler<DeleteManagementAgentInstallKeyRequest,DeleteManagementAgentInstallKeyResponse> handler) Deletes a Management Agent install Key resource by identifier
Future<DeleteWorkRequestResponse>	deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler) Cancel the work request with the given ID.
Future<DeployPluginsResponse>	deployPlugins(DeployPluginsRequest request, AsyncHandler<DeployPluginsRequest,DeployPluginsResponse> handler) Deploys Plugins to a given list of agentIds.
Future<GetAutoUpgradableConfigResponse>	getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request, AsyncHandler<GetAutoUpgradableConfigRequest,GetAutoUpgradableConfigResponse> handler) Get the AutoUpgradable configuration for all agents in a tenancy.
String	getClientCommonLibraryVersion()
Future<GetDataSourceResponse>	getDataSource(GetDataSourceRequest request, AsyncHandler<GetDataSourceRequest,GetDataSourceResponse> handler) Get Datasource details for given Id and given Management Agent.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetManagementAgentResponse>	getManagementAgent(GetManagementAgentRequest request, AsyncHandler<GetManagementAgentRequest,GetManagementAgentResponse> handler) Gets complete details of the inventory of a given agent id
Future<GetManagementAgentInstallKeyResponse>	getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request, AsyncHandler<GetManagementAgentInstallKeyRequest,GetManagementAgentInstallKeyResponse> handler) Gets complete details of the Agent install Key for a given key id
Future<GetManagementAgentInstallKeyContentResponse>	getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request, AsyncHandler<GetManagementAgentInstallKeyContentRequest,GetManagementAgentInstallKeyContentResponse> handler) Returns a file with Management Agent install Key in it
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request with the given ID.
Future<ListAvailabilityHistoriesResponse>	listAvailabilityHistories(ListAvailabilityHistoriesRequest request, AsyncHandler<ListAvailabilityHistoriesRequest,ListAvailabilityHistoriesResponse> handler) Lists the availability history records of Management Agent
Future<ListDataSourcesResponse>	listDataSources(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResponse> handler) A list of Management Agent Data Sources for the given Management Agent Id.
Future<ListManagementAgentImagesResponse>	listManagementAgentImages(ListManagementAgentImagesRequest request, AsyncHandler<ListManagementAgentImagesRequest,ListManagementAgentImagesResponse> handler) Get supported agent image information
Future<ListManagementAgentInstallKeysResponse>	listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request, AsyncHandler<ListManagementAgentInstallKeysRequest,ListManagementAgentInstallKeysResponse> handler) Returns a list of Management Agent installed Keys.
Future<ListManagementAgentPluginsResponse>	listManagementAgentPlugins(ListManagementAgentPluginsRequest request, AsyncHandler<ListManagementAgentPluginsRequest,ListManagementAgentPluginsResponse> handler) Returns a list of managementAgentPlugins.
Future<ListManagementAgentsResponse>	listManagementAgents(ListManagementAgentsRequest request, AsyncHandler<ListManagementAgentsRequest,ListManagementAgentsResponse> handler) Returns a list of Management Agents.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Return a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
Future<SetAutoUpgradableConfigResponse>	setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request, AsyncHandler<SetAutoUpgradableConfigRequest,SetAutoUpgradableConfigResponse> handler) Sets the AutoUpgradable configuration for all agents in a tenancy.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<SummarizeManagementAgentCountsResponse>	summarizeManagementAgentCounts(SummarizeManagementAgentCountsRequest request, AsyncHandler<SummarizeManagementAgentCountsRequest,SummarizeManagementAgentCountsResponse> handler) Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters.
Future<SummarizeManagementAgentPluginCountsResponse>	summarizeManagementAgentPluginCounts(SummarizeManagementAgentPluginCountsRequest request, AsyncHandler<SummarizeManagementAgentPluginCountsRequest,SummarizeManagementAgentPluginCountsResponse> handler) Gets count of the inventory of management agent plugins for a given compartment id and group by parameter.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateDataSourceResponse>	updateDataSource(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResponse> handler) Datasource update request to given Management Agent.
Future<UpdateManagementAgentResponse>	updateManagementAgent(UpdateManagementAgentRequest request, AsyncHandler<UpdateManagementAgentRequest,UpdateManagementAgentResponse> handler) API to update the console managed properties of the Management Agent.
Future<UpdateManagementAgentInstallKeyResponse>	updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request, AsyncHandler<UpdateManagementAgentInstallKeyRequest,UpdateManagementAgentInstallKeyResponse> handler) API to update the modifiable properties of the Management Agent install key.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.managementagent.ManagementAgentAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ManagementAgent.

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

ManagementAgentAsyncClient

@Deprecated
public ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ManagementAgentAsyncClient

@Deprecated
public ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ManagementAgentAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ManagementAgentAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagementAgentAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagementAgentAsyncClient

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

ManagementAgentAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ManagementAgentAsync

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 ManagementAgentAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ManagementAgentAsync

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 ManagementAgentAsync

Parameters:

regionId - The public region ID.

createDataSource

public Future<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest request,
                                                         AsyncHandler<CreateDataSourceRequest,CreateDataSourceResponse> handler)

Description copied from interface: ManagementAgentAsync

Datasource creation request to given Management Agent.

Specified by:

createDataSource in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

createManagementAgentInstallKey

public Future<CreateManagementAgentInstallKeyResponse> createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request,
                                                                                       AsyncHandler<CreateManagementAgentInstallKeyRequest,CreateManagementAgentInstallKeyResponse> handler)

Description copied from interface: ManagementAgentAsync

User creates a new install key as part of this API.

Specified by:

createManagementAgentInstallKey in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

deleteDataSource

public Future<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest request,
                                                         AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResponse> handler)

Description copied from interface: ManagementAgentAsync

Datasource delete request to given Management Agent.

Specified by:

deleteDataSource in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

deleteManagementAgent

public Future<DeleteManagementAgentResponse> deleteManagementAgent(DeleteManagementAgentRequest request,
                                                                   AsyncHandler<DeleteManagementAgentRequest,DeleteManagementAgentResponse> handler)

Description copied from interface: ManagementAgentAsync

Deletes a Management Agent resource by identifier

Specified by:

deleteManagementAgent in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

deleteManagementAgentInstallKey

public Future<DeleteManagementAgentInstallKeyResponse> deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request,
                                                                                       AsyncHandler<DeleteManagementAgentInstallKeyRequest,DeleteManagementAgentInstallKeyResponse> handler)

Description copied from interface: ManagementAgentAsync

Deletes a Management Agent install Key resource by identifier

Specified by:

deleteManagementAgentInstallKey in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

deleteWorkRequest

public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request,
                                                           AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)

Description copied from interface: ManagementAgentAsync

Cancel the work request with the given ID.

Specified by:

deleteWorkRequest in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

deployPlugins

public Future<DeployPluginsResponse> deployPlugins(DeployPluginsRequest request,
                                                   AsyncHandler<DeployPluginsRequest,DeployPluginsResponse> handler)

Description copied from interface: ManagementAgentAsync

Deploys Plugins to a given list of agentIds.

Specified by:

deployPlugins in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

getAutoUpgradableConfig

public Future<GetAutoUpgradableConfigResponse> getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request,
                                                                       AsyncHandler<GetAutoUpgradableConfigRequest,GetAutoUpgradableConfigResponse> handler)

Description copied from interface: ManagementAgentAsync

Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.

Specified by:

getAutoUpgradableConfig in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

getDataSource

public Future<GetDataSourceResponse> getDataSource(GetDataSourceRequest request,
                                                   AsyncHandler<GetDataSourceRequest,GetDataSourceResponse> handler)

Description copied from interface: ManagementAgentAsync

Get Datasource details for given Id and given Management Agent.

Specified by:

getDataSource in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

getManagementAgent

public Future<GetManagementAgentResponse> getManagementAgent(GetManagementAgentRequest request,
                                                             AsyncHandler<GetManagementAgentRequest,GetManagementAgentResponse> handler)

Description copied from interface: ManagementAgentAsync

Gets complete details of the inventory of a given agent id

Specified by:

getManagementAgent in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

getManagementAgentInstallKey

public Future<GetManagementAgentInstallKeyResponse> getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request,
                                                                                 AsyncHandler<GetManagementAgentInstallKeyRequest,GetManagementAgentInstallKeyResponse> handler)

Description copied from interface: ManagementAgentAsync

Gets complete details of the Agent install Key for a given key id

Specified by:

getManagementAgentInstallKey in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

getManagementAgentInstallKeyContent

public Future<GetManagementAgentInstallKeyContentResponse> getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request,
                                                                                               AsyncHandler<GetManagementAgentInstallKeyContentRequest,GetManagementAgentInstallKeyContentResponse> handler)

Description copied from interface: ManagementAgentAsync

Returns a file with Management Agent install Key in it

Specified by:

getManagementAgentInstallKeyContent in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: ManagementAgentAsync

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listAvailabilityHistories

public Future<ListAvailabilityHistoriesResponse> listAvailabilityHistories(ListAvailabilityHistoriesRequest request,
                                                                           AsyncHandler<ListAvailabilityHistoriesRequest,ListAvailabilityHistoriesResponse> handler)

Description copied from interface: ManagementAgentAsync

Lists the availability history records of Management Agent

Specified by:

listAvailabilityHistories in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listDataSources

public Future<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest request,
                                                       AsyncHandler<ListDataSourcesRequest,ListDataSourcesResponse> handler)

Description copied from interface: ManagementAgentAsync

A list of Management Agent Data Sources for the given Management Agent Id.

Specified by:

listDataSources in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listManagementAgentImages

public Future<ListManagementAgentImagesResponse> listManagementAgentImages(ListManagementAgentImagesRequest request,
                                                                           AsyncHandler<ListManagementAgentImagesRequest,ListManagementAgentImagesResponse> handler)

Description copied from interface: ManagementAgentAsync

Get supported agent image information

Specified by:

listManagementAgentImages in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listManagementAgentInstallKeys

public Future<ListManagementAgentInstallKeysResponse> listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request,
                                                                                     AsyncHandler<ListManagementAgentInstallKeysRequest,ListManagementAgentInstallKeysResponse> handler)

Description copied from interface: ManagementAgentAsync

Returns a list of Management Agent installed Keys.

Specified by:

listManagementAgentInstallKeys in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listManagementAgentPlugins

public Future<ListManagementAgentPluginsResponse> listManagementAgentPlugins(ListManagementAgentPluginsRequest request,
                                                                             AsyncHandler<ListManagementAgentPluginsRequest,ListManagementAgentPluginsResponse> handler)

Description copied from interface: ManagementAgentAsync

Returns a list of managementAgentPlugins.

Specified by:

listManagementAgentPlugins in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listManagementAgents

public Future<ListManagementAgentsResponse> listManagementAgents(ListManagementAgentsRequest request,
                                                                 AsyncHandler<ListManagementAgentsRequest,ListManagementAgentsResponse> handler)

Description copied from interface: ManagementAgentAsync

Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.

Specified by:

listManagementAgents in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: ManagementAgentAsync

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: ManagementAgentAsync

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: ManagementAgentAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

setAutoUpgradableConfig

public Future<SetAutoUpgradableConfigResponse> setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request,
                                                                       AsyncHandler<SetAutoUpgradableConfigRequest,SetAutoUpgradableConfigResponse> handler)

Description copied from interface: ManagementAgentAsync

Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.

Specified by:

setAutoUpgradableConfig in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

summarizeManagementAgentCounts

public Future<SummarizeManagementAgentCountsResponse> summarizeManagementAgentCounts(SummarizeManagementAgentCountsRequest request,
                                                                                     AsyncHandler<SummarizeManagementAgentCountsRequest,SummarizeManagementAgentCountsResponse> handler)

Description copied from interface: ManagementAgentAsync

Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version

Specified by:

summarizeManagementAgentCounts in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

summarizeManagementAgentPluginCounts

public Future<SummarizeManagementAgentPluginCountsResponse> summarizeManagementAgentPluginCounts(SummarizeManagementAgentPluginCountsRequest request,
                                                                                                 AsyncHandler<SummarizeManagementAgentPluginCountsRequest,SummarizeManagementAgentPluginCountsResponse> handler)

Description copied from interface: ManagementAgentAsync

Gets count of the inventory of management agent plugins for a given compartment id and group by parameter. Supported groupBy parameter: pluginName

Specified by:

summarizeManagementAgentPluginCounts in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

updateDataSource

public Future<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest request,
                                                         AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResponse> handler)

Description copied from interface: ManagementAgentAsync

Datasource update request to given Management Agent.

Specified by:

updateDataSource in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

updateManagementAgent

public Future<UpdateManagementAgentResponse> updateManagementAgent(UpdateManagementAgentRequest request,
                                                                   AsyncHandler<UpdateManagementAgentRequest,UpdateManagementAgentResponse> handler)

Description copied from interface: ManagementAgentAsync

API to update the console managed properties of the Management Agent.

Specified by:

updateManagementAgent in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

updateManagementAgentInstallKey

public Future<UpdateManagementAgentInstallKeyResponse> updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request,
                                                                                       AsyncHandler<UpdateManagementAgentInstallKeyRequest,UpdateManagementAgentInstallKeyResponse> handler)

Description copied from interface: ManagementAgentAsync

API to update the modifiable properties of the Management Agent install key.

Specified by:

updateManagementAgentInstallKey in interface ManagementAgentAsync

Parameters:

request - The request object containing the details to send

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

Returns:

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

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

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

Parameters:

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

populateServiceParametersInEndpoint

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

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

Parameters:

endpoint - The endpoint template in use

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

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

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

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

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

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)