@Generated(value="OracleSDKGenerator", comments="API Version: 20200202") public interface ManagementAgent 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.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
CreateDataSourceResponse |
createDataSource(CreateDataSourceRequest request)
Datasource creation request to given Management Agent.
|
CreateManagementAgentInstallKeyResponse |
createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request)
User creates a new install key as part of this API.
|
DeleteDataSourceResponse |
deleteDataSource(DeleteDataSourceRequest request)
Datasource delete request to given Management Agent.
|
DeleteManagementAgentResponse |
deleteManagementAgent(DeleteManagementAgentRequest request)
Deletes a Management Agent resource by identifier
|
DeleteManagementAgentInstallKeyResponse |
deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request)
Deletes a Management Agent install Key resource by identifier
|
DeleteWorkRequestResponse |
deleteWorkRequest(DeleteWorkRequestRequest request)
Cancel the work request with the given ID.
|
DeployPluginsResponse |
deployPlugins(DeployPluginsRequest request)
Deploys Plugins to a given list of agentIds.
|
GetAutoUpgradableConfigResponse |
getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request)
Get the AutoUpgradable configuration for all agents in a tenancy.
|
GetDataSourceResponse |
getDataSource(GetDataSourceRequest request)
Get Datasource details for given Id and given Management Agent.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetManagementAgentResponse |
getManagementAgent(GetManagementAgentRequest request)
Gets complete details of the inventory of a given agent id
|
GetManagementAgentInstallKeyResponse |
getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request)
Gets complete details of the Agent install Key for a given key id
|
GetManagementAgentInstallKeyContentResponse |
getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request)
Returns a file with Management Agent install Key in it
|
ManagementAgentPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
ManagementAgentWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.
|
ListAvailabilityHistoriesResponse |
listAvailabilityHistories(ListAvailabilityHistoriesRequest request)
Lists the availability history records of Management Agent
|
ListDataSourcesResponse |
listDataSources(ListDataSourcesRequest request)
A list of Management Agent Data Sources for the given Management Agent Id.
|
ListManagementAgentImagesResponse |
listManagementAgentImages(ListManagementAgentImagesRequest request)
Get supported agent image information
|
ListManagementAgentInstallKeysResponse |
listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request)
Returns a list of Management Agent installed Keys.
|
ListManagementAgentPluginsResponse |
listManagementAgentPlugins(ListManagementAgentPluginsRequest request)
Returns a list of managementAgentPlugins.
|
ListManagementAgentsResponse |
listManagementAgents(ListManagementAgentsRequest request)
Returns a list of Management Agents.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
SetAutoUpgradableConfigResponse |
setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request)
Sets the AutoUpgradable configuration for all agents in a tenancy.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
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’).
|
SummarizeManagementAgentCountsResponse |
summarizeManagementAgentCounts(SummarizeManagementAgentCountsRequest request)
Gets count of the inventory of agents for a given compartment id, group by, and
isPluginDeployed parameters.
|
SummarizeManagementAgentPluginCountsResponse |
summarizeManagementAgentPluginCounts(SummarizeManagementAgentPluginCountsRequest request)
Gets count of the inventory of management agent plugins for a given compartment id and group
by parameter.
|
UpdateDataSourceResponse |
updateDataSource(UpdateDataSourceRequest request)
Datasource update request to given Management Agent.
|
UpdateManagementAgentResponse |
updateManagementAgent(UpdateManagementAgentRequest request)
API to update the console managed properties of the Management Agent.
|
UpdateManagementAgentInstallKeyResponse |
updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request)
API to update the modifiable properties of the Management Agent install key.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
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 service.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
templateCreateDataSourceResponse createDataSource(CreateDataSourceRequest request)
Datasource creation request to given Management Agent.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDataSource API.
CreateManagementAgentInstallKeyResponse createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request)
User creates a new install key as part of this API.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateManagementAgentInstallKey API.
DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest request)
Datasource delete request to given Management Agent.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDataSource API.
DeleteManagementAgentResponse deleteManagementAgent(DeleteManagementAgentRequest request)
Deletes a Management Agent resource by identifier
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteManagementAgent API.
DeleteManagementAgentInstallKeyResponse deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request)
Deletes a Management Agent install Key resource by identifier
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteManagementAgentInstallKey API.
DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
Cancel the work request with the given ID.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteWorkRequest API.
DeployPluginsResponse deployPlugins(DeployPluginsRequest request)
Deploys Plugins to a given list of agentIds.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeployPlugins API.
GetAutoUpgradableConfigResponse getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetAutoUpgradableConfig API.
GetDataSourceResponse getDataSource(GetDataSourceRequest request)
Get Datasource details for given Id and given Management Agent.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDataSource API.
GetManagementAgentResponse getManagementAgent(GetManagementAgentRequest request)
Gets complete details of the inventory of a given agent id
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetManagementAgent API.
GetManagementAgentInstallKeyResponse getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request)
Gets complete details of the Agent install Key for a given key id
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetManagementAgentInstallKey API.
GetManagementAgentInstallKeyContentResponse getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request)
Returns a file with Management Agent install Key in it
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetManagementAgentInstallKeyContent API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWorkRequest API.
ListAvailabilityHistoriesResponse listAvailabilityHistories(ListAvailabilityHistoriesRequest request)
Lists the availability history records of Management Agent
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAvailabilityHistories API.
ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)
A list of Management Agent Data Sources for the given Management Agent Id.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDataSources API.
ListManagementAgentImagesResponse listManagementAgentImages(ListManagementAgentImagesRequest request)
Get supported agent image information
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListManagementAgentImages API.
ListManagementAgentInstallKeysResponse listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request)
Returns a list of Management Agent installed Keys.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListManagementAgentInstallKeys API.
ListManagementAgentPluginsResponse listManagementAgentPlugins(ListManagementAgentPluginsRequest request)
Returns a list of managementAgentPlugins.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListManagementAgentPlugins API.
ListManagementAgentsResponse listManagementAgents(ListManagementAgentsRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListManagementAgents API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequests API.
SetAutoUpgradableConfigResponse setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SetAutoUpgradableConfig API.
SummarizeManagementAgentCountsResponse summarizeManagementAgentCounts(SummarizeManagementAgentCountsRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeManagementAgentCounts API.
SummarizeManagementAgentPluginCountsResponse summarizeManagementAgentPluginCounts(SummarizeManagementAgentPluginCountsRequest request)
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 sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SummarizeManagementAgentPluginCounts API.
UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest request)
Datasource update request to given Management Agent.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDataSource API.
UpdateManagementAgentResponse updateManagementAgent(UpdateManagementAgentRequest request)
API to update the console managed properties of the Management Agent.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateManagementAgent API.
UpdateManagementAgentInstallKeyResponse updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request)
API to update the modifiable properties of the Management Agent install key.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateManagementAgentInstallKey API.
ManagementAgentWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
ManagementAgentPaginators getPaginators()
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.
Copyright © 2016–2024. All rights reserved.