Package com.oracle.bmc.adm

Interface ApplicationDependencyManagementAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ApplicationDependencyManagementAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220421")
public interface ApplicationDependencyManagementAsync
extends AutoCloseable
    Use the Application Dependency Management API to create knowledge bases and vulnerability audits.

    For more information, see ADM.

    • 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 serice.

      • 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

      • cancelRemediationRun

        Future<CancelRemediationRunResponse> cancelRemediationRun​(CancelRemediationRunRequest request,
                                                          AsyncHandler<CancelRemediationRunRequest,​CancelRemediationRunResponse> handler)
        Cancels the specified remediation run.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • cancelWorkRequest

        Future<CancelWorkRequestResponse> cancelWorkRequest​(CancelWorkRequestRequest request,
                                                    AsyncHandler<CancelWorkRequestRequest,​CancelWorkRequestResponse> handler)
        Cancel work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createKnowledgeBase

        Future<CreateKnowledgeBaseResponse> createKnowledgeBase​(CreateKnowledgeBaseRequest request,
                                                        AsyncHandler<CreateKnowledgeBaseRequest,​CreateKnowledgeBaseResponse> handler)
        Creates a new Knowledge Base.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createRemediationRun

        Future<CreateRemediationRunResponse> createRemediationRun​(CreateRemediationRunRequest request,
                                                          AsyncHandler<CreateRemediationRunRequest,​CreateRemediationRunResponse> handler)
        Creates a new remediation run.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createVulnerabilityAudit

        Future<CreateVulnerabilityAuditResponse> createVulnerabilityAudit​(CreateVulnerabilityAuditRequest request,
                                                                  AsyncHandler<CreateVulnerabilityAuditRequest,​CreateVulnerabilityAuditResponse> handler)
        Creates a new Vulnerability Audit by providing a tree of Application Dependencies.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteKnowledgeBase

        Future<DeleteKnowledgeBaseResponse> deleteKnowledgeBase​(DeleteKnowledgeBaseRequest request,
                                                        AsyncHandler<DeleteKnowledgeBaseRequest,​DeleteKnowledgeBaseResponse> handler)
        Deletes the specified Knowledge Base.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteRemediationRun

        Future<DeleteRemediationRunResponse> deleteRemediationRun​(DeleteRemediationRunRequest request,
                                                          AsyncHandler<DeleteRemediationRunRequest,​DeleteRemediationRunResponse> handler)
        Deletes the specified remediation run.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getKnowledgeBase

        Future<GetKnowledgeBaseResponse> getKnowledgeBase​(GetKnowledgeBaseRequest request,
                                                  AsyncHandler<GetKnowledgeBaseRequest,​GetKnowledgeBaseResponse> handler)
        Returns the details of the specified Knowledge Base.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getRemediationRecipe

        Future<GetRemediationRecipeResponse> getRemediationRecipe​(GetRemediationRecipeRequest request,
                                                          AsyncHandler<GetRemediationRecipeRequest,​GetRemediationRecipeResponse> handler)
        Returns the details of the specified RemediationRecipe.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getRemediationRun

        Future<GetRemediationRunResponse> getRemediationRun​(GetRemediationRunRequest request,
                                                    AsyncHandler<GetRemediationRunRequest,​GetRemediationRunResponse> handler)
        Returns the details of the specified remediation run.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getStage

        Future<GetStageResponse> getStage​(GetStageRequest request,
                                  AsyncHandler<GetStageRequest,​GetStageResponse> handler)
        Returns the details of the specified Remediation Run Stage.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getVulnerabilityAudit

        Future<GetVulnerabilityAuditResponse> getVulnerabilityAudit​(GetVulnerabilityAuditRequest request,
                                                            AsyncHandler<GetVulnerabilityAuditRequest,​GetVulnerabilityAuditResponse> handler)
        Returns the details of the specified Vulnerability Audit.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Gets the status of the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listKnowledgeBases

        Future<ListKnowledgeBasesResponse> listKnowledgeBases​(ListKnowledgeBasesRequest request,
                                                      AsyncHandler<ListKnowledgeBasesRequest,​ListKnowledgeBasesResponse> handler)
        Returns a list of KnowledgeBases based on the specified query parameters.

        At least id or compartmentId query parameter must be provided.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listRemediationRecipes

        Future<ListRemediationRecipesResponse> listRemediationRecipes​(ListRemediationRecipesRequest request,
                                                              AsyncHandler<ListRemediationRecipesRequest,​ListRemediationRecipesResponse> handler)
        Returns a list of Remediation Recipes based on the specified query parameters.

        The query parameters compartmentId or id must be provided.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listRemediationRuns

        Future<ListRemediationRunsResponse> listRemediationRuns​(ListRemediationRunsRequest request,
                                                        AsyncHandler<ListRemediationRunsRequest,​ListRemediationRunsResponse> handler)
        Returns a list of remediation runs contained by a compartment.

        The query parameter compartmentId is required unless the query parameter id is specified.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listStages

        Future<ListStagesResponse> listStages​(ListStagesRequest request,
                                      AsyncHandler<ListStagesRequest,​ListStagesResponse> handler)
        Returns a list of Remediation Run Stages based on the specified query parameters and Remediation Run identifier.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listVulnerabilityAudits

        Future<ListVulnerabilityAuditsResponse> listVulnerabilityAudits​(ListVulnerabilityAuditsRequest request,
                                                                AsyncHandler<ListVulnerabilityAuditsRequest,​ListVulnerabilityAuditsResponse> handler)
        Returns a list of Vulnerability Audits based on the specified query parameters.

        At least one of id, compartmentId query parameter must be provided.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Return a (paginated) list of errors for a given work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Return a (paginated) list of logs for a given work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateKnowledgeBase

        Future<UpdateKnowledgeBaseResponse> updateKnowledgeBase​(UpdateKnowledgeBaseRequest request,
                                                        AsyncHandler<UpdateKnowledgeBaseRequest,​UpdateKnowledgeBaseResponse> handler)
        Updates one or more attributes of the specified Knowledge Base.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateRemediationRecipe

        Future<UpdateRemediationRecipeResponse> updateRemediationRecipe​(UpdateRemediationRecipeRequest request,
                                                                AsyncHandler<UpdateRemediationRecipeRequest,​UpdateRemediationRecipeResponse> handler)
        Updates one or more attributes of the specified Remediation Recipe.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateRemediationRun

        Future<UpdateRemediationRunResponse> updateRemediationRun​(UpdateRemediationRunRequest request,
                                                          AsyncHandler<UpdateRemediationRunRequest,​UpdateRemediationRunResponse> handler)
        Updates by identifier one or more attributes of the specified remediation run.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateVulnerabilityAudit

        Future<UpdateVulnerabilityAuditResponse> updateVulnerabilityAudit​(UpdateVulnerabilityAuditRequest request,
                                                                  AsyncHandler<UpdateVulnerabilityAuditRequest,​UpdateVulnerabilityAuditResponse> handler)
        Updates one or more attributes of the specified Vulnerability Audit.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.