Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationDependencyManagementClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • ApplicationDependencyManagementClient

Constructors

constructor

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "ApplicationDependencyManagement"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://adm.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • 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: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

activateRemediationRecipe

cancelRemediationRun

  • Cancels the specified remediation run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelRemediationRun API.

    Parameters

    Returns Promise<CancelRemediationRunResponse>

    CancelRemediationRunResponse

cancelWorkRequest

  • Cancel work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelWorkRequest API.

    Parameters

    Returns Promise<CancelWorkRequestResponse>

    CancelWorkRequestResponse

changeKnowledgeBaseCompartment

changeRemediationRecipeCompartment

changeRemediationRunCompartment

changeVulnerabilityAuditCompartment

close

  • close(): void

createKnowledgeBase

  • Creates a new Knowledge Base. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateKnowledgeBase API.

    Parameters

    Returns Promise<CreateKnowledgeBaseResponse>

    CreateKnowledgeBaseResponse

createRemediationRecipe

createRemediationRun

  • Creates a new remediation run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateRemediationRun API.

    Parameters

    Returns Promise<CreateRemediationRunResponse>

    CreateRemediationRunResponse

createVulnerabilityAudit

  • Creates a new Vulnerability Audit by providing a tree of Application Dependencies. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateVulnerabilityAudit API.

    Parameters

    Returns Promise<CreateVulnerabilityAuditResponse>

    CreateVulnerabilityAuditResponse

createWaiters

deactivateRemediationRecipe

deleteKnowledgeBase

  • Deletes the specified Knowledge Base. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteKnowledgeBase API.

    Parameters

    Returns Promise<DeleteKnowledgeBaseResponse>

    DeleteKnowledgeBaseResponse

deleteRemediationRecipe

  • Deletes the specified Remediation Recipe. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRemediationRecipe API.

    Parameters

    Returns Promise<DeleteRemediationRecipeResponse>

    DeleteRemediationRecipeResponse

deleteRemediationRun

  • Deletes the specified remediation run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRemediationRun API.

    Parameters

    Returns Promise<DeleteRemediationRunResponse>

    DeleteRemediationRunResponse

deleteVulnerabilityAudit

getKnowledgeBase

  • Returns the details of the specified Knowledge Base. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetKnowledgeBase API.

    Parameters

    Returns Promise<GetKnowledgeBaseResponse>

    GetKnowledgeBaseResponse

getRemediationRecipe

  • Returns the details of the specified RemediationRecipe. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRemediationRecipe API.

    Parameters

    Returns Promise<GetRemediationRecipeResponse>

    GetRemediationRecipeResponse

getRemediationRun

  • Returns the details of the specified remediation run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRemediationRun API.

    Parameters

    Returns Promise<GetRemediationRunResponse>

    GetRemediationRunResponse

getStage

  • Returns the details of the specified Remediation Run Stage. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetStage API.

    Parameters

    Returns Promise<GetStageResponse>

    GetStageResponse

getVulnerabilityAudit

  • Returns the details of the specified Vulnerability Audit. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVulnerabilityAudit API.

    Parameters

    Returns Promise<GetVulnerabilityAuditResponse>

    GetVulnerabilityAuditResponse

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listApplicationDependencyRecommendations

listApplicationDependencyVulnerabilities

listKnowledgeBases

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListKnowledgeBases API.

    Parameters

    Returns Promise<ListKnowledgeBasesResponse>

    ListKnowledgeBasesResponse

listRemediationRecipes

  • Returns a list of Remediation Recipes based on the specified query parameters. The query parameters compartmentId or id must be provided.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRemediationRecipes API.

    Parameters

    Returns Promise<ListRemediationRecipesResponse>

    ListRemediationRecipesResponse

listRemediationRuns

  • Returns a list of remediation runs contained by a compartment. The query parameter compartmentId is required unless the query parameter id is specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRemediationRuns API.

    Parameters

    Returns Promise<ListRemediationRunsResponse>

    ListRemediationRunsResponse

listStages

  • Returns a list of Remediation Run Stages based on the specified query parameters and Remediation Run identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListStages API.

    Parameters

    Returns Promise<ListStagesResponse>

    ListStagesResponse

listVulnerabilityAudits

  • Returns a list of Vulnerability Audits based on the specified query parameters. At least one of id, compartmentId query parameter must be provided.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVulnerabilityAudits API.

    Parameters

    Returns Promise<ListVulnerabilityAuditsResponse>

    ListVulnerabilityAuditsResponse

listWorkRequestErrors

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the work requests in a compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateKnowledgeBase

  • Updates one or more attributes of the specified Knowledge Base. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateKnowledgeBase API.

    Parameters

    Returns Promise<UpdateKnowledgeBaseResponse>

    UpdateKnowledgeBaseResponse

updateRemediationRecipe

  • Updates one or more attributes of the specified Remediation Recipe. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateRemediationRecipe API.

    Parameters

    Returns Promise<UpdateRemediationRecipeResponse>

    UpdateRemediationRecipeResponse

updateRemediationRun

  • Updates by identifier one or more attributes of the specified remediation run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateRemediationRun API.

    Parameters

    Returns Promise<UpdateRemediationRunResponse>

    UpdateRemediationRunResponse

updateVulnerabilityAudit

  • Updates one or more attributes of the specified Vulnerability Audit. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateVulnerabilityAudit API.

    Parameters

    Returns Promise<UpdateVulnerabilityAuditResponse>

    UpdateVulnerabilityAuditResponse