com.oracle.bmc.datasafe.requests

Class ListFindingsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListFindingsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListFindingsRequest,Void>

Enclosing class:

ListFindingsRequest

public static class ListFindingsRequest.Builder
extends Object
implements BmcRequest.Builder<ListFindingsRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListFindingsRequest.Builder	accessLevel(ListFindingsRequest.AccessLevel accessLevel) Valid values are RESTRICTED and ACCESSIBLE.
ListFindingsRequest	build() Build the instance of ListFindingsRequest as configured by this builder
ListFindingsRequest	buildWithoutInvocationCallback() Build the instance of ListFindingsRequest as configured by this builder
ListFindingsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree) Default is false.
ListFindingsRequest.Builder	copy(ListFindingsRequest o) Copy method to populate the builder with values from the given instance.
ListFindingsRequest.Builder	findingKey(String findingKey) Each finding in security assessment has an associated key (think of key as a finding’s name).
ListFindingsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListFindingsRequest.Builder	isTopFinding(Boolean isTopFinding) A filter to return only the findings that are marked as top findings.
ListFindingsRequest.Builder	lifecycleState(FindingLifecycleState lifecycleState) A filter to return only the findings that match the specified lifecycle states.
ListFindingsRequest.Builder	limit(Integer limit) For list pagination.
ListFindingsRequest.Builder	opcRequestId(String opcRequestId) Unique identifier for the request.
ListFindingsRequest.Builder	page(String page) For list pagination.
ListFindingsRequest.Builder	references(SecurityAssessmentReferences references) An optional filter to return only findings that match the specified reference.
ListFindingsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListFindingsRequest.Builder	securityAssessmentId(String securityAssessmentId) The OCID of the security assessment.
ListFindingsRequest.Builder	severity(ListFindingsRequest.Severity severity) A filter to return only findings of a particular risk level.
ListFindingsRequest.Builder	targetId(String targetId) A filter to return only items related to a specific target OCID.

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.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

securityAssessmentId

public ListFindingsRequest.Builder securityAssessmentId(String securityAssessmentId)

The OCID of the security assessment.

Parameters:

securityAssessmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListFindingsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

isTopFinding

public ListFindingsRequest.Builder isTopFinding(Boolean isTopFinding)

A filter to return only the findings that are marked as top findings.

Parameters:

isTopFinding - the value to set

Returns:

this builder instance

severity

public ListFindingsRequest.Builder severity(ListFindingsRequest.Severity severity)

A filter to return only findings of a particular risk level.

Parameters:

severity - the value to set

Returns:

this builder instance

lifecycleState

public ListFindingsRequest.Builder lifecycleState(FindingLifecycleState lifecycleState)

A filter to return only the findings that match the specified lifecycle states.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

references

public ListFindingsRequest.Builder references(SecurityAssessmentReferences references)

An optional filter to return only findings that match the specified reference.

Parameters:

references - the value to set

Returns:

this builder instance

limit

public ListFindingsRequest.Builder limit(Integer limit)

For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListFindingsRequest.Builder page(String page)

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListFindingsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

accessLevel

public ListFindingsRequest.Builder accessLevel(ListFindingsRequest.AccessLevel accessLevel)

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

Parameters:

accessLevel - the value to set

Returns:

this builder instance

targetId

public ListFindingsRequest.Builder targetId(String targetId)

A filter to return only items related to a specific target OCID.

Parameters:

targetId - the value to set

Returns:

this builder instance

findingKey

public ListFindingsRequest.Builder findingKey(String findingKey)

Each finding in security assessment has an associated key (think of key as a finding’s name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings.

Parameters:

findingKey - the value to set

Returns:

this builder instance

invocationCallback

public ListFindingsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListFindingsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListFindingsRequest.Builder copy(ListFindingsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListFindingsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListFindingsRequest build()

Build the instance of ListFindingsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListFindingsRequest,Void>

Returns:

instance of ListFindingsRequest

buildWithoutInvocationCallback

public ListFindingsRequest buildWithoutInvocationCallback()

Build the instance of ListFindingsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListFindingsRequest