Group
- Implements: IGroup
This class encapsulates and extends the ROS resource type ALIYUN::PAIPlugin::Group.
Initializers
import com.aliyun.ros.cdk.paiplugin.Group;
Group.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.name(java.lang.String)
.name(IResolvable)
.source(java.lang.Number)
.source(IResolvable)
// .algorithm(java.lang.String)
// .algorithm(IResolvable)
// .column(java.lang.String)
// .column(IResolvable)
// .filter(java.lang.String)
// .filter(IResolvable)
// .inferenceJobId(java.lang.String)
// .inferenceJobId(IResolvable)
// .phoneNumber(java.lang.String)
// .phoneNumber(IResolvable)
// .project(java.lang.String)
// .project(IResolvable)
// .remark(java.lang.String)
// .remark(IResolvable)
// .table(java.lang.String)
// .table(IResolvable)
// .text(java.lang.String)
// .text(IResolvable)
// .uri(java.lang.String)
// .uri(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the user group. |
source | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property source: Crowd source. |
algorithm | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property algorithm: Association algorithm. |
column | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property column: Mobile phone number column name. |
filter | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property filter: Filter condition. |
inferenceJobId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property inferenceJobId: Prediction task ID.This condition can be specified when Source is 4(Algorithm). |
phoneNumber | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property phoneNumber: Whether to include mobile phone numbers. |
project | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property project: MaxCompute (ODPS) project name. |
remark | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property remark: The notes of the user group. |
table | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property table: MaxCompute (ODPS) table name. |
text | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property text: The text of the phone number. |
uri | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property uri: File address. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
nameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the user group.
sourceRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property source: Crowd source.
Valid values: 0: Enter phone numbers. 1: Single-column CSV File (Phone Numbers). 2: Multi-column CSV File. 3: MaxCompute Table. 4: Algorithm.
algorithmOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property algorithm: Association algorithm.
This must be specified when Source is 4(Algorithm).
columnOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property column: Mobile phone number column name.
The Source is 2(Multi-column CSV File) or 3(MaxCompute Table) needs to be specified when it contains mobile phone numbers.
filterOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property filter: Filter condition.
This condition can be specified when Source is 3(MaxCompute Table).
inferenceJobIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property inferenceJobId: Prediction task ID.This condition can be specified when Source is 4(Algorithm).
phoneNumberOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property phoneNumber: Whether to include mobile phone numbers.
People with mobile phone numbers can be used for reach plans.
projectOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property project: MaxCompute (ODPS) project name.
This parameter must be specified when Source is 3(MaxCompute Table).
remarkOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remark: The notes of the user group.
tableOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property table: MaxCompute (ODPS) table name.
This parameter must be specified when Source is 3(MaxCompute Table).
textOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property text: The text of the phone number.
This must be specified when Source is 0(Enter phone numbers).
uriOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property uri: File address.
It needs to be specified when Source is 1(Single-column CSV File) or 2(Multi-column CSV File).
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.paiplugin.Group;
Group.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrAmount | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Amount: The number of the user group. |
attrCreatedTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreatedTime: The creation time of the user group. |
attrId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Id: The ID of the user group. |
attrName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Name: The name of the user group. |
props | GroupProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrAmountRequired
public java.lang.Object getAttrAmount();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Amount: The number of the user group.
attrCreatedTimeRequired
public java.lang.Object getAttrCreatedTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreatedTime: The creation time of the user group.
attrIdRequired
public java.lang.Object getAttrId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Id: The ID of the user group.
attrNameRequired
public java.lang.Object getAttrName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Name: The name of the user group.
propsRequired
public GroupProps getProps();
- Type: GroupProps