Package com.oracle.bmc.datasafe.requests

Class ListFindingAnalyticsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListFindingAnalyticsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListFindingAnalyticsRequest,Void>

Enclosing class:

ListFindingAnalyticsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListFindingAnalyticsRequest.Builder	accessLevel(ListFindingAnalyticsRequest.AccessLevel accessLevel)	Valid values are RESTRICTED and ACCESSIBLE.
ListFindingAnalyticsRequest	build()	Build the instance of ListFindingAnalyticsRequest as configured by this builder
ListFindingAnalyticsRequest	buildWithoutInvocationCallback()	Build the instance of ListFindingAnalyticsRequest as configured by this builder
ListFindingAnalyticsRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that match the specified compartment OCID.
ListFindingAnalyticsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree)	Default is false.
ListFindingAnalyticsRequest.Builder	copy(ListFindingAnalyticsRequest o)	Copy method to populate the builder with values from the given instance.
ListFindingAnalyticsRequest.Builder	findingKey(String findingKey)	The unique key that identifies the finding.
ListFindingAnalyticsRequest.Builder	groupBy(ListFindingAnalyticsRequest.GroupBy groupBy)	Attribute by which the finding analytics data should be grouped.
ListFindingAnalyticsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListFindingAnalyticsRequest.Builder	isTopFinding(Boolean isTopFinding)	A filter to return only the findings that are marked as top findings.
ListFindingAnalyticsRequest.Builder	limit(Integer limit)	For list pagination.
ListFindingAnalyticsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListFindingAnalyticsRequest.Builder	page(String page)	For list pagination.
ListFindingAnalyticsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListFindingAnalyticsRequest.Builder	severity(ListFindingAnalyticsRequest.Severity severity)	A filter to return only findings of a particular risk level.
ListFindingAnalyticsRequest.Builder	topFindingStatus(FindingAnalyticsDimensions.TopFindingStatus topFindingStatus)	An optional filter to return only the top finding that match the specified status.

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

compartmentId

public ListFindingAnalyticsRequest.Builder compartmentId(String compartmentId)

A filter to return only resources that match the specified compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListFindingAnalyticsRequest.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 ListFindingAnalyticsRequest.Builder accessLevel(ListFindingAnalyticsRequest.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

isTopFinding

public ListFindingAnalyticsRequest.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

groupBy

public ListFindingAnalyticsRequest.Builder groupBy(ListFindingAnalyticsRequest.GroupBy groupBy)

Attribute by which the finding analytics data should be grouped.

Parameters:

groupBy - the value to set

Returns:

this builder instance

topFindingStatus

public ListFindingAnalyticsRequest.Builder topFindingStatus(FindingAnalyticsDimensions.TopFindingStatus topFindingStatus)

An optional filter to return only the top finding that match the specified status.

Parameters:

topFindingStatus - the value to set

Returns:

this builder instance

severity

public ListFindingAnalyticsRequest.Builder severity(ListFindingAnalyticsRequest.Severity severity)

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

Parameters:

severity - the value to set

Returns:

this builder instance

findingKey

public ListFindingAnalyticsRequest.Builder findingKey(String findingKey)

The unique key that identifies the finding.

It is a string and unique within a security assessment.

Parameters:

findingKey - the value to set

Returns:

this builder instance

opcRequestId

public ListFindingAnalyticsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

limit

public ListFindingAnalyticsRequest.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 ListFindingAnalyticsRequest.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

invocationCallback

public ListFindingAnalyticsRequest.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 ListFindingAnalyticsRequest.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 ListFindingAnalyticsRequest.Builder copy(ListFindingAnalyticsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListFindingAnalyticsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListFindingAnalyticsRequest build()

Build the instance of ListFindingAnalyticsRequest 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<ListFindingAnalyticsRequest,Void>

Returns:

instance of ListFindingAnalyticsRequest

buildWithoutInvocationCallback

public ListFindingAnalyticsRequest buildWithoutInvocationCallback()

Build the instance of ListFindingAnalyticsRequest 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 ListFindingAnalyticsRequest