Run

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Run.

Initializers

import ros_cdk_pai
ros_cdk_pai.Run(
  scope: Construct,
  id: str,
  experiment_id: typing.Union[str, IResolvable],
  run_name: typing.Union[str, IResolvable] = None,
  source_id: typing.Union[str, IResolvable] = None,
  source_type: 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.
experiment_id	typing.Union[str, ros_cdk_core.IResolvable]	Property experimentId: Resource attribute field of the experiment ID to which Run belongs.
run_name	typing.Union[str, ros_cdk_core.IResolvable]	Property runName: The name of the Run.
source_id	typing.Union[str, ros_cdk_core.IResolvable]	Property sourceId: Attribute Resource field representing the source task ID.
source_type	typing.Union[str, ros_cdk_core.IResolvable]	Property sourceType: Resource attribute fields representing the source type.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

experiment_id^Required

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

Property experimentId: Resource attribute field of the experiment ID to which Run belongs.

---

run_name^Optional

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

Property runName: The name of the Run.

---

source_id^Optional

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

Property sourceId: Attribute Resource field representing the source task ID.

---

source_type^Optional

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

Property sourceType: Resource attribute fields representing the source type.

---

enable_resource_property_constraint^Optional

• 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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

import ros_cdk_pai
ros_cdk_pai.Run.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_accessibility	ros_cdk_core.IResolvable	Attribute Accessibility: Resource attribute fields representing visibility.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The creation time of the Run.
attr_experiment_id	ros_cdk_core.IResolvable	Attribute ExperimentId: Resource attribute field of the experiment ID to which Run belongs.
attr_gmt_modified_time	ros_cdk_core.IResolvable	Attribute GmtModifiedTime: Resource attribute fields representing edit time.
attr_labels	ros_cdk_core.IResolvable	Attribute Labels: Run attribute field representing the run tag.
attr_metrics	ros_cdk_core.IResolvable	Attribute Metrics: Resource attribute field representing the run metric.
attr_owner_id	ros_cdk_core.IResolvable	Attribute OwnerId: Resource attribute field representing owner.
attr_params	ros_cdk_core.IResolvable	Attribute Params: Resource attribute field representing the run parameter.
attr_run_id	ros_cdk_core.IResolvable	Attribute RunId: The ID of the Run.
attr_run_name	ros_cdk_core.IResolvable	Attribute RunName: The name of the Run.
attr_source_id	ros_cdk_core.IResolvable	Attribute SourceId: Attribute Resource field representing the source task ID.
attr_source_type	ros_cdk_core.IResolvable	Attribute SourceType: Run attribute fields representing the source type.
attr_user_id	ros_cdk_core.IResolvable	Attribute UserId: Run attribute field representing creator ID.
attr_workspace_id	ros_cdk_core.IResolvable	Attribute WorkspaceId: Resource attribute field of the workspace ID to which Run belongs.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_accessibility^Required

attr_accessibility: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Accessibility: Resource attribute fields representing visibility.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time of the Run.

---

attr_experiment_id^Required

attr_experiment_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ExperimentId: Resource attribute field of the experiment ID to which Run belongs.

---

attr_gmt_modified_time^Required

attr_gmt_modified_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute GmtModifiedTime: Resource attribute fields representing edit time.

---

attr_labels^Required

attr_labels: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Labels: Run attribute field representing the run tag.

---

attr_metrics^Required

attr_metrics: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Metrics: Resource attribute field representing the run metric.

---

attr_owner_id^Required

attr_owner_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute OwnerId: Resource attribute field representing owner.

---

attr_params^Required

attr_params: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Params: Resource attribute field representing the run parameter.

---

attr_run_id^Required

attr_run_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RunId: The ID of the Run.

---

attr_run_name^Required

attr_run_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RunName: The name of the Run.

---

attr_source_id^Required

attr_source_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SourceId: Attribute Resource field representing the source task ID.

---

attr_source_type^Required

attr_source_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SourceType: Run attribute fields representing the source type.

---

attr_user_id^Required

attr_user_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute UserId: Run attribute field representing creator ID.

---

attr_workspace_id^Required

attr_workspace_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute WorkspaceId: Resource attribute field of the workspace ID to which Run belongs.

---