GetCurrentUserDataRequest (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.GetCurrentUserDataRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class GetCurrentUserDataRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Gets the real-time active user data from the specified Amazon Connect instance.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetCurrentUserDataRequest()

Constructors
Constructor and Description
`GetCurrentUserDataRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`UserDataFilters`	`getFilters()` The filters to apply to returned user data.
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`java.lang.Integer`	`getMaxResults()` The maximum number of results to return per page.
`java.lang.String`	`getNextToken()` The token for the next set of results.
`int`	`hashCode()`
`void`	`setFilters(UserDataFilters filters)` The filters to apply to returned user data.
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`void`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`void`	`setNextToken(java.lang.String nextToken)` The token for the next set of results.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetCurrentUserDataRequest`	`withFilters(UserDataFilters filters)` The filters to apply to returned user data.
`GetCurrentUserDataRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`GetCurrentUserDataRequest`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`GetCurrentUserDataRequest`	`withNextToken(java.lang.String nextToken)` The token for the next set of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - GetCurrentUserDataRequest
```
public GetCurrentUserDataRequest()
```
- Method Detail
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - withInstanceId
```
public GetCurrentUserDataRequest withInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFilters
```
public UserDataFilters getFilters()
```
    The filters to apply to returned user data. You can filter up to the following limits:
    - Queues: 100
    - Routing profiles: 100
    - Agents: 100
    - Contact states: 9
    - User hierarchy groups: 1
    The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
    
    Currently tagging is only supported on the resources that are passed in the filter.
    Returns:
    The filters to apply to returned user data. You can filter up to the following limits:
    
    Queues: 100
    
    Routing profiles: 100
    
    Agents: 100
    
    Contact states: 9
    
    User hierarchy groups: 1
    
    The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
    
    Currently tagging is only supported on the resources that are passed in the filter.
  - setFilters
```
public void setFilters(UserDataFilters filters)
```
    The filters to apply to returned user data. You can filter up to the following limits:
    - Queues: 100
    - Routing profiles: 100
    - Agents: 100
    - Contact states: 9
    - User hierarchy groups: 1
    The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
    
    Currently tagging is only supported on the resources that are passed in the filter.
    Parameters:
    filters -
    The filters to apply to returned user data. You can filter up to the following limits:
    
    Queues: 100
    
    Routing profiles: 100
    
    Agents: 100
    
    Contact states: 9
    
    User hierarchy groups: 1
    
    The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
    
    Currently tagging is only supported on the resources that are passed in the filter.
  - withFilters
```
public GetCurrentUserDataRequest withFilters(UserDataFilters filters)
```
    The filters to apply to returned user data. You can filter up to the following limits:
    - Queues: 100
    - Routing profiles: 100
    - Agents: 100
    - Contact states: 9
    - User hierarchy groups: 1
    The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
    
    Currently tagging is only supported on the resources that are passed in the filter.
    
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    filters -
    The filters to apply to returned user data. You can filter up to the following limits:
    
    Queues: 100
    
    Routing profiles: 100
    
    Agents: 100
    
    Contact states: 9
    
    User hierarchy groups: 1
    
    The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.
    
    Currently tagging is only supported on the resources that are passed in the filter.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.String getNextToken()
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns:
    
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Parameters:
    
    nextToken -
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  - withNextToken
```
public GetCurrentUserDataRequest withNextToken(java.lang.String nextToken)
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    nextToken -
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of results to return per page.
    
    Constraints:
    Range: 1 - 100
    
    Returns:
    
    The maximum number of results to return per page.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page.
    
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page.
  - withMaxResults
```
public GetCurrentUserDataRequest withMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class GetCurrentUserDataRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetCurrentUserDataRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getFilters

setFilters

withFilters

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

toString

hashCode

equals