com.tencentcloudapi.organization.v20210331.models

Class ListGroupsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.organization.v20210331.models.ListGroupsRequest

public class ListGroupsRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ListGroupsRequest()
ListGroupsRequest(ListGroupsRequest 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.
String[]	getFilterUsers() Get Filtered user.
String	getGroupType() Get User group type.
Long	getMaxResults() Get Maximum number of data entries per page.
String	getNextToken() Get Token for querying the next page of returned results.
Long	getOffset() Get Pagination offset.
String	getSortField() Get Sorting field, which currently only supports CreateTime.
String	getSortType() Get Sorting type.
String	getZoneId() Get Space ID.
void	setFilter(String Filter) Set Filter criterion.
void	setFilterUsers(String[] FilterUsers) Set Filtered user.
void	setGroupType(String GroupType) Set User group type.
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	setOffset(Long Offset) Set Pagination offset.
void	setSortField(String SortField) Set Sorting field, which currently only supports CreateTime.
void	setSortType(String SortType) Set Sorting 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, isStream, 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

ListGroupsRequest

public ListGroupsRequest()

ListGroupsRequest

public ListGroupsRequest(ListGroupsRequest 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.

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.

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.

getFilter

public String getFilter()

Get Filter criterion. Format: , case-insensitive. Currently, supports only GroupName, and supports only eq (Equals) and sw (Start With). For example, Filter = "GroupName sw test" indicates querying all user groups with names starting with test; Filter = "GroupName eq testgroup" indicates querying the user group with the name testgroup.

Returns:

Filter Filter criterion. Format: , case-insensitive. Currently, supports only GroupName, and supports only eq (Equals) and sw (Start With). For example, Filter = "GroupName sw test" indicates querying all user groups with names starting with test; Filter = "GroupName eq testgroup" indicates querying the user group with the name testgroup.

setFilter

public void setFilter(String Filter)

Set Filter criterion. Format: , case-insensitive. Currently, supports only GroupName, and supports only eq (Equals) and sw (Start With). For example, Filter = "GroupName sw test" indicates querying all user groups with names starting with test; Filter = "GroupName eq testgroup" indicates querying the user group with the name testgroup.

Parameters:

Filter - Filter criterion. Format: , case-insensitive. Currently, supports only GroupName, and supports only eq (Equals) and sw (Start With). For example, Filter = "GroupName sw test" indicates querying all user groups with names starting with test; Filter = "GroupName eq testgroup" indicates querying the user group with the name testgroup.

getGroupType

public String getGroupType()

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

Returns:

GroupType User group type. Manual: manually created; Synchronized: externally imported.

setGroupType

public void setGroupType(String GroupType)

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

Parameters:

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

getFilterUsers

public String[] getFilterUsers()

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

Returns:

FilterUsers Filtered user. IsSelected=1 will be returned for the user group associated with this user.

setFilterUsers

public void setFilterUsers(String[] FilterUsers)

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

Parameters:

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

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.

getOffset

public Long getOffset()

Get Pagination offset. Do not use it together with NextToken, prioritizing using NextToken.

Returns:

Offset Pagination offset. Do not use it together with NextToken, prioritizing using NextToken.

setOffset

public void setOffset(Long Offset)

Set Pagination offset. Do not use it together with NextToken, prioritizing using NextToken.

Parameters:

Offset - Pagination offset. Do not use it together with NextToken, prioritizing using NextToken.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.