@Generated(value="OracleSDKGenerator", comments="API Version: 20200202") public class ManagementAgentClient extends Object implements ManagementAgent
Modifier and Type | Class and Description |
---|---|
static class |
ManagementAgentClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ManagementAgent.
|
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.
|
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.
|
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.
|
public static final Service SERVICE
Service instance for ManagementAgent.
public ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ManagementAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public 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.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public 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.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public 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.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public 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.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public 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.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public 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.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected 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.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static ManagementAgentClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
ManagementAgent
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ManagementAgent
endpoint
- The endpoint of the service.public String getEndpoint()
ManagementAgent
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface ManagementAgent
public void setRegion(Region region)
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.
setRegion
in interface ManagementAgent
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface ManagementAgent
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public CreateManagementAgentInstallKeyResponse createManagementAgentInstallKey(CreateManagementAgentInstallKeyRequest request)
ManagementAgent
User creates a new install key as part of this API.
createManagementAgentInstallKey
in interface ManagementAgent
request
- The request object containing the details to sendpublic DeleteManagementAgentResponse deleteManagementAgent(DeleteManagementAgentRequest request)
ManagementAgent
Deletes a Management Agent resource by identifier
deleteManagementAgent
in interface ManagementAgent
request
- The request object containing the details to sendpublic DeleteManagementAgentInstallKeyResponse deleteManagementAgentInstallKey(DeleteManagementAgentInstallKeyRequest request)
ManagementAgent
Deletes a Management Agent install Key resource by identifier
deleteManagementAgentInstallKey
in interface ManagementAgent
request
- The request object containing the details to sendpublic DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
ManagementAgent
Cancel the work request with the given ID.
deleteWorkRequest
in interface ManagementAgent
request
- The request object containing the details to sendpublic DeployPluginsResponse deployPlugins(DeployPluginsRequest request)
ManagementAgent
Deploys Plugins to a given list of agentIds.
deployPlugins
in interface ManagementAgent
request
- The request object containing the details to sendpublic GetAutoUpgradableConfigResponse getAutoUpgradableConfig(GetAutoUpgradableConfigRequest request)
ManagementAgent
Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
getAutoUpgradableConfig
in interface ManagementAgent
request
- The request object containing the details to sendpublic GetManagementAgentResponse getManagementAgent(GetManagementAgentRequest request)
ManagementAgent
Gets complete details of the inventory of a given agent id
getManagementAgent
in interface ManagementAgent
request
- The request object containing the details to sendpublic GetManagementAgentInstallKeyResponse getManagementAgentInstallKey(GetManagementAgentInstallKeyRequest request)
ManagementAgent
Gets complete details of the Agent install Key for a given key id
getManagementAgentInstallKey
in interface ManagementAgent
request
- The request object containing the details to sendpublic GetManagementAgentInstallKeyContentResponse getManagementAgentInstallKeyContent(GetManagementAgentInstallKeyContentRequest request)
ManagementAgent
Returns a file with Management Agent install Key in it
getManagementAgentInstallKeyContent
in interface ManagementAgent
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
ManagementAgent
Gets the status of the work request with the given ID.
getWorkRequest
in interface ManagementAgent
request
- The request object containing the details to sendpublic ListAvailabilityHistoriesResponse listAvailabilityHistories(ListAvailabilityHistoriesRequest request)
ManagementAgent
Lists the availability history records of Management Agent
listAvailabilityHistories
in interface ManagementAgent
request
- The request object containing the details to sendpublic ListManagementAgentImagesResponse listManagementAgentImages(ListManagementAgentImagesRequest request)
ManagementAgent
Get supported agent image information
listManagementAgentImages
in interface ManagementAgent
request
- The request object containing the details to sendpublic ListManagementAgentInstallKeysResponse listManagementAgentInstallKeys(ListManagementAgentInstallKeysRequest request)
ManagementAgent
Returns a list of Management Agent installed Keys.
listManagementAgentInstallKeys
in interface ManagementAgent
request
- The request object containing the details to sendpublic ListManagementAgentPluginsResponse listManagementAgentPlugins(ListManagementAgentPluginsRequest request)
ManagementAgent
Returns a list of managementAgentPlugins.
listManagementAgentPlugins
in interface ManagementAgent
request
- The request object containing the details to sendpublic ListManagementAgentsResponse listManagementAgents(ListManagementAgentsRequest request)
ManagementAgent
Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 5000.
listManagementAgents
in interface ManagementAgent
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
ManagementAgent
Return a (paginated) list of errors for a given work request.
listWorkRequestErrors
in interface ManagementAgent
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
ManagementAgent
Return a (paginated) list of logs for a given work request.
listWorkRequestLogs
in interface ManagementAgent
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
ManagementAgent
Lists the work requests in a compartment.
listWorkRequests
in interface ManagementAgent
request
- The request object containing the details to sendpublic SetAutoUpgradableConfigResponse setAutoUpgradableConfig(SetAutoUpgradableConfigRequest request)
ManagementAgent
Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
setAutoUpgradableConfig
in interface ManagementAgent
request
- The request object containing the details to sendpublic SummarizeManagementAgentCountsResponse summarizeManagementAgentCounts(SummarizeManagementAgentCountsRequest request)
ManagementAgent
Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version
summarizeManagementAgentCounts
in interface ManagementAgent
request
- The request object containing the details to sendpublic SummarizeManagementAgentPluginCountsResponse summarizeManagementAgentPluginCounts(SummarizeManagementAgentPluginCountsRequest request)
ManagementAgent
Gets count of the inventory of management agent plugins for a given compartment id and group by parameter. Supported groupBy parameter: pluginName
summarizeManagementAgentPluginCounts
in interface ManagementAgent
request
- The request object containing the details to sendpublic UpdateManagementAgentResponse updateManagementAgent(UpdateManagementAgentRequest request)
ManagementAgent
API to update the console managed properties of the Management Agent.
updateManagementAgent
in interface ManagementAgent
request
- The request object containing the details to sendpublic UpdateManagementAgentInstallKeyResponse updateManagementAgentInstallKey(UpdateManagementAgentInstallKeyRequest request)
ManagementAgent
API to update the modifiable properties of the Management Agent install key.
updateManagementAgentInstallKey
in interface ManagementAgent
request
- The request object containing the details to sendpublic ManagementAgentWaiters getWaiters()
ManagementAgent
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface ManagementAgent
public ManagementAgentPaginators getPaginators()
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.
getPaginators
in interface ManagementAgent
Copyright © 2016–2022. All rights reserved.