Package com.oracle.bmc.managementagent

Interface ManagementAgent

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ManagementAgentClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200202")
public interface ManagementAgent
extends AutoCloseable
    Use the Management Agent API to manage your infrastructure’s management agents, including their plugins and install keys.

    For more information, see Management Agent.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • createDataSource

        CreateDataSourceResponse createDataSource​(CreateDataSourceRequest request)
        Datasource creation request to given Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/CreateDataSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDataSource API.

      • createManagementAgentInstallKey

        CreateManagementAgentInstallKeyResponse createManagementAgentInstallKey​(CreateManagementAgentInstallKeyRequest request)
        User creates a new install key as part of this API.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/CreateManagementAgentInstallKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateManagementAgentInstallKey API.

      • createNamedCredential

        CreateNamedCredentialResponse createNamedCredential​(CreateNamedCredentialRequest request)
        Named credential creation request to given Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/CreateNamedCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateNamedCredential API.

      • deleteDataSource

        DeleteDataSourceResponse deleteDataSource​(DeleteDataSourceRequest request)
        Datasource delete request to given Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/DeleteDataSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDataSource API.

      • deleteManagementAgent

        DeleteManagementAgentResponse deleteManagementAgent​(DeleteManagementAgentRequest request)
        Deletes a Management Agent resource by identifier
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/DeleteManagementAgentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteManagementAgent API.

      • deleteManagementAgentInstallKey

        DeleteManagementAgentInstallKeyResponse deleteManagementAgentInstallKey​(DeleteManagementAgentInstallKeyRequest request)
        Deletes a Management Agent install Key resource by identifier
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/DeleteManagementAgentInstallKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteManagementAgentInstallKey API.

      • deleteNamedCredential

        DeleteNamedCredentialResponse deleteNamedCredential​(DeleteNamedCredentialRequest request)
        Named credential delete request to sent to associated Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/DeleteNamedCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteNamedCredential API.

      • deleteWorkRequest

        DeleteWorkRequestResponse deleteWorkRequest​(DeleteWorkRequestRequest request)
        Cancel the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/DeleteWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteWorkRequest API.

      • deployPlugins

        DeployPluginsResponse deployPlugins​(DeployPluginsRequest request)
        Deploys Plugins to a given list of agentIds.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/DeployPluginsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeployPlugins API.

      • getAutoUpgradableConfig

        GetAutoUpgradableConfigResponse getAutoUpgradableConfig​(GetAutoUpgradableConfigRequest request)
        Get the AutoUpgradable configuration for all agents in a tenancy.

        The supplied compartmentId must be a tenancy root.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/GetAutoUpgradableConfigExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAutoUpgradableConfig API.

      • getDataSource

        GetDataSourceResponse getDataSource​(GetDataSourceRequest request)
        Get Datasource details for given Id and given Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/GetDataSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDataSource API.

      • getManagementAgent

        GetManagementAgentResponse getManagementAgent​(GetManagementAgentRequest request)
        Gets complete details of the inventory of a given agent id
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/GetManagementAgentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetManagementAgent API.

      • getManagementAgentInstallKey

        GetManagementAgentInstallKeyResponse getManagementAgentInstallKey​(GetManagementAgentInstallKeyRequest request)
        Gets complete details of the Agent install Key for a given key id
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/GetManagementAgentInstallKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetManagementAgentInstallKey API.

      • getManagementAgentInstallKeyContent

        GetManagementAgentInstallKeyContentResponse getManagementAgentInstallKeyContent​(GetManagementAgentInstallKeyContentRequest request)
        Returns a file with Management Agent install Key in it
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/GetManagementAgentInstallKeyContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetManagementAgentInstallKeyContent API.

      • getNamedCredential

        GetNamedCredentialResponse getNamedCredential​(GetNamedCredentialRequest request)
        Get Named credential details for given Id and given Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/GetNamedCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetNamedCredential API.

      • getNamedCredentialsMetadatum

        GetNamedCredentialsMetadatumResponse getNamedCredentialsMetadatum​(GetNamedCredentialsMetadatumRequest request)
        Return the Metadata definition for Named Credentials supported by Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/GetNamedCredentialsMetadatumExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetNamedCredentialsMetadatum API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets the status of the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listAvailabilityHistories

        ListAvailabilityHistoriesResponse listAvailabilityHistories​(ListAvailabilityHistoriesRequest request)
        Lists the availability history records of Management Agent
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListAvailabilityHistoriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAvailabilityHistories API.

      • listDataSources

        ListDataSourcesResponse listDataSources​(ListDataSourcesRequest request)
        A list of Management Agent Data Sources for the given Management Agent Id.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListDataSourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDataSources API.

      • listManagementAgentImages

        ListManagementAgentImagesResponse listManagementAgentImages​(ListManagementAgentImagesRequest request)
        Get supported agent image information
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListManagementAgentImagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagementAgentImages API.

      • listManagementAgentInstallKeys

        ListManagementAgentInstallKeysResponse listManagementAgentInstallKeys​(ListManagementAgentInstallKeysRequest request)
        Returns a list of Management Agent installed Keys.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListManagementAgentInstallKeysExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagementAgentInstallKeys API.

      • listManagementAgentPlugins

        ListManagementAgentPluginsResponse listManagementAgentPlugins​(ListManagementAgentPluginsRequest request)
        Returns a list of managementAgentPlugins.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListManagementAgentPluginsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagementAgentPlugins API.

      • listManagementAgents

        ListManagementAgentsResponse listManagementAgents​(ListManagementAgentsRequest request)
        Returns a list of Management Agents.

        If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListManagementAgentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagementAgents API.

      • listNamedCredentials

        ListNamedCredentialsResponse listNamedCredentials​(ListNamedCredentialsRequest request)
        A list of Management Agent Data Sources for the given Management Agent Id.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListNamedCredentialsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListNamedCredentials API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Return a (paginated) list of errors for a given work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.

      • listWorkRequestLogs

        ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Return a (paginated) list of logs for a given work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • setAutoUpgradableConfig

        SetAutoUpgradableConfigResponse setAutoUpgradableConfig​(SetAutoUpgradableConfigRequest request)
        Sets the AutoUpgradable configuration for all agents in a tenancy.

        The supplied compartmentId must be a tenancy root.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/SetAutoUpgradableConfigExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SetAutoUpgradableConfig API.

      • summarizeManagementAgentCounts

        SummarizeManagementAgentCountsResponse summarizeManagementAgentCounts​(SummarizeManagementAgentCountsRequest request)
        Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters.

        Supported groupBy parameters: availabilityStatus, platformType, version

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/SummarizeManagementAgentCountsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SummarizeManagementAgentCounts API.

      • summarizeManagementAgentPluginCounts

        SummarizeManagementAgentPluginCountsResponse summarizeManagementAgentPluginCounts​(SummarizeManagementAgentPluginCountsRequest request)
        Gets count of the inventory of management agent plugins for a given compartment id and group by parameter.

        Supported groupBy parameter: pluginName

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/SummarizeManagementAgentPluginCountsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SummarizeManagementAgentPluginCounts API.

      • updateDataSource

        UpdateDataSourceResponse updateDataSource​(UpdateDataSourceRequest request)
        Datasource update request to given Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/UpdateDataSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDataSource API.

      • updateManagementAgent

        UpdateManagementAgentResponse updateManagementAgent​(UpdateManagementAgentRequest request)
        API to update the console managed properties of the Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/UpdateManagementAgentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateManagementAgent API.

      • updateManagementAgentInstallKey

        UpdateManagementAgentInstallKeyResponse updateManagementAgentInstallKey​(UpdateManagementAgentInstallKeyRequest request)
        API to update the modifiable properties of the Management Agent install key.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/UpdateManagementAgentInstallKeyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateManagementAgentInstallKey API.

      • updateNamedCredential

        UpdateNamedCredentialResponse updateNamedCredential​(UpdateNamedCredentialRequest request)
        Named credential update request to given Management Agent.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/managementagent/UpdateNamedCredentialExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateNamedCredential API.

      • getWaiters

        ManagementAgentWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        ManagementAgentPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.