com.oracle.bmc.adm

Class ApplicationDependencyManagementClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.adm.ApplicationDependencyManagementClient

All Implemented Interfaces:

ApplicationDependencyManagement, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220421")
public class ApplicationDependencyManagementClient
extends BaseSyncClient
implements ApplicationDependencyManagement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationDependencyManagementClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for ApplicationDependencyManagement.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ApplicationDependencyManagementClient.Builder	builder() Create a builder for this client.
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.
void	close()
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.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
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.

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

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.adm.ApplicationDependencyManagement

getEndpoint, refreshClient, setEndpoint

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ApplicationDependencyManagement.

Constructor Detail

ApplicationDependencyManagementClient

@Deprecated
public ApplicationDependencyManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ApplicationDependencyManagementClient

@Deprecated
public ApplicationDependencyManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ApplicationDependencyManagementClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ApplicationDependencyManagementClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ApplicationDependencyManagementClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ApplicationDependencyManagementClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

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

ApplicationDependencyManagementClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

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

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

ApplicationDependencyManagementClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

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

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - ApplicationDependencyManagementClient.Builder.executorService

Method Detail

builder

public static ApplicationDependencyManagementClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ApplicationDependencyManagement

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

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

Specified by:

setRegion in interface ApplicationDependencyManagement

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ApplicationDependencyManagement

Sets the region to call (ex, ‘us-phoenix-1’).

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

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

Specified by:

setRegion in interface ApplicationDependencyManagement

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: ApplicationDependencyManagement

Cancel work request with the given ID.

Specified by:

cancelWorkRequest in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeKnowledgeBaseCompartment

public ChangeKnowledgeBaseCompartmentResponse changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request)

Description copied from interface: ApplicationDependencyManagement

Moves a Knowledge Base from one compartment to another.

Specified by:

changeKnowledgeBaseCompartment in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeVulnerabilityAuditCompartment

public ChangeVulnerabilityAuditCompartmentResponse changeVulnerabilityAuditCompartment(ChangeVulnerabilityAuditCompartmentRequest request)

Description copied from interface: ApplicationDependencyManagement

Moves a Vulnerability Audit from one compartment to another.

Specified by:

changeVulnerabilityAuditCompartment in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createKnowledgeBase

public CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest request)

Description copied from interface: ApplicationDependencyManagement

Creates a new Knowledge Base.

Specified by:

createKnowledgeBase in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVulnerabilityAudit

public CreateVulnerabilityAuditResponse createVulnerabilityAudit(CreateVulnerabilityAuditRequest request)

Description copied from interface: ApplicationDependencyManagement

Creates a new Vulnerability Audit by providing a tree of Application Dependencies.

Specified by:

createVulnerabilityAudit in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteKnowledgeBase

public DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)

Description copied from interface: ApplicationDependencyManagement

Deletes the specified Knowledge Base.

Specified by:

deleteKnowledgeBase in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVulnerabilityAudit

public DeleteVulnerabilityAuditResponse deleteVulnerabilityAudit(DeleteVulnerabilityAuditRequest request)

Description copied from interface: ApplicationDependencyManagement

Deletes the specified Vulnerability Audit.

Specified by:

deleteVulnerabilityAudit in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getKnowledgeBase

public GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest request)

Description copied from interface: ApplicationDependencyManagement

Returns the details of the specified Knowledge Base.

Specified by:

getKnowledgeBase in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVulnerabilityAudit

public GetVulnerabilityAuditResponse getVulnerabilityAudit(GetVulnerabilityAuditRequest request)

Description copied from interface: ApplicationDependencyManagement

Returns the details of the specified Vulnerability Audit.

Specified by:

getVulnerabilityAudit in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: ApplicationDependencyManagement

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApplicationDependencyVulnerabilities

public ListApplicationDependencyVulnerabilitiesResponse listApplicationDependencyVulnerabilities(ListApplicationDependencyVulnerabilitiesRequest request)

Description copied from interface: ApplicationDependencyManagement

Returns a list of Application Dependencies with their associated vulnerabilities.

Specified by:

listApplicationDependencyVulnerabilities in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listKnowledgeBases

public ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest request)

Description copied from interface: ApplicationDependencyManagement

Returns a list of KnowledgeBases based on the specified query parameters. At least id or compartmentId query parameter must be provided.

Specified by:

listKnowledgeBases in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVulnerabilityAudits

public ListVulnerabilityAuditsResponse listVulnerabilityAudits(ListVulnerabilityAuditsRequest request)

Description copied from interface: ApplicationDependencyManagement

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.

Specified by:

listVulnerabilityAudits in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: ApplicationDependencyManagement

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: ApplicationDependencyManagement

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: ApplicationDependencyManagement

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateKnowledgeBase

public UpdateKnowledgeBaseResponse updateKnowledgeBase(UpdateKnowledgeBaseRequest request)

Description copied from interface: ApplicationDependencyManagement

Updates one or more attributes of the specified Knowledge Base.

Specified by:

updateKnowledgeBase in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVulnerabilityAudit

public UpdateVulnerabilityAuditResponse updateVulnerabilityAudit(UpdateVulnerabilityAuditRequest request)

Description copied from interface: ApplicationDependencyManagement

Updates one or more attributes of the specified Vulnerability Audit.

Specified by:

updateVulnerabilityAudit in interface ApplicationDependencyManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ApplicationDependencyManagementWaiters getWaiters()

Description copied from interface: ApplicationDependencyManagement

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface ApplicationDependencyManagement

Returns:

The service waiters.

getPaginators

public ApplicationDependencyManagementPaginators getPaginators()

Description copied from interface: ApplicationDependencyManagement

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface ApplicationDependencyManagement

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

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

close

public final void close()

Specified by:

close in interface AutoCloseable