Class ListUserAssessmentsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.datasafe.requests.ListUserAssessmentsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListUserAssessmentsRequest,Void>
- Enclosing class:
- ListUserAssessmentsRequest
public static class ListUserAssessmentsRequest.Builder extends Object implements BmcRequest.Builder<ListUserAssessmentsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListUserAssessmentsRequest.Builder
accessLevel(ListUserAssessmentsRequest.AccessLevel accessLevel)
Valid values are RESTRICTED and ACCESSIBLE.ListUserAssessmentsRequest
build()
Build the instance of ListUserAssessmentsRequest as configured by this builderListUserAssessmentsRequest
buildWithoutInvocationCallback()
Build the instance of ListUserAssessmentsRequest as configured by this builderListUserAssessmentsRequest.Builder
compartmentId(String compartmentId)
A filter to return only resources that match the specified compartment OCID.ListUserAssessmentsRequest.Builder
compartmentIdInSubtree(Boolean compartmentIdInSubtree)
Default is false.ListUserAssessmentsRequest.Builder
copy(ListUserAssessmentsRequest o)
Copy method to populate the builder with values from the given instance.ListUserAssessmentsRequest.Builder
displayName(String displayName)
A filter to return only resources that match the specified display name.ListUserAssessmentsRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListUserAssessmentsRequest.Builder
isBaseline(Boolean isBaseline)
A filter to return only user assessments that are set as baseline.ListUserAssessmentsRequest.Builder
isScheduleAssessment(Boolean isScheduleAssessment)
A filter to return only user assessments of type SAVE_SCHEDULE.ListUserAssessmentsRequest.Builder
lifecycleState(UserAssessmentLifecycleState lifecycleState)
The current state of the user assessment.ListUserAssessmentsRequest.Builder
limit(Integer limit)
For list pagination.ListUserAssessmentsRequest.Builder
opcRequestId(String opcRequestId)
Unique identifier for the request.ListUserAssessmentsRequest.Builder
page(String page)
For list pagination.ListUserAssessmentsRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListUserAssessmentsRequest.Builder
scheduleUserAssessmentId(String scheduleUserAssessmentId)
The OCID of the user assessment of type SAVE_SCHEDULE.ListUserAssessmentsRequest.Builder
sortBy(ListUserAssessmentsRequest.SortBy sortBy)
The field to sort by.ListUserAssessmentsRequest.Builder
sortOrder(ListUserAssessmentsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).ListUserAssessmentsRequest.Builder
targetId(String targetId)
A filter to return only items related to a specific target OCID.ListUserAssessmentsRequest.Builder
timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)
A filter to return only user assessments that were created after the specified date and time, as defined by RFC3339.ListUserAssessmentsRequest.Builder
timeCreatedLessThan(Date timeCreatedLessThan)
Search for resources that were created before a specific date.ListUserAssessmentsRequest.Builder
triggeredBy(ListUserAssessmentsRequest.TriggeredBy triggeredBy)
A filter to return user assessments that were created by either the system or by a user only.ListUserAssessmentsRequest.Builder
type(ListUserAssessmentsRequest.Type type)
A filter to return only items that match the specified assessment type.-
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
-
compartmentId
public ListUserAssessmentsRequest.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 ListUserAssessmentsRequest.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 ListUserAssessmentsRequest.Builder accessLevel(ListUserAssessmentsRequest.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
-
displayName
public ListUserAssessmentsRequest.Builder displayName(String displayName)
A filter to return only resources that match the specified display name.- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
scheduleUserAssessmentId
public ListUserAssessmentsRequest.Builder scheduleUserAssessmentId(String scheduleUserAssessmentId)
The OCID of the user assessment of type SAVE_SCHEDULE.- Parameters:
scheduleUserAssessmentId
- the value to set- Returns:
- this builder instance
-
isScheduleAssessment
public ListUserAssessmentsRequest.Builder isScheduleAssessment(Boolean isScheduleAssessment)
A filter to return only user assessments of type SAVE_SCHEDULE.- Parameters:
isScheduleAssessment
- the value to set- Returns:
- this builder instance
-
isBaseline
public ListUserAssessmentsRequest.Builder isBaseline(Boolean isBaseline)
A filter to return only user assessments that are set as baseline.- Parameters:
isBaseline
- the value to set- Returns:
- this builder instance
-
targetId
public ListUserAssessmentsRequest.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
-
type
public ListUserAssessmentsRequest.Builder type(ListUserAssessmentsRequest.Type type)
A filter to return only items that match the specified assessment type.- Parameters:
type
- the value to set- Returns:
- this builder instance
-
triggeredBy
public ListUserAssessmentsRequest.Builder triggeredBy(ListUserAssessmentsRequest.TriggeredBy triggeredBy)
A filter to return user assessments that were created by either the system or by a user only.- Parameters:
triggeredBy
- the value to set- Returns:
- this builder instance
-
timeCreatedGreaterThanOrEqualTo
public ListUserAssessmentsRequest.Builder timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)
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
- Parameters:
timeCreatedGreaterThanOrEqualTo
- the value to set- Returns:
- this builder instance
-
timeCreatedLessThan
public ListUserAssessmentsRequest.Builder timeCreatedLessThan(Date timeCreatedLessThan)
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
- Parameters:
timeCreatedLessThan
- the value to set- Returns:
- this builder instance
-
limit
public ListUserAssessmentsRequest.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 ListUserAssessmentsRequest.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
-
lifecycleState
public ListUserAssessmentsRequest.Builder lifecycleState(UserAssessmentLifecycleState lifecycleState)
The current state of the user assessment.- Parameters:
lifecycleState
- the value to set- Returns:
- this builder instance
-
sortOrder
public ListUserAssessmentsRequest.Builder sortOrder(ListUserAssessmentsRequest.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 ListUserAssessmentsRequest.Builder sortBy(ListUserAssessmentsRequest.SortBy sortBy)
The field to sort by.You can specify only one sort order (sortOrder). The default order for timeCreated is descending.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListUserAssessmentsRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListUserAssessmentsRequest.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 ListUserAssessmentsRequest.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 ListUserAssessmentsRequest.Builder copy(ListUserAssessmentsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListUserAssessmentsRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListUserAssessmentsRequest build()
Build the instance of ListUserAssessmentsRequest 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<ListUserAssessmentsRequest,Void>
- Returns:
- instance of ListUserAssessmentsRequest
-
buildWithoutInvocationCallback
public ListUserAssessmentsRequest buildWithoutInvocationCallback()
Build the instance of ListUserAssessmentsRequest 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 ListUserAssessmentsRequest
-
-