Class ListUserAssessmentsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListUserAssessmentsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListUserAssessmentsRequest extends BmcRequest<Void>
Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/datasafe/ListUserAssessmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUserAssessmentsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListUserAssessmentsRequest.AccessLevel
Valid values are RESTRICTED and ACCESSIBLE.static class
ListUserAssessmentsRequest.Builder
static class
ListUserAssessmentsRequest.SortBy
The field to sort by.static class
ListUserAssessmentsRequest.SortOrder
The sort order to use, either ascending (ASC) or descending (DESC).static class
ListUserAssessmentsRequest.TriggeredBy
A filter to return user assessments that were created by either the system or by a user only.static class
ListUserAssessmentsRequest.Type
A filter to return only items that match the specified assessment type.
-
Constructor Summary
Constructors Constructor Description ListUserAssessmentsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListUserAssessmentsRequest.Builder
builder()
Return a new builder for this request object.boolean
equals(Object o)
Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.ListUserAssessmentsRequest.AccessLevel
getAccessLevel()
Valid values are RESTRICTED and ACCESSIBLE.String
getCompartmentId()
A filter to return only resources that match the specified compartment OCID.Boolean
getCompartmentIdInSubtree()
Default is false.String
getDisplayName()
A filter to return only resources that match the specified display name.Boolean
getIsBaseline()
A filter to return only user assessments that are set as baseline.Boolean
getIsScheduleAssessment()
A filter to return only user assessments of type SAVE_SCHEDULE.UserAssessmentLifecycleState
getLifecycleState()
The current state of the user assessment.Integer
getLimit()
For list pagination.String
getOpcRequestId()
Unique identifier for the request.String
getPage()
For list pagination.String
getScheduleUserAssessmentId()
The OCID of the user assessment of type SAVE_SCHEDULE.ListUserAssessmentsRequest.SortBy
getSortBy()
The field to sort by.ListUserAssessmentsRequest.SortOrder
getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).String
getTargetId()
A filter to return only items related to a specific target OCID.Date
getTimeCreatedGreaterThanOrEqualTo()
A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339.Date
getTimeCreatedLessThan()
Search for resources that were created before a specific date.ListUserAssessmentsRequest.TriggeredBy
getTriggeredBy()
A filter to return user assessments that were created by either the system or by a user only.ListUserAssessmentsRequest.Type
getType()
A filter to return only items that match the specified assessment type.int
hashCode()
Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListUserAssessmentsRequest.Builder
toBuilder()
Return an instance ofListUserAssessmentsRequest.Builder
that allows you to modify request properties.String
toString()
-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getCompartmentId
public String getCompartmentId()
A filter to return only resources that match the specified compartment OCID.
-
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 ListUserAssessmentsRequest.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.
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the specified display name.
-
getScheduleUserAssessmentId
public String getScheduleUserAssessmentId()
The OCID of the user assessment of type SAVE_SCHEDULE.
-
getIsScheduleAssessment
public Boolean getIsScheduleAssessment()
A filter to return only user assessments of type SAVE_SCHEDULE.
-
getIsBaseline
public Boolean getIsBaseline()
A filter to return only user assessments that are set as baseline.
-
getTargetId
public String getTargetId()
A filter to return only items related to a specific target OCID.
-
getType
public ListUserAssessmentsRequest.Type getType()
A filter to return only items that match the specified assessment type.
-
getTriggeredBy
public ListUserAssessmentsRequest.TriggeredBy getTriggeredBy()
A filter to return user assessments that were created by either the system or by a user only.
-
getTimeCreatedGreaterThanOrEqualTo
public Date getTimeCreatedGreaterThanOrEqualTo()
A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339.Using timeCreatedGreaterThanOrEqualTo parameter retrieves all assessments created after that date.
*Example:** 2016-12-19T16:39:57.600Z
-
getTimeCreatedLessThan
public Date getTimeCreatedLessThan()
Search for resources that were created before a specific date.Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.
*Example:** 2016-12-19T16:39:57.600Z
-
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.
-
getLifecycleState
public UserAssessmentLifecycleState getLifecycleState()
The current state of the user assessment.
-
getSortOrder
public ListUserAssessmentsRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListUserAssessmentsRequest.SortBy getSortBy()
The field to sort by.You can specify only one sort order (sortOrder). The default order for timeCreated is descending.
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
toBuilder
public ListUserAssessmentsRequest.Builder toBuilder()
Return an instance ofListUserAssessmentsRequest.Builder
that allows you to modify request properties.- Returns:
- instance of
ListUserAssessmentsRequest.Builder
that allows you to modify request properties.
-
builder
public static ListUserAssessmentsRequest.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:BmcRequest
Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equals
in classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequest
Uses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCode
in classBmcRequest<Void>
-
-