ListUserAnalyticsRequest (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.requests.BmcRequest<Void>
- - com.oracle.bmc.datasafe.requests.ListUserAnalyticsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public class ListUserAnalyticsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListUserAnalyticsRequest.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListUserAnalyticsRequest.AccessLevel` Valid values are RESTRICTED and ACCESSIBLE.
`static class`	`ListUserAnalyticsRequest.Builder`
`static class`	`ListUserAnalyticsRequest.SortBy` The field to sort by.
`static class`	`ListUserAnalyticsRequest.SortOrder` The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors
Constructor and Description

ListUserAnalyticsRequest()

Constructors
Constructor and Description
`ListUserAnalyticsRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListUserAnalyticsRequest.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’.
`ListUserAnalyticsRequest.AccessLevel`	`getAccessLevel()` Valid values are RESTRICTED and ACCESSIBLE.
`String`	`getAccountStatus()` A filter to return only items that match the specified account status.
`String`	`getAuthenticationType()` A filter to return only items that match the specified authentication type.
`Boolean`	`getCompartmentIdInSubtree()` Default is false.
`Integer`	`getLimit()` For list pagination.
`String`	`getOpcRequestId()` Unique identifier for the request.
`String`	`getPage()` For list pagination.
`ListUserAnalyticsRequest.SortBy`	`getSortBy()` The field to sort by.
`ListUserAnalyticsRequest.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`	`getTimeLastLoginGreaterThanOrEqualTo()` A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
`Date`	`getTimeLastLoginLessThan()` A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339.
`Date`	`getTimePasswordLastChangedGreaterThanOrEqualTo()` A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
`Date`	`getTimePasswordLastChangedLessThan()` A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.
`Date`	`getTimeUserCreatedGreaterThanOrEqualTo()` A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
`Date`	`getTimeUserCreatedLessThan()` A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339.
`String`	`getUserAssessmentId()` The OCID of the user assessment.
`String`	`getUserCategory()` A filter to return only items that match the specified user category.
`String`	`getUserKey()` A filter to return only items that match the specified user key.
`String`	`getUserName()` A filter to return only items that match the specified user name.
`int`	`hashCode()` Uses getInvocationCallback and getRetryConfiguration to generate a hash.
`ListUserAnalyticsRequest.Builder`	`toBuilder()` Return an instance of `ListUserAnalyticsRequest.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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListUserAnalyticsRequest
```
public ListUserAnalyticsRequest()
```
- Method Detail
  - getUserAssessmentId
```
public String getUserAssessmentId()
```
    The OCID of the user assessment.
  - 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 ListUserAnalyticsRequest.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.
  - 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.
  - getUserCategory
```
public String getUserCategory()
```
    A filter to return only items that match the specified user category.
  - getUserKey
```
public String getUserKey()
```
    A filter to return only items that match the specified user key.
  - getAccountStatus
```
public String getAccountStatus()
```
    A filter to return only items that match the specified account status.
  - getAuthenticationType
```
public String getAuthenticationType()
```
    A filter to return only items that match the specified authentication type.
  - getUserName
```
public String getUserName()
```
    A filter to return only items that match the specified user name.
  - getTargetId
```
public String getTargetId()
```
    A filter to return only items related to a specific target OCID.
  - getTimeLastLoginGreaterThanOrEqualTo
```
public Date getTimeLastLoginGreaterThanOrEqualTo()
```
    A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
    
    *Example:** 2016-12-19T16:39:57.600Z
  - getTimeLastLoginLessThan
```
public Date getTimeLastLoginLessThan()
```
    A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
  - getTimeUserCreatedGreaterThanOrEqualTo
```
public Date getTimeUserCreatedGreaterThanOrEqualTo()
```
    A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
  - getTimeUserCreatedLessThan
```
public Date getTimeUserCreatedLessThan()
```
    A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. Example: 2016-12-19T16:39:57.600Z
  - getTimePasswordLastChangedGreaterThanOrEqualTo
```
public Date getTimePasswordLastChangedGreaterThanOrEqualTo()
```
    A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
    
    *Example:** 2016-12-19T16:39:57.600Z
  - getTimePasswordLastChangedLessThan
```
public Date getTimePasswordLastChangedLessThan()
```
    A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.
    
    *Example:** 2016-12-19T16:39:57.600Z
  - 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 ListUserAnalyticsRequest.SortOrder getSortOrder()
```
    The sort order to use, either ascending (ASC) or descending (DESC).
  - getSortBy
```
public ListUserAnalyticsRequest.SortBy getSortBy()
```
    The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending.
  - getOpcRequestId
```
public String getOpcRequestId()
```
    Unique identifier for the request.
  - toBuilder
```
public ListUserAnalyticsRequest.Builder toBuilder()
```
    Return an instance of ListUserAnalyticsRequest.Builder that allows you to modify request properties.
    
    Returns:
    
    instance of ListUserAnalyticsRequest.Builder that allows you to modify request properties.
  - builder
```
public static ListUserAnalyticsRequest.Builder builder()
```
    Return a new builder for this request object.
    
    Returns:
    
    builder for the request object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class 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 class BmcRequest<Void>
  - hashCode
```
public int hashCode()
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to generate a hash.
    
    Overrides:
    
    hashCode in class BmcRequest<Void>

Class ListUserAnalyticsRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.requests.BmcRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListUserAnalyticsRequest

Method Detail

getUserAssessmentId

getCompartmentIdInSubtree

getAccessLevel

getLimit

getUserCategory

getUserKey

getAccountStatus

getAuthenticationType

getUserName

getTargetId

getTimeLastLoginGreaterThanOrEqualTo

getTimeLastLoginLessThan

getTimeUserCreatedGreaterThanOrEqualTo

getTimeUserCreatedLessThan

getTimePasswordLastChangedGreaterThanOrEqualTo

getTimePasswordLastChangedLessThan

getPage

getSortOrder

getSortBy

getOpcRequestId

toBuilder

builder

toString

equals

hashCode