Skip to content

Group

This class encapsulates and extends the ROS resource type ALIYUN::PAIPlugin::Group.

Initializers 

import ros_cdk_paiplugin
ros_cdk_paiplugin.Group(
  scope: Construct,
  id: str,
  name: typing.Union[str, IResolvable],
  source: typing.Union[typing.Union[int, float], IResolvable],
  algorithm: typing.Union[str, IResolvable] = None,
  column: typing.Union[str, IResolvable] = None,
  filter: typing.Union[str, IResolvable] = None,
  inference_job_id: typing.Union[str, IResolvable] = None,
  phone_number: typing.Union[str, IResolvable] = None,
  project: typing.Union[str, IResolvable] = None,
  remark: typing.Union[str, IResolvable] = None,
  table: typing.Union[str, IResolvable] = None,
  text: typing.Union[str, IResolvable] = None,
  uri: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the user group.
source typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property source: Crowd source.
algorithm typing.Union[str, ros_cdk_core.IResolvable] Property algorithm: Association algorithm.
column typing.Union[str, ros_cdk_core.IResolvable] Property column: Mobile phone number column name.
filter typing.Union[str, ros_cdk_core.IResolvable] Property filter: Filter condition.
inference_job_id typing.Union[str, ros_cdk_core.IResolvable] Property inferenceJobId: Prediction task ID.This condition can be specified when Source is 4(Algorithm).
phone_number typing.Union[str, ros_cdk_core.IResolvable] Property phoneNumber: Whether to include mobile phone numbers.
project typing.Union[str, ros_cdk_core.IResolvable] Property project: MaxCompute (ODPS) project name.
remark typing.Union[str, ros_cdk_core.IResolvable] Property remark: The notes of the user group.
table typing.Union[str, ros_cdk_core.IResolvable] Property table: MaxCompute (ODPS) table name.
text typing.Union[str, ros_cdk_core.IResolvable] Property text: The text of the phone number.
uri typing.Union[str, ros_cdk_core.IResolvable] Property uri: File address.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the user group.

sourceRequired

  • Type: typing.Union[typing.Union[int, float], 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: typing.Union[str, ros_cdk_core.IResolvable]

Property algorithm: Association algorithm.

This must be specified when Source is 4(Algorithm).

columnOptional

  • Type: typing.Union[str, 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: typing.Union[str, ros_cdk_core.IResolvable]

Property filter: Filter condition.

This condition can be specified when Source is 3(MaxCompute Table).

inference_job_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property inferenceJobId: Prediction task ID.This condition can be specified when Source is 4(Algorithm).

phone_numberOptional

  • Type: typing.Union[str, 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: typing.Union[str, ros_cdk_core.IResolvable]

Property project: MaxCompute (ODPS) project name.

This parameter must be specified when Source is 3(MaxCompute Table).

remarkOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property remark: The notes of the user group.

tableOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property table: MaxCompute (ODPS) table name.

This parameter must be specified when Source is 3(MaxCompute Table).

textOptional

  • Type: typing.Union[str, 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: typing.Union[str, 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).

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_paiplugin
ros_cdk_paiplugin.Group.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_amount ros_cdk_core.IResolvable Attribute Amount: The number of the user group.
attr_created_time ros_cdk_core.IResolvable Attribute CreatedTime: The creation time of the user group.
attr_id ros_cdk_core.IResolvable Attribute Id: The ID of the user group.
attr_name ros_cdk_core.IResolvable Attribute Name: The name of the user group.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_amountRequired 

attr_amount: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Amount: The number of the user group.

attr_created_timeRequired 

attr_created_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreatedTime: The creation time of the user group.

attr_idRequired 

attr_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Id: The ID of the user group.

attr_nameRequired 

attr_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Name: The name of the user group.