com.oracle.bmc.managementagent

Class ManagementAgentClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.managementagent.ManagementAgentClient

All Implemented Interfaces:

ManagementAgent, AutoCloseable

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

Nested Class Summary

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
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for ManagementAgent.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ManagementAgentClient.Builder	builder() Create a builder for this client.
void	close()
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.
String	getClientCommonLibraryVersion()
GetDataSourceResponse	getDataSource(GetDataSourceRequest request) Get Datasource details for given Id and given Management Agent.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
SetAutoUpgradableConfigResponse	setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request) Sets the AutoUpgradable configuration for all agents in a tenancy.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
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.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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 useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

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

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ManagementAgent.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ManagementAgentClient

@Deprecated
public ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ManagementAgentClient

@Deprecated
public ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ManagementAgentClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ManagementAgentClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ManagementAgentClient

@Deprecated
public ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ManagementAgentClient

@Deprecated
public ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ManagementAgentClient

@Deprecated
public ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

ManagementAgentClient

@Deprecated
public ManagementAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint,
                                         ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - ManagementAgentClient.Builder.executorService

Method Detail

builder

public static ManagementAgentClient.Builder builder()

Create a builder for this client.

Returns:

builder

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.

createDataSource

public CreateDataSourceResponse createDataSource(CreateDataSourceRequest request)

Description copied from interface: ManagementAgent

Datasource creation request to given Management Agent.

Specified by:

createDataSource in interface ManagementAgent

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

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

deleteDataSource

public DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest request)

Description copied from interface: ManagementAgent

Datasource delete request to given Management Agent.

Specified by:

deleteDataSource 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

getDataSource

public GetDataSourceResponse getDataSource(GetDataSourceRequest request)

Description copied from interface: ManagementAgent

Get Datasource details for given Id and given Management Agent.

Specified by:

getDataSource 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

listDataSources

public ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)

Description copied from interface: ManagementAgent

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

Specified by:

listDataSources 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

updateDataSource

public UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest request)

Description copied from interface: ManagementAgent

Datasource update request to given Management Agent.

Specified by:

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

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

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

Parameters:

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

populateServiceParametersInEndpoint

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

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

Parameters:

endpoint - The endpoint template in use

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

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

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

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

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

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()