ApplicationDependencyManagement (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ApplicationDependencyManagementClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220421")
public interface ApplicationDependencyManagement
extends AutoCloseable
```
Use the Application Dependency Management API to create knowledge bases and vulnerability audits. For more information, see ADM. 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 Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelWorkRequestResponse`	`cancelWorkRequest(CancelWorkRequestRequest request)` Cancel work request with the given ID.
`ChangeKnowledgeBaseCompartmentResponse`	`changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request)` Moves a Knowledge Base from one compartment to another.
`ChangeVulnerabilityAuditCompartmentResponse`	`changeVulnerabilityAuditCompartment(ChangeVulnerabilityAuditCompartmentRequest request)` Moves a Vulnerability Audit from one compartment to another.
`CreateKnowledgeBaseResponse`	`createKnowledgeBase(CreateKnowledgeBaseRequest request)` Creates a new Knowledge Base.
`CreateVulnerabilityAuditResponse`	`createVulnerabilityAudit(CreateVulnerabilityAuditRequest request)` Creates a new Vulnerability Audit by providing a tree of Application Dependencies.
`DeleteKnowledgeBaseResponse`	`deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)` Deletes the specified Knowledge Base.
`DeleteVulnerabilityAuditResponse`	`deleteVulnerabilityAudit(DeleteVulnerabilityAuditRequest request)` Deletes the specified Vulnerability Audit.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetKnowledgeBaseResponse`	`getKnowledgeBase(GetKnowledgeBaseRequest request)` Returns the details of the specified Knowledge Base.
`ApplicationDependencyManagementPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetVulnerabilityAuditResponse`	`getVulnerabilityAudit(GetVulnerabilityAuditRequest request)` Returns the details of the specified Vulnerability Audit.
`ApplicationDependencyManagementWaiters`	`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.
`ListApplicationDependencyVulnerabilitiesResponse`	`listApplicationDependencyVulnerabilities(ListApplicationDependencyVulnerabilitiesRequest request)` Returns a list of Application Dependencies with their associated vulnerabilities.
`ListKnowledgeBasesResponse`	`listKnowledgeBases(ListKnowledgeBasesRequest request)` Returns a list of KnowledgeBases based on the specified query parameters.
`ListVulnerabilityAuditsResponse`	`listVulnerabilityAudits(ListVulnerabilityAuditsRequest request)` Returns a list of Vulnerability Audits based on the specified query parameters.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)` Return a (paginated) list of errors for a given work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)` Return a (paginated) list of logs for a given work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)` Lists the work requests in a compartment.
`void`	`refreshClient()` Rebuilds the client from scratch.
`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’).
`UpdateKnowledgeBaseResponse`	`updateKnowledgeBase(UpdateKnowledgeBaseRequest request)` Updates one or more attributes of the specified Knowledge Base.
`UpdateVulnerabilityAuditResponse`	`updateVulnerabilityAudit(UpdateVulnerabilityAuditRequest request)` Updates one or more attributes of the specified Vulnerability Audit.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- 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
  - cancelWorkRequest
```
CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
```
    Cancel 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use CancelWorkRequest API.
  - changeKnowledgeBaseCompartment
```
ChangeKnowledgeBaseCompartmentResponse changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request)
```
    Moves a Knowledge Base from one compartment to another.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use ChangeKnowledgeBaseCompartment API.
  - changeVulnerabilityAuditCompartment
```
ChangeVulnerabilityAuditCompartmentResponse changeVulnerabilityAuditCompartment(ChangeVulnerabilityAuditCompartmentRequest request)
```
    Moves a Vulnerability Audit from one compartment to another.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use ChangeVulnerabilityAuditCompartment API.
  - createKnowledgeBase
```
CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest request)
```
    Creates a new Knowledge Base.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use CreateKnowledgeBase API.
  - createVulnerabilityAudit
```
CreateVulnerabilityAuditResponse createVulnerabilityAudit(CreateVulnerabilityAuditRequest request)
```
    Creates a new Vulnerability Audit by providing a tree of Application Dependencies.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use CreateVulnerabilityAudit API.
  - deleteKnowledgeBase
```
DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
```
    Deletes the specified Knowledge Base.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use DeleteKnowledgeBase API.
  - deleteVulnerabilityAudit
```
DeleteVulnerabilityAuditResponse deleteVulnerabilityAudit(DeleteVulnerabilityAuditRequest request)
```
    Deletes the specified Vulnerability Audit.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use DeleteVulnerabilityAudit API.
  - getKnowledgeBase
```
GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest request)
```
    Returns the details of the specified Knowledge Base.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use GetKnowledgeBase API.
  - getVulnerabilityAudit
```
GetVulnerabilityAuditResponse getVulnerabilityAudit(GetVulnerabilityAuditRequest request)
```
    Returns the details of the specified Vulnerability Audit.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use GetVulnerabilityAudit 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use GetWorkRequest API.
  - listApplicationDependencyVulnerabilities
```
ListApplicationDependencyVulnerabilitiesResponse listApplicationDependencyVulnerabilities(ListApplicationDependencyVulnerabilitiesRequest request)
```
    Returns a list of Application Dependencies with their associated vulnerabilities.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use ListApplicationDependencyVulnerabilities API.
  - listKnowledgeBases
```
ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest request)
```
    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
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use ListKnowledgeBases API.
  - listVulnerabilityAudits
```
ListVulnerabilityAuditsResponse listVulnerabilityAudits(ListVulnerabilityAuditsRequest request)
```
    Returns a list of Vulnerability Audits based on the specified query parameters. At least one of id, compartmentId or knowledgeBaseId query parameter must be provided.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use ListVulnerabilityAudits 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use ListWorkRequests API.
  - updateKnowledgeBase
```
UpdateKnowledgeBaseResponse updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
```
    Updates one or more attributes of the specified Knowledge Base.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use UpdateKnowledgeBase API.
  - updateVulnerabilityAudit
```
UpdateVulnerabilityAuditResponse updateVulnerabilityAudit(UpdateVulnerabilityAuditRequest request)
```
    Updates one or more attributes of the specified Vulnerability Audit.
    
    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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 here to see how to use UpdateVulnerabilityAudit API.
  - getWaiters
```
ApplicationDependencyManagementWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
ApplicationDependencyManagementPaginators 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.

Interface ApplicationDependencyManagement

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

cancelWorkRequest

changeKnowledgeBaseCompartment

changeVulnerabilityAuditCompartment

createKnowledgeBase

createVulnerabilityAudit

deleteKnowledgeBase

deleteVulnerabilityAudit

getKnowledgeBase

getVulnerabilityAudit

getWorkRequest

listApplicationDependencyVulnerabilities

listKnowledgeBases

listVulnerabilityAudits

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateKnowledgeBase

updateVulnerabilityAudit

getWaiters

getPaginators