com.oracle.bmc.vulnerabilityscanning.VulnerabilityScanning Maven / Gradle / Ivy
Show all versions of oci-java-sdk-vulnerabilityscanning Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.vulnerabilityscanning;
import com.oracle.bmc.vulnerabilityscanning.requests.*;
import com.oracle.bmc.vulnerabilityscanning.responses.*;
/**
* Use the Vulnerability Scanning Service (VSS) API to manage scan recipes, targets, and reports.
* For more information, see [the Vulnerability Scanning
* documentation](https://docs.cloud.oracle.com/iaas/scanning/home.htm). This service client uses
* CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit
* breaker configuration is defined by the user.
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20210215")
public interface VulnerabilityScanning extends AutoCloseable {
/** Rebuilds the client from scratch. Useful to refresh certificates. */
void refreshClient();
/**
* Sets the endpoint to call (ex, https://www.example.com).
*
* @param endpoint The endpoint of the service.
*/
void setEndpoint(String endpoint);
/** Gets the set endpoint for REST call (ex, https://www.example.com) */
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
* Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the
* endpoint. If the service is not available in this Region, however, an
* IllegalArgumentException will be raised.
*
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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 {@link
* #setRegion(Region) setRegion}.
*
*
If no known Region could be determined, it will create an endpoint based on the default
* endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
*
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* 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"
*
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint
* template
*/
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled);
/**
* Moves a ContainerScanRecipe into a different compartment. When provided, If-Match is checked
* against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeContainerScanRecipeCompartment API.
*/
ChangeContainerScanRecipeCompartmentResponse changeContainerScanRecipeCompartment(
ChangeContainerScanRecipeCompartmentRequest request);
/**
* Moves a ContainerScanResult into a different compartment. When provided, If-Match is checked
* against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeContainerScanResultCompartment API.
*/
ChangeContainerScanResultCompartmentResponse changeContainerScanResultCompartment(
ChangeContainerScanResultCompartmentRequest request);
/**
* Moves a ContainerScanTarget into a different compartment. When provided, If-Match is checked
* against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeContainerScanTargetCompartment API.
*/
ChangeContainerScanTargetCompartmentResponse changeContainerScanTargetCompartment(
ChangeContainerScanTargetCompartmentRequest request);
/**
* Moves a HostAgentScanResult into a different compartment. When provided, If-Match is checked
* against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeHostAgentScanResultCompartment API.
*/
ChangeHostAgentScanResultCompartmentResponse changeHostAgentScanResultCompartment(
ChangeHostAgentScanResultCompartmentRequest request);
/**
* Moves a HostCisBenchmarkScanResult into a different compartment. When provided, If-Match is
* checked against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeHostCisBenchmarkScanResultCompartment API.
*/
ChangeHostCisBenchmarkScanResultCompartmentResponse changeHostCisBenchmarkScanResultCompartment(
ChangeHostCisBenchmarkScanResultCompartmentRequest request);
/**
* Moves a HostEndpointProtectionScanResult into a different compartment. When provided,
* If-Match is checked against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeHostEndpointProtectionScanResultCompartment API.
*/
ChangeHostEndpointProtectionScanResultCompartmentResponse
changeHostEndpointProtectionScanResultCompartment(
ChangeHostEndpointProtectionScanResultCompartmentRequest request);
/**
* Moves a HostPortScanResult into a different compartment. When provided, If-Match is checked
* against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeHostPortScanResultCompartment API.
*/
ChangeHostPortScanResultCompartmentResponse changeHostPortScanResultCompartment(
ChangeHostPortScanResultCompartmentRequest request);
/**
* Moves a HostScanRecipe into a different compartment. When provided, If-Match is checked
* against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeHostScanRecipeCompartment API.
*/
ChangeHostScanRecipeCompartmentResponse changeHostScanRecipeCompartment(
ChangeHostScanRecipeCompartmentRequest request);
/**
* Moves a HostScanTarget into a different compartment. When provided, If-Match is checked
* against ETag values of the resource.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ChangeHostScanTargetCompartment API.
*/
ChangeHostScanTargetCompartmentResponse changeHostScanTargetCompartment(
ChangeHostScanTargetCompartmentRequest request);
/**
* Creates a new ContainerScanRecipe. A recipe determines the types of security issues that you
* want scanned.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* CreateContainerScanRecipe API.
*/
CreateContainerScanRecipeResponse createContainerScanRecipe(
CreateContainerScanRecipeRequest request);
/**
* Creates a new ContainerScanTarget. A container scan target specifies a group of one or more
* Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR) that you want
* routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* CreateContainerScanTarget API.
*/
CreateContainerScanTargetResponse createContainerScanTarget(
CreateContainerScanTargetRequest request);
/**
* Creates a new HostScanRecipe. A recipe determines the types of security issues that you want
* scanned, and how often to scan.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* CreateHostScanRecipe API.
*/
CreateHostScanRecipeResponse createHostScanRecipe(CreateHostScanRecipeRequest request);
/**
* Creates a new HostScanTarget. A host scan target is a collection of compute instances that
* you want routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* CreateHostScanTarget API.
*/
CreateHostScanTargetResponse createHostScanTarget(CreateHostScanTargetRequest request);
/**
* Deletes the ContainerScanRecipe identified by the recipe ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteContainerScanRecipe API.
*/
DeleteContainerScanRecipeResponse deleteContainerScanRecipe(
DeleteContainerScanRecipeRequest request);
/**
* Deletes the ContainerScanResult identified by the container scan ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteContainerScanResult API.
*/
DeleteContainerScanResultResponse deleteContainerScanResult(
DeleteContainerScanResultRequest request);
/**
* Deletes the ContainerScanTarget identified by the target ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteContainerScanTarget API.
*/
DeleteContainerScanTargetResponse deleteContainerScanTarget(
DeleteContainerScanTargetRequest request);
/**
* Deletes the HostAgentScanResult identified by the host agent scan ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteHostAgentScanResult API.
*/
DeleteHostAgentScanResultResponse deleteHostAgentScanResult(
DeleteHostAgentScanResultRequest request);
/**
* Deletes the HostCisBenchmarkScanResult identified by the benchmark scan result ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteHostCisBenchmarkScanResult API.
*/
DeleteHostCisBenchmarkScanResultResponse deleteHostCisBenchmarkScanResult(
DeleteHostCisBenchmarkScanResultRequest request);
/**
* Deletes the HostEndpointProtectionScanResult identified by the id
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteHostEndpointProtectionScanResult API.
*/
DeleteHostEndpointProtectionScanResultResponse deleteHostEndpointProtectionScanResult(
DeleteHostEndpointProtectionScanResultRequest request);
/**
* Deletes the HostPortScanResult identified by the host port scan ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteHostPortScanResult API.
*/
DeleteHostPortScanResultResponse deleteHostPortScanResult(
DeleteHostPortScanResultRequest request);
/**
* Deletes the HostScanRecipe identified by the recipe ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteHostScanRecipe API.
*/
DeleteHostScanRecipeResponse deleteHostScanRecipe(DeleteHostScanRecipeRequest request);
/**
* Deletes the HostScanTarget identified by the target ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteHostScanTarget API.
*/
DeleteHostScanTargetResponse deleteHostScanTarget(DeleteHostScanTargetRequest request);
/**
* Exports a list of HostAgentScanResultSummary objects within a compartment and during a
* specified time range in CSV format. You can filter the results by problem severity.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ExportHostAgentScanResultCsv API.
*/
ExportHostAgentScanResultCsvResponse exportHostAgentScanResultCsv(
ExportHostAgentScanResultCsvRequest request);
/**
* Exports a list of HostVulnerabilitySummary objects in a compartment in CSV format.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ExportHostVulnerabilityCsv API.
*/
ExportHostVulnerabilityCsvResponse exportHostVulnerabilityCsv(
ExportHostVulnerabilityCsvRequest request);
/**
* Retrieves a ContainerScanRecipe identified by the recipe ID. A recipe determines the types of
* security issues that you want scanned.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetContainerScanRecipe API.
*/
GetContainerScanRecipeResponse getContainerScanRecipe(GetContainerScanRecipeRequest request);
/**
* Retrieves a ContainerScanResult identified by the container scan ID. The result includes a
* list of problems found in a specific image in a Docker repository.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetContainerScanResult API.
*/
GetContainerScanResultResponse getContainerScanResult(GetContainerScanResultRequest request);
/**
* Gets a ContainerScanTarget identified by the target ID. A container scan target specifies a
* group of one or more Docker image repositories in Oracle Cloud Infrastructure Registry (OCIR)
* that you want routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetContainerScanTarget API.
*/
GetContainerScanTargetResponse getContainerScanTarget(GetContainerScanTargetRequest request);
/**
* Retrieves a HostAgentScanResult identified by the host agent scan ID. The result includes a
* list of CVEs detected in a specific compute instance.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetHostAgentScanResult API.
*/
GetHostAgentScanResultResponse getHostAgentScanResult(GetHostAgentScanResultRequest request);
/**
* Retrieves a HostCisBenchmarkScanResult identified by the benchmark scan result ID. A CIS
* (Center for Internet Security) benchmark scan result includes a list of benchmarks that were
* tested on a specific compute instance, and whether each test passed or failed.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetHostCisBenchmarkScanResult API.
*/
GetHostCisBenchmarkScanResultResponse getHostCisBenchmarkScanResult(
GetHostCisBenchmarkScanResultRequest request);
/**
* Returns HostEndpointProtectionScanResults for the given host endpoint protection scan result
* ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetHostEndpointProtectionScanResult API.
*/
GetHostEndpointProtectionScanResultResponse getHostEndpointProtectionScanResult(
GetHostEndpointProtectionScanResultRequest request);
/**
* Retrieves a HostPortScanResult identified by the host port scan ID. The result includes a
* list of open ports that were detected in a specific compute instance.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetHostPortScanResult API.
*/
GetHostPortScanResultResponse getHostPortScanResult(GetHostPortScanResultRequest request);
/**
* Retrieves a HostScanRecipe identified by the recipe ID. A recipe determines the types of
* security issues that you want scanned, and how often to scan.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use GetHostScanRecipe
* API.
*/
GetHostScanRecipeResponse getHostScanRecipe(GetHostScanRecipeRequest request);
/**
* Retrieves a HostScanTarget identified by the target ID. A host scan target is a collection of
* compute instances that you want routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use GetHostScanTarget
* API.
*/
GetHostScanTargetResponse getHostScanTarget(GetHostScanTargetRequest request);
/**
* Retrieves a HostVulnerability identified by the host vulnerability ID. A host vulnerability
* describes a security issue that was detected in scans of one or more compute instances.
* Common Vulnerabilities and Exposures (CVE) numbers identify security vulnerabilities for
* operating systems and other software, including Critical Patch Updates and Security Alert
* advisories.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetHostVulnerability API.
*/
GetHostVulnerabilityResponse getHostVulnerability(GetHostVulnerabilityRequest request);
/**
* Retrieves a Vulnerability identified by the vulnerability ID. A vulnerability describes a
* security issue that was detected in scans of one or more compute instances, container scan
* repositories. Common Vulnerabilities and Exposures (CVE) numbers identify security
* vulnerabilities for operating systems and other software, including Critical Patch Updates
* and Security Alert advisories.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use GetVulnerability
* API.
*/
GetVulnerabilityResponse getVulnerability(GetVulnerabilityRequest request);
/**
* Gets the status of the work request with the given ID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use GetWorkRequest API.
*/
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request);
/**
* Retrieves a list of ContainerScanRecipeSummary objects in a compartment. A recipe determines
* the types of security issues that you want scanned.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListContainerScanRecipes API.
*/
ListContainerScanRecipesResponse listContainerScanRecipes(
ListContainerScanRecipesRequest request);
/**
* Retrieves a list of ContainerScanResultSummary objects in a compartment. You can filter and
* sort the results by problem severity and time. A container scan result includes a list of
* problems detected in a specific image in a Docker repository.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListContainerScanResults API.
*/
ListContainerScanResultsResponse listContainerScanResults(
ListContainerScanResultsRequest request);
/**
* Retrieves a list of ContainerScanTargetSummary objects in a compartment. A container scan
* target specifies a group of one or more Docker image repositories in Oracle Cloud
* Infrastructure Registry (OCIR) that you want routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListContainerScanTargets API.
*/
ListContainerScanTargetsResponse listContainerScanTargets(
ListContainerScanTargetsRequest request);
/**
* Retrieves a list of HostAgentScanResultSummary objects in a compartment. You can filter and
* sort the results by problem severity and time. An agent scan result includes a list of CVEs
* detected in a specific compute instance.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListHostAgentScanResults API.
*/
ListHostAgentScanResultsResponse listHostAgentScanResults(
ListHostAgentScanResultsRequest request);
/**
* Retrieves a list of HostCisBenchmarkScanResultSummary objects in a compartment. You can
* filter and sort the results by problem severity and time. A CIS (Center for Internet
* Security) benchmark scan result includes the number of failed benchmark tests on a specific
* compute instance.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListHostCisBenchmarkScanResults API.
*/
ListHostCisBenchmarkScanResultsResponse listHostCisBenchmarkScanResults(
ListHostCisBenchmarkScanResultsRequest request);
/**
* Returns a collection of HostEndpointProtectionScanResultSummary objects
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListHostEndpointProtectionScanResults API.
*/
ListHostEndpointProtectionScanResultsResponse listHostEndpointProtectionScanResults(
ListHostEndpointProtectionScanResultsRequest request);
/**
* Retrieves a list of HostPortScanResultSummary objects in a compartment. You can filter and
* sort the results by problem severity and time. A port scan result includes a list of open
* ports that were detected in a specific compute instance.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListHostPortScanResults API.
*/
ListHostPortScanResultsResponse listHostPortScanResults(ListHostPortScanResultsRequest request);
/**
* Retrieves a list of HostScanRecipeSummary objects in a compartment. A recipe determines the
* types of security issues that you want scanned, and how often to scan.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use ListHostScanRecipes
* API.
*/
ListHostScanRecipesResponse listHostScanRecipes(ListHostScanRecipesRequest request);
/**
* Retrieves list of errors during scanning on instances associated with HostScanTarget
* identified by the target ID. A host scan target is a collection of compute instances that you
* want routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListHostScanTargetErrors API.
*/
ListHostScanTargetErrorsResponse listHostScanTargetErrors(
ListHostScanTargetErrorsRequest request);
/**
* Retrieves a list of HostScanTargetSummary objects in a compartment. A host scan target is a
* collection of compute instances that you want routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use ListHostScanTargets
* API.
*/
ListHostScanTargetsResponse listHostScanTargets(ListHostScanTargetsRequest request);
/**
* Retrieves a list of HostVulnerabilitySummary objects in a compartment. You can filter and
* sort the vulnerabilities by problem severity and time. A host vulnerability describes a
* security issue that was detected in scans of one or more compute instances.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListHostVulnerabilities API.
*/
ListHostVulnerabilitiesResponse listHostVulnerabilities(ListHostVulnerabilitiesRequest request);
/**
* Retrieves a list of HostVulnerabilityImpactedHostSummary objects for a specific host
* vulnerability ID. An impacted host summary identifies a compute instance on which the
* specified vulnerability was detected.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListHostVulnerabilityImpactedHosts API.
*/
ListHostVulnerabilityImpactedHostsResponse listHostVulnerabilityImpactedHosts(
ListHostVulnerabilityImpactedHostsRequest request);
/**
* Retrieves a list of VulnerabilitySummary objects in a compartment. You can filter and sort
* the vulnerabilities by problem severity and time and type. A vulnerability describes a
* security issue that was detected in scans of one or more compute instances, container images.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use ListVulnerabilities
* API.
*/
ListVulnerabilitiesResponse listVulnerabilities(ListVulnerabilitiesRequest request);
/**
* Retrieves a list of VulnerabilityImpactedContainerSummary objects for a specific
* vulnerability ID. An impacted container image summary identifies container images on which
* the specified vulnerability was detected.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListVulnerabilityImpactedContainers API.
*/
ListVulnerabilityImpactedContainersResponse listVulnerabilityImpactedContainers(
ListVulnerabilityImpactedContainersRequest request);
/**
* Retrieves a list of VulnerabilityImpactedHostSummary objects for a specific host
* vulnerability ID. An impacted host summary identifies a compute instance on which the
* specified vulnerability was detected.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListVulnerabilityImpactedHosts API.
*/
ListVulnerabilityImpactedHostsResponse listVulnerabilityImpactedHosts(
ListVulnerabilityImpactedHostsRequest request);
/**
* Return a (paginated) list of errors for a given work request.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListWorkRequestErrors API.
*/
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request);
/**
* Return a (paginated) list of logs for a given work request.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use ListWorkRequestLogs
* API.
*/
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request);
/**
* Lists the work requests in a compartment.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use ListWorkRequests
* API.
*/
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request);
/**
* Updates the ContainerScanRecipe identified by the recipe ID. A recipe determines the types of
* security issues that you want scanned.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* UpdateContainerScanRecipe API.
*/
UpdateContainerScanRecipeResponse updateContainerScanRecipe(
UpdateContainerScanRecipeRequest request);
/**
* Updates the ContainerScanTarget identified by the target ID. A container scan target
* specifies a group of one or more Docker image repositories in Oracle Cloud Infrastructure
* Registry (OCIR) that you want routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* UpdateContainerScanTarget API.
*/
UpdateContainerScanTargetResponse updateContainerScanTarget(
UpdateContainerScanTargetRequest request);
/**
* Updates the HostScanRecipe identified by the recipe ID. A recipe determines the types of
* security issues that you want scanned, and how often to scan.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* UpdateHostScanRecipe API.
*/
UpdateHostScanRecipeResponse updateHostScanRecipe(UpdateHostScanRecipeRequest request);
/**
* Updates the HostScanTarget identified by the target ID. A host scan target is a collection of
* compute instances that you want routinely scanned for security vulnerabilities.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* UpdateHostScanTarget API.
*/
UpdateHostScanTargetResponse updateHostScanTarget(UpdateHostScanTargetRequest request);
/**
* Gets the pre-configured waiters available for resources for this service.
*
* @return The service waiters.
*/
VulnerabilityScanningWaiters getWaiters();
/**
* Gets the pre-configured paginators available for list operations in this service which may
* return multiple pages of data. These paginators provide an {@link java.lang.Iterable}
* interface so that service responses, or resources/records, can be iterated through without
* having to manually deal with pagination and page tokens.
*
* @return The service paginators.
*/
VulnerabilityScanningPaginators getPaginators();
}