Class ListChecksRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.datasafe.requests.ListChecksRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListChecksRequest,Void>
- Enclosing class:
- ListChecksRequest
public static class ListChecksRequest.Builder extends Object implements BmcRequest.Builder<ListChecksRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListChecksRequest.Builder
accessLevel(ListChecksRequest.AccessLevel accessLevel)
Valid values are RESTRICTED and ACCESSIBLE.ListChecksRequest
build()
Build the instance of ListChecksRequest as configured by this builderListChecksRequest
buildWithoutInvocationCallback()
Build the instance of ListChecksRequest as configured by this builderListChecksRequest.Builder
compartmentIdInSubtree(Boolean compartmentIdInSubtree)
Default is false.ListChecksRequest.Builder
containsReferences(SecurityAssessmentReferences singularValue)
Singular setter.ListChecksRequest.Builder
containsReferences(List<SecurityAssessmentReferences> containsReferences)
An optional filter to return only findings that match the specified references.ListChecksRequest.Builder
containsSeverity(ListChecksRequest.ContainsSeverity singularValue)
Singular setter.ListChecksRequest.Builder
containsSeverity(List<ListChecksRequest.ContainsSeverity> containsSeverity)
A filter to return only findings that match the specified risk level(s).ListChecksRequest.Builder
copy(ListChecksRequest o)
Copy method to populate the builder with values from the given instance.ListChecksRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListChecksRequest.Builder
key(String key)
Each check in security assessment has an associated key (think of key as a check’s name).ListChecksRequest.Builder
limit(Integer limit)
For list pagination.ListChecksRequest.Builder
opcRequestId(String opcRequestId)
Unique identifier for the request.ListChecksRequest.Builder
page(String page)
For list pagination.ListChecksRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListChecksRequest.Builder
securityAssessmentId(String securityAssessmentId)
The OCID of the security assessment.ListChecksRequest.Builder
sortBy(ListChecksRequest.SortBy sortBy)
The field to sort by.ListChecksRequest.Builder
sortOrder(ListChecksRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).ListChecksRequest.Builder
suggestedSeverity(ListChecksRequest.SuggestedSeverity suggestedSeverity)
A filter to return only checks of a particular risk level.-
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$
-
-
-
-
Method Detail
-
securityAssessmentId
public ListChecksRequest.Builder securityAssessmentId(String securityAssessmentId)
The OCID of the security assessment.- Parameters:
securityAssessmentId
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListChecksRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
limit
public ListChecksRequest.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 ListChecksRequest.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
-
sortOrder
public ListChecksRequest.Builder sortOrder(ListChecksRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
sortBy
public ListChecksRequest.Builder sortBy(ListChecksRequest.SortBy sortBy)
The field to sort by.You can specify only one sort order(sortOrder). The default order for title is ascending.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
suggestedSeverity
public ListChecksRequest.Builder suggestedSeverity(ListChecksRequest.SuggestedSeverity suggestedSeverity)
A filter to return only checks of a particular risk level.- Parameters:
suggestedSeverity
- the value to set- Returns:
- this builder instance
-
containsSeverity
public ListChecksRequest.Builder containsSeverity(List<ListChecksRequest.ContainsSeverity> containsSeverity)
A filter to return only findings that match the specified risk level(s).Use containsSeverity parameter if need to filter by multiple risk levels.
- Parameters:
containsSeverity
- the value to set- Returns:
- this builder instance
-
containsSeverity
public ListChecksRequest.Builder containsSeverity(ListChecksRequest.ContainsSeverity singularValue)
Singular setter.A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels.
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
containsReferences
public ListChecksRequest.Builder containsReferences(List<SecurityAssessmentReferences> containsReferences)
An optional filter to return only findings that match the specified references.Use containsReferences param if need to filter by multiple references.
- Parameters:
containsReferences
- the value to set- Returns:
- this builder instance
-
containsReferences
public ListChecksRequest.Builder containsReferences(SecurityAssessmentReferences singularValue)
Singular setter.An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references.
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
compartmentIdInSubtree
public ListChecksRequest.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 ListChecksRequest.Builder accessLevel(ListChecksRequest.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
-
key
public ListChecksRequest.Builder key(String key)
Each check in security assessment has an associated key (think of key as a check’s name).For a given check, the key will be the same across targets. The user can use these keys to filter the checks.
- Parameters:
key
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListChecksRequest.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 ListChecksRequest.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 ListChecksRequest.Builder copy(ListChecksRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListChecksRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListChecksRequest build()
Build the instance of ListChecksRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<ListChecksRequest,Void>
- Returns:
- instance of ListChecksRequest
-
buildWithoutInvocationCallback
public ListChecksRequest buildWithoutInvocationCallback()
Build the instance of ListChecksRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of ListChecksRequest
-
-