@Generated(value="OracleSDKGenerator", comments="API Version: 20200202") public class ManagementAgentAsyncClient extends Object implements ManagementAgentAsync
Async client implementation for ManagementAgent service.
There are two ways to use async client:
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. | Modifier and Type | Class and Description |
|---|---|
static class |
ManagementAgentAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for ManagementAgent.
|
| Constructor and Description |
|---|
ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for ManagementAgent.
public ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public ManagementAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public ManagementAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)restClientFactoryBuilder - the builder for the RestClientFactorypublic static ManagementAgentAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
ManagementAgentAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface ManagementAgentAsyncendpoint - The endpoint of the serice.public String getEndpoint()
ManagementAgentAsyncGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface ManagementAgentAsyncpublic void setRegion(Region region)
ManagementAgentAsyncSets 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 ManagementAgentAsyncregion - The region of the service.public void setRegion(String regionId)
ManagementAgentAsyncSets 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 ManagementAgentAsyncregionId - The public region ID.public void close()
close in interface AutoCloseablepublic Future<CreateManagementAgentInstallKeyResponse> createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request, AsyncHandler<CreateManagementAgentInstallKeyRequest,CreateManagementAgentInstallKeyResponse> handler)
ManagementAgentAsyncUser creates a new install key as part of this API.
createManagementAgentInstallKey in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteManagementAgentResponse> deleteManagementAgent(DeleteManagementAgentRequest request, AsyncHandler<DeleteManagementAgentRequest,DeleteManagementAgentResponse> handler)
ManagementAgentAsyncDeletes a Management Agent resource by identifier
deleteManagementAgent in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteManagementAgentInstallKeyResponse> deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request, AsyncHandler<DeleteManagementAgentInstallKeyRequest,DeleteManagementAgentInstallKeyResponse> handler)
ManagementAgentAsyncDeletes a Management Agent install Key resource by identifier
deleteManagementAgentInstallKey in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)
ManagementAgentAsyncCancel the work request with the given ID.
deleteWorkRequest in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeployPluginsResponse> deployPlugins(DeployPluginsRequest request, AsyncHandler<DeployPluginsRequest,DeployPluginsResponse> handler)
ManagementAgentAsyncDeploys Plugins to a given list of agentIds.
deployPlugins in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetAutoUpgradableConfigResponse> getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request, AsyncHandler<GetAutoUpgradableConfigRequest,GetAutoUpgradableConfigResponse> handler)
ManagementAgentAsyncGet the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
getAutoUpgradableConfig in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetManagementAgentResponse> getManagementAgent(GetManagementAgentRequest request, AsyncHandler<GetManagementAgentRequest,GetManagementAgentResponse> handler)
ManagementAgentAsyncGets complete details of the inventory of a given agent id
getManagementAgent in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetManagementAgentInstallKeyResponse> getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request, AsyncHandler<GetManagementAgentInstallKeyRequest,GetManagementAgentInstallKeyResponse> handler)
ManagementAgentAsyncGets complete details of the Agent install Key for a given key id
getManagementAgentInstallKey in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetManagementAgentInstallKeyContentResponse> getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request, AsyncHandler<GetManagementAgentInstallKeyContentRequest,GetManagementAgentInstallKeyContentResponse> handler)
ManagementAgentAsyncReturns a file with Management Agent install Key in it
getManagementAgentInstallKeyContent in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
ManagementAgentAsyncGets the status of the work request with the given ID.
getWorkRequest in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListAvailabilityHistoriesResponse> listAvailabilityHistories(ListAvailabilityHistoriesRequest request, AsyncHandler<ListAvailabilityHistoriesRequest,ListAvailabilityHistoriesResponse> handler)
ManagementAgentAsyncLists the availability history records of Management Agent
listAvailabilityHistories in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListManagementAgentImagesResponse> listManagementAgentImages(ListManagementAgentImagesRequest request, AsyncHandler<ListManagementAgentImagesRequest,ListManagementAgentImagesResponse> handler)
ManagementAgentAsyncGet supported agent image information
listManagementAgentImages in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListManagementAgentInstallKeysResponse> listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request, AsyncHandler<ListManagementAgentInstallKeysRequest,ListManagementAgentInstallKeysResponse> handler)
ManagementAgentAsyncReturns a list of Management Agent installed Keys.
listManagementAgentInstallKeys in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListManagementAgentPluginsResponse> listManagementAgentPlugins(ListManagementAgentPluginsRequest request, AsyncHandler<ListManagementAgentPluginsRequest,ListManagementAgentPluginsResponse> handler)
ManagementAgentAsyncReturns a list of managementAgentPlugins.
listManagementAgentPlugins in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListManagementAgentsResponse> listManagementAgents(ListManagementAgentsRequest request, AsyncHandler<ListManagementAgentsRequest,ListManagementAgentsResponse> handler)
ManagementAgentAsyncReturns a list of Management Agents. If no explicit page size limit is specified, it will default to 5000.
listManagementAgents in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
ManagementAgentAsyncReturn a (paginated) list of errors for a given work request.
listWorkRequestErrors in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
ManagementAgentAsyncReturn a (paginated) list of logs for a given work request.
listWorkRequestLogs in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
ManagementAgentAsyncLists the work requests in a compartment.
listWorkRequests in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<SetAutoUpgradableConfigResponse> setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request, AsyncHandler<SetAutoUpgradableConfigRequest,SetAutoUpgradableConfigResponse> handler)
ManagementAgentAsyncSets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
setAutoUpgradableConfig in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<SummarizeManagementAgentCountsResponse> summarizeManagementAgentCounts(SummarizeManagementAgentCountsRequest request, AsyncHandler<SummarizeManagementAgentCountsRequest,SummarizeManagementAgentCountsResponse> handler)
ManagementAgentAsyncGets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version
summarizeManagementAgentCounts in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<SummarizeManagementAgentPluginCountsResponse> summarizeManagementAgentPluginCounts(SummarizeManagementAgentPluginCountsRequest request, AsyncHandler<SummarizeManagementAgentPluginCountsRequest,SummarizeManagementAgentPluginCountsResponse> handler)
ManagementAgentAsyncGets count of the inventory of management agent plugins for a given compartment id and group by parameter. Supported groupBy parameter: pluginName
summarizeManagementAgentPluginCounts in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateManagementAgentResponse> updateManagementAgent(UpdateManagementAgentRequest request, AsyncHandler<UpdateManagementAgentRequest,UpdateManagementAgentResponse> handler)
ManagementAgentAsyncAPI to update the console managed properties of the Management Agent.
updateManagementAgent in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateManagementAgentInstallKeyResponse> updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request, AsyncHandler<UpdateManagementAgentInstallKeyRequest,UpdateManagementAgentInstallKeyResponse> handler)
ManagementAgentAsyncAPI to update the modifiable properties of the Management Agent install key.
updateManagementAgentInstallKey in interface ManagementAgentAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.