@Generated(value="OracleSDKGenerator", comments="API Version: 20200202") public interface ManagementAgentAsync extends AutoCloseable
Use the Management Agent API to manage your infrastructure’s management agents, including their plugins and install keys. For more information, see Management Agent.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
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.
region
- The region of the service.void setRegion(String regionId)
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
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResponse> handler)
Datasource creation request to given Management Agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateManagementAgentInstallKeyResponse> createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request, AsyncHandler<CreateManagementAgentInstallKeyRequest,CreateManagementAgentInstallKeyResponse> handler)
User creates a new install key as part of this API.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResponse> handler)
Datasource delete request to given Management Agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteManagementAgentResponse> deleteManagementAgent(DeleteManagementAgentRequest request, AsyncHandler<DeleteManagementAgentRequest,DeleteManagementAgentResponse> handler)
Deletes a Management Agent resource by identifier
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteManagementAgentInstallKeyResponse> deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request, AsyncHandler<DeleteManagementAgentInstallKeyRequest,DeleteManagementAgentInstallKeyResponse> handler)
Deletes a Management Agent install Key resource by identifier
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)
Cancel the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeployPluginsResponse> deployPlugins(DeployPluginsRequest request, AsyncHandler<DeployPluginsRequest,DeployPluginsResponse> handler)
Deploys Plugins to a given list of agentIds.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAutoUpgradableConfigResponse> getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request, AsyncHandler<GetAutoUpgradableConfigRequest,GetAutoUpgradableConfigResponse> handler)
Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDataSourceResponse> getDataSource(GetDataSourceRequest request, AsyncHandler<GetDataSourceRequest,GetDataSourceResponse> handler)
Get Datasource details for given Id and given Management Agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetManagementAgentResponse> getManagementAgent(GetManagementAgentRequest request, AsyncHandler<GetManagementAgentRequest,GetManagementAgentResponse> handler)
Gets complete details of the inventory of a given agent id
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetManagementAgentInstallKeyResponse> getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request, AsyncHandler<GetManagementAgentInstallKeyRequest,GetManagementAgentInstallKeyResponse> handler)
Gets complete details of the Agent install Key for a given key id
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetManagementAgentInstallKeyContentResponse> getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request, AsyncHandler<GetManagementAgentInstallKeyContentRequest,GetManagementAgentInstallKeyContentResponse> handler)
Returns a file with Management Agent install Key in it
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets the status of the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAvailabilityHistoriesResponse> listAvailabilityHistories(ListAvailabilityHistoriesRequest request, AsyncHandler<ListAvailabilityHistoriesRequest,ListAvailabilityHistoriesResponse> handler)
Lists the availability history records of Management Agent
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResponse> handler)
A list of Management Agent Data Sources for the given Management Agent Id.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListManagementAgentImagesResponse> listManagementAgentImages(ListManagementAgentImagesRequest request, AsyncHandler<ListManagementAgentImagesRequest,ListManagementAgentImagesResponse> handler)
Get supported agent image information
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListManagementAgentInstallKeysResponse> listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request, AsyncHandler<ListManagementAgentInstallKeysRequest,ListManagementAgentInstallKeysResponse> handler)
Returns a list of Management Agent installed Keys.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListManagementAgentPluginsResponse> listManagementAgentPlugins(ListManagementAgentPluginsRequest request, AsyncHandler<ListManagementAgentPluginsRequest,ListManagementAgentPluginsResponse> handler)
Returns a list of managementAgentPlugins.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListManagementAgentsResponse> listManagementAgents(ListManagementAgentsRequest request, AsyncHandler<ListManagementAgentsRequest,ListManagementAgentsResponse> handler)
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.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Return a (paginated) list of errors for a given work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Return a (paginated) list of logs for a given work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<SetAutoUpgradableConfigResponse> setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request, AsyncHandler<SetAutoUpgradableConfigRequest,SetAutoUpgradableConfigResponse> handler)
Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.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. Supported groupBy parameters: availabilityStatus, platformType, version
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.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. Supported groupBy parameter: pluginName
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResponse> handler)
Datasource update request to given Management Agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateManagementAgentResponse> updateManagementAgent(UpdateManagementAgentRequest request, AsyncHandler<UpdateManagementAgentRequest,UpdateManagementAgentResponse> handler)
API to update the console managed properties of the Management Agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateManagementAgentInstallKeyResponse> updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request, AsyncHandler<UpdateManagementAgentInstallKeyRequest,UpdateManagementAgentInstallKeyResponse> handler)
API to update the modifiable properties of the Management Agent install key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.