ManagementAgentClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.managementagent.ManagementAgentClient

All Implemented Interfaces:: ManagementAgent, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200202")
public class ManagementAgentClient
extends Object
implements ManagementAgent

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ManagementAgentClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ManagementAgentClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for ManagementAgent.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for ManagementAgent.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`ManagementAgentClient(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.
	`ManagementAgentClient(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.
	`ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ManagementAgentClient.Builder`	`builder()` Create a builder for this client.
`void`	`close()`
`CreateManagementAgentInstallKeyResponse`	`createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request)` User creates a new install key as part of this API.
`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.
`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
`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.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for ManagementAgent.
- Constructor Detail
  - ManagementAgentClient
```
public ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - ManagementAgentClient
```
public ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - ManagementAgentClient
```
public ManagementAgentClient(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.
    
    Parameters:
    
    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.
  - ManagementAgentClient
```
public ManagementAgentClient(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.
    
    Parameters:
    
    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.
  - ManagementAgentClient
```
public ManagementAgentClient(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.
    
    Parameters:
    
    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.
  - ManagementAgentClient
```
public ManagementAgentClient(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.
    
    Parameters:
    
    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)
  - ManagementAgentClient
```
public ManagementAgentClient(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.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - ManagementAgentClient
```
public ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             ExecutorService executorService)
```
    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.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - ManagementAgentClient
```
protected ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint,
                                ExecutorService executorService,
                                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. Use the ManagementAgentClient.Builder to get access to all these parameters.
    
    Parameters:
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static ManagementAgentClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: ManagementAgent
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface ManagementAgent
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: ManagementAgent
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface ManagementAgent
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: ManagementAgent
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface ManagementAgent
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: ManagementAgent
    
    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 ManagementAgent
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: ManagementAgent
    
    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 ManagementAgent
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - createManagementAgentInstallKey
```
public CreateManagementAgentInstallKeyResponse createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request)
```
    Description copied from interface: ManagementAgent
    
    User creates a new install key as part of this API.
    
    Specified by:
    
    createManagementAgentInstallKey in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteManagementAgent
```
public DeleteManagementAgentResponse deleteManagementAgent(DeleteManagementAgentRequest request)
```
    Description copied from interface: ManagementAgent
    
    Deletes a Management Agent resource by identifier
    
    Specified by:
    
    deleteManagementAgent in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteManagementAgentInstallKey
```
public DeleteManagementAgentInstallKeyResponse deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request)
```
    Description copied from interface: ManagementAgent
    
    Deletes a Management Agent install Key resource by identifier
    
    Specified by:
    
    deleteManagementAgentInstallKey in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteWorkRequest
```
public DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
```
    Description copied from interface: ManagementAgent
    
    Cancel the work request with the given ID.
    
    Specified by:
    
    deleteWorkRequest in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deployPlugins
```
public DeployPluginsResponse deployPlugins(DeployPluginsRequest request)
```
    Description copied from interface: ManagementAgent
    
    Deploys Plugins to a given list of agentIds.
    
    Specified by:
    
    deployPlugins in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getAutoUpgradableConfig
```
public GetAutoUpgradableConfigResponse getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request)
```
    Description copied from interface: ManagementAgent
    
    Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
    
    Specified by:
    
    getAutoUpgradableConfig in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getManagementAgent
```
public GetManagementAgentResponse getManagementAgent(GetManagementAgentRequest request)
```
    Description copied from interface: ManagementAgent
    
    Gets complete details of the inventory of a given agent id
    
    Specified by:
    
    getManagementAgent in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getManagementAgentInstallKey
```
public GetManagementAgentInstallKeyResponse getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request)
```
    Description copied from interface: ManagementAgent
    
    Gets complete details of the Agent install Key for a given key id
    
    Specified by:
    
    getManagementAgentInstallKey in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getManagementAgentInstallKeyContent
```
public GetManagementAgentInstallKeyContentResponse getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request)
```
    Description copied from interface: ManagementAgent
    
    Returns a file with Management Agent install Key in it
    
    Specified by:
    
    getManagementAgentInstallKeyContent in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: ManagementAgent
    
    Gets the status of the work request with the given ID.
    
    Specified by:
    
    getWorkRequest in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listAvailabilityHistories
```
public ListAvailabilityHistoriesResponse listAvailabilityHistories(ListAvailabilityHistoriesRequest request)
```
    Description copied from interface: ManagementAgent
    
    Lists the availability history records of Management Agent
    
    Specified by:
    
    listAvailabilityHistories in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listManagementAgentImages
```
public ListManagementAgentImagesResponse listManagementAgentImages(ListManagementAgentImagesRequest request)
```
    Description copied from interface: ManagementAgent
    
    Get supported agent image information
    
    Specified by:
    
    listManagementAgentImages in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listManagementAgentInstallKeys
```
public ListManagementAgentInstallKeysResponse listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request)
```
    Description copied from interface: ManagementAgent
    
    Returns a list of Management Agent installed Keys.
    
    Specified by:
    
    listManagementAgentInstallKeys in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listManagementAgentPlugins
```
public ListManagementAgentPluginsResponse listManagementAgentPlugins(ListManagementAgentPluginsRequest request)
```
    Description copied from interface: ManagementAgent
    
    Returns a list of managementAgentPlugins.
    
    Specified by:
    
    listManagementAgentPlugins in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listManagementAgents
```
public ListManagementAgentsResponse listManagementAgents(ListManagementAgentsRequest request)
```
    Description copied from interface: ManagementAgent
    
    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 ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: ManagementAgent
    
    Return a (paginated) list of errors for a given work request.
    
    Specified by:
    
    listWorkRequestErrors in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: ManagementAgent
    
    Return a (paginated) list of logs for a given work request.
    
    Specified by:
    
    listWorkRequestLogs in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: ManagementAgent
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - setAutoUpgradableConfig
```
public SetAutoUpgradableConfigResponse setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request)
```
    Description copied from interface: ManagementAgent
    
    Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
    
    Specified by:
    
    setAutoUpgradableConfig in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - summarizeManagementAgentCounts
```
public SummarizeManagementAgentCountsResponse summarizeManagementAgentCounts(SummarizeManagementAgentCountsRequest request)
```
    Description copied from interface: ManagementAgent
    
    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 ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - summarizeManagementAgentPluginCounts
```
public SummarizeManagementAgentPluginCountsResponse summarizeManagementAgentPluginCounts(SummarizeManagementAgentPluginCountsRequest request)
```
    Description copied from interface: ManagementAgent
    
    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 ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateManagementAgent
```
public UpdateManagementAgentResponse updateManagementAgent(UpdateManagementAgentRequest request)
```
    Description copied from interface: ManagementAgent
    
    API to update the console managed properties of the Management Agent.
    
    Specified by:
    
    updateManagementAgent in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateManagementAgentInstallKey
```
public UpdateManagementAgentInstallKeyResponse updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request)
```
    Description copied from interface: ManagementAgent
    
    API to update the modifiable properties of the Management Agent install key.
    
    Specified by:
    
    updateManagementAgentInstallKey in interface ManagementAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public ManagementAgentWaiters getWaiters()
```
    Description copied from interface: ManagementAgent
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface ManagementAgent
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public ManagementAgentPaginators getPaginators()
```
    Description copied from interface: ManagementAgent
    
    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.
    
    Specified by:
    
    getPaginators in interface ManagementAgent
    
    Returns:
    
    The service paginators.

Class ManagementAgentClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

ManagementAgentClient

ManagementAgentClient

ManagementAgentClient

ManagementAgentClient

ManagementAgentClient

ManagementAgentClient

ManagementAgentClient

ManagementAgentClient

ManagementAgentClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

createManagementAgentInstallKey

deleteManagementAgent

deleteManagementAgentInstallKey

deleteWorkRequest

deployPlugins

getAutoUpgradableConfig

getManagementAgent

getManagementAgentInstallKey

getManagementAgentInstallKeyContent

getWorkRequest

listAvailabilityHistories

listManagementAgentImages

listManagementAgentInstallKeys

listManagementAgentPlugins

listManagementAgents

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

setAutoUpgradableConfig

summarizeManagementAgentCounts

summarizeManagementAgentPluginCounts

updateManagementAgent

updateManagementAgentInstallKey

getWaiters

getPaginators