com.tencentcloudapi.iai.v20200303.models

Class CreateGroupRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.iai.v20200303.models.CreateGroupRequest

public class CreateGroupRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateGroupRequest()
CreateGroupRequest(CreateGroupRequest 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	getFaceModelVersion() Get Algorithm model version used by the Face Recognition service.
String[]	getGroupExDescriptions() Get Custom group description field that describes the person attributes in the group, which will be applied to all persons in the group.
String	getGroupId() Get Group ID, which is unmodifiable, must be unique, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.
String	getGroupName() Get Group name, which is modifiable, must be unique, and can contain 1 to 60 characters.
String	getTag() Get Group remarks, which can contain 0 to 40 characters.
void	setFaceModelVersion(String FaceModelVersion) Set Algorithm model version used by the Face Recognition service.
void	setGroupExDescriptions(String[] GroupExDescriptions) Set Custom group description field that describes the person attributes in the group, which will be applied to all persons in the group.
void	setGroupId(String GroupId) Set Group ID, which is unmodifiable, must be unique, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.
void	setGroupName(String GroupName) Set Group name, which is modifiable, must be unique, and can contain 1 to 60 characters.
void	setTag(String Tag) Set Group remarks, which can contain 0 to 40 characters.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateGroupRequest

public CreateGroupRequest()

CreateGroupRequest

public CreateGroupRequest(CreateGroupRequest 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

getGroupName

public String getGroupName()

Get Group name, which is modifiable, must be unique, and can contain 1 to 60 characters.

Returns:

GroupName Group name, which is modifiable, must be unique, and can contain 1 to 60 characters.

setGroupName

public void setGroupName(String GroupName)

Set Group name, which is modifiable, must be unique, and can contain 1 to 60 characters.

Parameters:

GroupName - Group name, which is modifiable, must be unique, and can contain 1 to 60 characters.

getGroupId

public String getGroupId()

Get Group ID, which is unmodifiable, must be unique, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.

Returns:

GroupId Group ID, which is unmodifiable, must be unique, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.

setGroupId

public void setGroupId(String GroupId)

Set Group ID, which is unmodifiable, must be unique, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.

Parameters:

GroupId - Group ID, which is unmodifiable, must be unique, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.

getGroupExDescriptions

public String[] getGroupExDescriptions()

Get Custom group description field that describes the person attributes in the group, which will be applied to all persons in the group. Up to 5 ones can be created. Each custom description field can contain 1 to 30 characters. The custom description field must be unique in the group. Example: if you set the "custom description field" of a group to ["student ID","employee ID","mobile number"], then all the persons in the group will have description fields named "student ID", "employee ID", and "mobile number". You can enter content in the corresponding field to register a person's student ID, employee ID, and mobile number.

Returns:

GroupExDescriptions Custom group description field that describes the person attributes in the group, which will be applied to all persons in the group. Up to 5 ones can be created. Each custom description field can contain 1 to 30 characters. The custom description field must be unique in the group. Example: if you set the "custom description field" of a group to ["student ID","employee ID","mobile number"], then all the persons in the group will have description fields named "student ID", "employee ID", and "mobile number". You can enter content in the corresponding field to register a person's student ID, employee ID, and mobile number.

setGroupExDescriptions

public void setGroupExDescriptions(String[] GroupExDescriptions)

Set Custom group description field that describes the person attributes in the group, which will be applied to all persons in the group. Up to 5 ones can be created. Each custom description field can contain 1 to 30 characters. The custom description field must be unique in the group. Example: if you set the "custom description field" of a group to ["student ID","employee ID","mobile number"], then all the persons in the group will have description fields named "student ID", "employee ID", and "mobile number". You can enter content in the corresponding field to register a person's student ID, employee ID, and mobile number.

Parameters:

GroupExDescriptions - Custom group description field that describes the person attributes in the group, which will be applied to all persons in the group. Up to 5 ones can be created. Each custom description field can contain 1 to 30 characters. The custom description field must be unique in the group. Example: if you set the "custom description field" of a group to ["student ID","employee ID","mobile number"], then all the persons in the group will have description fields named "student ID", "employee ID", and "mobile number". You can enter content in the corresponding field to register a person's student ID, employee ID, and mobile number.

getTag

public String getTag()

Get Group remarks, which can contain 0 to 40 characters.

Returns:

Tag Group remarks, which can contain 0 to 40 characters.

setTag

public void setTag(String Tag)

Set Group remarks, which can contain 0 to 40 characters.

Parameters:

Tag - Group remarks, which can contain 0 to 40 characters.

getFaceModelVersion

public String getFaceModelVersion()

Get Algorithm model version used by the Face Recognition service. Currently, `2.0` and `3.0` are supported. This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default. The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020. Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.

Returns:

FaceModelVersion Algorithm model version used by the Face Recognition service. Currently, `2.0` and `3.0` are supported. This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default. The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020. Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.

setFaceModelVersion

public void setFaceModelVersion(String FaceModelVersion)

Set Algorithm model version used by the Face Recognition service. Currently, `2.0` and `3.0` are supported. This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default. The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020. Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.

Parameters:

FaceModelVersion - Algorithm model version used by the Face Recognition service. Currently, `2.0` and `3.0` are supported. This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default. The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020. Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel