Class ListChecksRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListChecksRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListChecksRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datasafe/ListChecksExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListChecksRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListChecksRequest.AccessLevelValid values are RESTRICTED and ACCESSIBLE.static classListChecksRequest.Builderstatic classListChecksRequest.ContainsSeverityA filter to return only findings that match the specified risk level(s).static classListChecksRequest.SortByThe field to sort by.static classListChecksRequest.SortOrderThe sort order to use, either ascending (ASC) or descending (DESC).static classListChecksRequest.SuggestedSeverityA filter to return only checks of a particular risk level.
-
Constructor Summary
Constructors Constructor Description ListChecksRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListChecksRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.ListChecksRequest.AccessLevelgetAccessLevel()Valid values are RESTRICTED and ACCESSIBLE.BooleangetCompartmentIdInSubtree()Default is false.List<SecurityAssessmentReferences>getContainsReferences()An optional filter to return only findings that match the specified references.List<ListChecksRequest.ContainsSeverity>getContainsSeverity()A filter to return only findings that match the specified risk level(s).StringgetKey()Each check in security assessment has an associated key (think of key as a check’s name).IntegergetLimit()For list pagination.StringgetOpcRequestId()Unique identifier for the request.StringgetPage()For list pagination.StringgetSecurityAssessmentId()The OCID of the security assessment.ListChecksRequest.SortBygetSortBy()The field to sort by.ListChecksRequest.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).ListChecksRequest.SuggestedSeveritygetSuggestedSeverity()A filter to return only checks of a particular risk level.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListChecksRequest.BuildertoBuilder()Return an instance ofListChecksRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getSecurityAssessmentId
public String getSecurityAssessmentId()
The OCID of the security assessment.
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
getLimit
public Integer getLimit()
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.
-
getPage
public String getPage()
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.
-
getSortOrder
public ListChecksRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListChecksRequest.SortBy getSortBy()
The field to sort by.You can specify only one sort order(sortOrder). The default order for title is ascending.
-
getSuggestedSeverity
public ListChecksRequest.SuggestedSeverity getSuggestedSeverity()
A filter to return only checks of a particular risk level.
-
getContainsSeverity
public List<ListChecksRequest.ContainsSeverity> getContainsSeverity()
A filter to return only findings that match the specified risk level(s).Use containsSeverity parameter if need to filter by multiple risk levels.
-
getContainsReferences
public List<SecurityAssessmentReferences> getContainsReferences()
An optional filter to return only findings that match the specified references.Use containsReferences param if need to filter by multiple references.
-
getCompartmentIdInSubtree
public Boolean getCompartmentIdInSubtree()
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.
-
getAccessLevel
public ListChecksRequest.AccessLevel getAccessLevel()
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.
-
getKey
public String getKey()
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.
-
toBuilder
public ListChecksRequest.Builder toBuilder()
Return an instance ofListChecksRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListChecksRequest.Builderthat allows you to modify request properties.
-
builder
public static ListChecksRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request object
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-