com.tencentcloudapi.eiam.v20210420.models.ListUsersInUserGroupRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-eiam Show documentation
Show all versions of tencentcloud-sdk-java-eiam Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.eiam.v20210420.models;
import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class ListUsersInUserGroupRequest extends AbstractModel{
/**
* 用户组ID,是用户组的全局唯一标识。
*/
@SerializedName("UserGroupId")
@Expose
private String UserGroupId;
/**
* 用户属性搜索条件,可查询条件包括:用户名、手机号码,邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间,支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式,具体查询方式为:双引号(“”)表示全匹配、以星号()结尾表示字段部分匹配、中括号以逗号分隔([Min,Max])表示闭区间查询、大括号以逗号分隔({Min,Max})表示开区间查询,中括号与大括号可以配合使用(例如:{Min,Max]表示最小值开区间,最大值闭区间查询)。范围匹配支持使用星号(例如{20,]表示查询范围为大于20的所有数据)。范围查询同时支持时间段查询,支持的属性包括创建时间 (CreationTime)、上次修改时间(LastUpdateTime),查询的时间格式遵循 ISO 8601 标准,例如:2021-01-13T09:44:07.182+0000。
*/
@SerializedName("SearchCondition")
@Expose
private UserSearchCriteria SearchCondition;
/**
* 排序条件集合。可排序的属性支持:用户名字(UserName)、用户昵称(DisplayName)、手机号(Phone)、邮箱(Email)、用户状态(Status)、创建时间 (CreatedDate)、上次更新时间(LastModifiedDate)。如果不指定,则默认按照用户昵称(DisplayName)正向排序。
*/
@SerializedName("Sort")
@Expose
private SortCondition Sort;
/**
* 分页偏移量,默认为0。Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
*/
@SerializedName("Offset")
@Expose
private Long Offset;
/**
* 分页读取数量,默认为50,最大值为100。 Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
*/
@SerializedName("Limit")
@Expose
private Long Limit;
/**
* Get 用户组ID,是用户组的全局唯一标识。
* @return UserGroupId 用户组ID,是用户组的全局唯一标识。
*/
public String getUserGroupId() {
return this.UserGroupId;
}
/**
* Set 用户组ID,是用户组的全局唯一标识。
* @param UserGroupId 用户组ID,是用户组的全局唯一标识。
*/
public void setUserGroupId(String UserGroupId) {
this.UserGroupId = UserGroupId;
}
/**
* Get 用户属性搜索条件,可查询条件包括:用户名、手机号码,邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间,支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式,具体查询方式为:双引号(“”)表示全匹配、以星号()结尾表示字段部分匹配、中括号以逗号分隔([Min,Max])表示闭区间查询、大括号以逗号分隔({Min,Max})表示开区间查询,中括号与大括号可以配合使用(例如:{Min,Max]表示最小值开区间,最大值闭区间查询)。范围匹配支持使用星号(例如{20,]表示查询范围为大于20的所有数据)。范围查询同时支持时间段查询,支持的属性包括创建时间 (CreationTime)、上次修改时间(LastUpdateTime),查询的时间格式遵循 ISO 8601 标准,例如:2021-01-13T09:44:07.182+0000。
* @return SearchCondition 用户属性搜索条件,可查询条件包括:用户名、手机号码,邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间,支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式,具体查询方式为:双引号(“”)表示全匹配、以星号()结尾表示字段部分匹配、中括号以逗号分隔([Min,Max])表示闭区间查询、大括号以逗号分隔({Min,Max})表示开区间查询,中括号与大括号可以配合使用(例如:{Min,Max]表示最小值开区间,最大值闭区间查询)。范围匹配支持使用星号(例如{20,]表示查询范围为大于20的所有数据)。范围查询同时支持时间段查询,支持的属性包括创建时间 (CreationTime)、上次修改时间(LastUpdateTime),查询的时间格式遵循 ISO 8601 标准,例如:2021-01-13T09:44:07.182+0000。
*/
public UserSearchCriteria getSearchCondition() {
return this.SearchCondition;
}
/**
* Set 用户属性搜索条件,可查询条件包括:用户名、手机号码,邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间,支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式,具体查询方式为:双引号(“”)表示全匹配、以星号()结尾表示字段部分匹配、中括号以逗号分隔([Min,Max])表示闭区间查询、大括号以逗号分隔({Min,Max})表示开区间查询,中括号与大括号可以配合使用(例如:{Min,Max]表示最小值开区间,最大值闭区间查询)。范围匹配支持使用星号(例如{20,]表示查询范围为大于20的所有数据)。范围查询同时支持时间段查询,支持的属性包括创建时间 (CreationTime)、上次修改时间(LastUpdateTime),查询的时间格式遵循 ISO 8601 标准,例如:2021-01-13T09:44:07.182+0000。
* @param SearchCondition 用户属性搜索条件,可查询条件包括:用户名、手机号码,邮箱、用户锁定状态、用户冻结状态、创建时间、上次修改时间,支持多种属性组合作为查询条件。同时支持查询信息内容全匹配、部分匹配、范围匹配等多种查询方式,具体查询方式为:双引号(“”)表示全匹配、以星号()结尾表示字段部分匹配、中括号以逗号分隔([Min,Max])表示闭区间查询、大括号以逗号分隔({Min,Max})表示开区间查询,中括号与大括号可以配合使用(例如:{Min,Max]表示最小值开区间,最大值闭区间查询)。范围匹配支持使用星号(例如{20,]表示查询范围为大于20的所有数据)。范围查询同时支持时间段查询,支持的属性包括创建时间 (CreationTime)、上次修改时间(LastUpdateTime),查询的时间格式遵循 ISO 8601 标准,例如:2021-01-13T09:44:07.182+0000。
*/
public void setSearchCondition(UserSearchCriteria SearchCondition) {
this.SearchCondition = SearchCondition;
}
/**
* Get 排序条件集合。可排序的属性支持:用户名字(UserName)、用户昵称(DisplayName)、手机号(Phone)、邮箱(Email)、用户状态(Status)、创建时间 (CreatedDate)、上次更新时间(LastModifiedDate)。如果不指定,则默认按照用户昵称(DisplayName)正向排序。
* @return Sort 排序条件集合。可排序的属性支持:用户名字(UserName)、用户昵称(DisplayName)、手机号(Phone)、邮箱(Email)、用户状态(Status)、创建时间 (CreatedDate)、上次更新时间(LastModifiedDate)。如果不指定,则默认按照用户昵称(DisplayName)正向排序。
*/
public SortCondition getSort() {
return this.Sort;
}
/**
* Set 排序条件集合。可排序的属性支持:用户名字(UserName)、用户昵称(DisplayName)、手机号(Phone)、邮箱(Email)、用户状态(Status)、创建时间 (CreatedDate)、上次更新时间(LastModifiedDate)。如果不指定,则默认按照用户昵称(DisplayName)正向排序。
* @param Sort 排序条件集合。可排序的属性支持:用户名字(UserName)、用户昵称(DisplayName)、手机号(Phone)、邮箱(Email)、用户状态(Status)、创建时间 (CreatedDate)、上次更新时间(LastModifiedDate)。如果不指定,则默认按照用户昵称(DisplayName)正向排序。
*/
public void setSort(SortCondition Sort) {
this.Sort = Sort;
}
/**
* Get 分页偏移量,默认为0。Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
* @return Offset 分页偏移量,默认为0。Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
*/
public Long getOffset() {
return this.Offset;
}
/**
* Set 分页偏移量,默认为0。Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
* @param Offset 分页偏移量,默认为0。Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
*/
public void setOffset(Long Offset) {
this.Offset = Offset;
}
/**
* Get 分页读取数量,默认为50,最大值为100。 Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
* @return Limit 分页读取数量,默认为50,最大值为100。 Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
*/
public Long getLimit() {
return this.Limit;
}
/**
* Set 分页读取数量,默认为50,最大值为100。 Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
* @param Limit 分页读取数量,默认为50,最大值为100。 Offset 和 Limit 两个字段需配合使用,即其中一个指定了,另一个必须指定。 如果不指定以上参数,则表示不进行分页查询,即只返回最多50个用户。
*/
public void setLimit(Long Limit) {
this.Limit = Limit;
}
public ListUsersInUserGroupRequest() {
}
/**
* 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.
*/
public ListUsersInUserGroupRequest(ListUsersInUserGroupRequest source) {
if (source.UserGroupId != null) {
this.UserGroupId = new String(source.UserGroupId);
}
if (source.SearchCondition != null) {
this.SearchCondition = new UserSearchCriteria(source.SearchCondition);
}
if (source.Sort != null) {
this.Sort = new SortCondition(source.Sort);
}
if (source.Offset != null) {
this.Offset = new Long(source.Offset);
}
if (source.Limit != null) {
this.Limit = new Long(source.Limit);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "UserGroupId", this.UserGroupId);
this.setParamObj(map, prefix + "SearchCondition.", this.SearchCondition);
this.setParamObj(map, prefix + "Sort.", this.Sort);
this.setParamSimple(map, prefix + "Offset", this.Offset);
this.setParamSimple(map, prefix + "Limit", this.Limit);
}
}