com.tencentcloudapi.organization.v20210331.models

Class ListUsersRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.organization.v20210331.models.ListUsersRequest

public class ListUsersRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ListUsersRequest()
ListUsersRequest(ListUsersRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getFilter() Get Filter criterion, which currently only supports username, email address, userId, and description.
String[]	getFilterGroups() Get Filtered user group.
Long	getMaxResults() Get Maximum number of data entries per page.
String	getNextToken() Get Token for querying the next page of returned results.
String	getSortField() Get Sorting field, which currently only supports CreateTime.
String	getSortType() Get Sorting type.
String	getUserStatus() Get User status: Enabled, Disabled.
String	getUserType() Get User type.
String	getZoneId() Get Space ID.
void	setFilter(String Filter) Set Filter criterion, which currently only supports username, email address, userId, and description.
void	setFilterGroups(String[] FilterGroups) Set Filtered user group.
void	setMaxResults(Long MaxResults) Set Maximum number of data entries per page.
void	setNextToken(String NextToken) Set Token for querying the next page of returned results.
void	setSortField(String SortField) Set Sorting field, which currently only supports CreateTime.
void	setSortType(String SortType) Set Sorting type.
void	setUserStatus(String UserStatus) Set User status: Enabled, Disabled.
void	setUserType(String UserType) Set User type.
void	setZoneId(String ZoneId) Set Space ID.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListUsersRequest

public ListUsersRequest()

ListUsersRequest

public ListUsersRequest(ListUsersRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getZoneId

public String getZoneId()

Get Space ID.

Returns:

ZoneId Space ID.

setZoneId

public void setZoneId(String ZoneId)

Set Space ID.

Parameters:

ZoneId - Space ID.

getUserStatus

public String getUserStatus()

Get User status: Enabled, Disabled.

Returns:

UserStatus User status: Enabled, Disabled.

setUserStatus

public void setUserStatus(String UserStatus)

Set User status: Enabled, Disabled.

Parameters:

UserStatus - User status: Enabled, Disabled.

getUserType

public String getUserType()

Get User type. Manual: manually created; Synchronized: externally imported.

Returns:

UserType User type. Manual: manually created; Synchronized: externally imported.

setUserType

public void setUserType(String UserType)

Set User type. Manual: manually created; Synchronized: externally imported.

Parameters:

UserType - User type. Manual: manually created; Synchronized: externally imported.

getFilter

public String getFilter()

Get Filter criterion, which currently only supports username, email address, userId, and description.

Returns:

Filter Filter criterion, which currently only supports username, email address, userId, and description.

setFilter

public void setFilter(String Filter)

Set Filter criterion, which currently only supports username, email address, userId, and description.

Parameters:

Filter - Filter criterion, which currently only supports username, email address, userId, and description.

getMaxResults

public Long getMaxResults()

Get Maximum number of data entries per page. Value range: 1-100. Default value: 10.

Returns:

MaxResults Maximum number of data entries per page. Value range: 1-100. Default value: 10.

setMaxResults

public void setMaxResults(Long MaxResults)

Set Maximum number of data entries per page. Value range: 1-100. Default value: 10.

Parameters:

MaxResults - Maximum number of data entries per page. Value range: 1-100. Default value: 10.

getNextToken

public String getNextToken()

Get Token for querying the next page of returned results. During use of the API for the first time, NextToken is not needed. When you call the API for the first time, if the total number of returned data entries exceeds the MaxResults limit, the data is truncated and only MaxResults data entries are returned. Meanwhile, the return parameter IsTruncated is true and a NextToken is returned. You can use the NextToken returned last time to continue calling the API with other request parameters unchanged, to query the truncated data. You can use this method for multiple queries until IsTruncated is false, indicating that all data has been queried.

Returns:

NextToken Token for querying the next page of returned results. During use of the API for the first time, NextToken is not needed. When you call the API for the first time, if the total number of returned data entries exceeds the MaxResults limit, the data is truncated and only MaxResults data entries are returned. Meanwhile, the return parameter IsTruncated is true and a NextToken is returned. You can use the NextToken returned last time to continue calling the API with other request parameters unchanged, to query the truncated data. You can use this method for multiple queries until IsTruncated is false, indicating that all data has been queried.

setNextToken

public void setNextToken(String NextToken)

Set Token for querying the next page of returned results. During use of the API for the first time, NextToken is not needed. When you call the API for the first time, if the total number of returned data entries exceeds the MaxResults limit, the data is truncated and only MaxResults data entries are returned. Meanwhile, the return parameter IsTruncated is true and a NextToken is returned. You can use the NextToken returned last time to continue calling the API with other request parameters unchanged, to query the truncated data. You can use this method for multiple queries until IsTruncated is false, indicating that all data has been queried.

Parameters:

NextToken - Token for querying the next page of returned results. During use of the API for the first time, NextToken is not needed. When you call the API for the first time, if the total number of returned data entries exceeds the MaxResults limit, the data is truncated and only MaxResults data entries are returned. Meanwhile, the return parameter IsTruncated is true and a NextToken is returned. You can use the NextToken returned last time to continue calling the API with other request parameters unchanged, to query the truncated data. You can use this method for multiple queries until IsTruncated is false, indicating that all data has been queried.

getFilterGroups

public String[] getFilterGroups()

Get Filtered user group. IsSelected=1 will be returned for the sub-user associated with this user group.

Returns:

FilterGroups Filtered user group. IsSelected=1 will be returned for the sub-user associated with this user group.

setFilterGroups

public void setFilterGroups(String[] FilterGroups)

Set Filtered user group. IsSelected=1 will be returned for the sub-user associated with this user group.

Parameters:

FilterGroups - Filtered user group. IsSelected=1 will be returned for the sub-user associated with this user group.

getSortField

public String getSortField()

Get Sorting field, which currently only supports CreateTime. The default is the CreateTime field.

Returns:

SortField Sorting field, which currently only supports CreateTime. The default is the CreateTime field.

setSortField

public void setSortField(String SortField)

Set Sorting field, which currently only supports CreateTime. The default is the CreateTime field.

Parameters:

SortField - Sorting field, which currently only supports CreateTime. The default is the CreateTime field.

getSortType

public String getSortType()

Get Sorting type. Desc: descending order; Asc: ascending order. It should be set along with SortField.

Returns:

SortType Sorting type. Desc: descending order; Asc: ascending order. It should be set along with SortField.

setSortType

public void setSortType(String SortType)

Set Sorting type. Desc: descending order; Asc: ascending order. It should be set along with SortField.

Parameters:

SortType - Sorting type. Desc: descending order; Asc: ascending order. It should be set along with SortField.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel