SyntheticTask
- Implements: com.aliyun.ros.cdk.arms.datasource.ISyntheticTask
This class encapsulates and extends the ROS resource type DATASOURCE::ARMS::SyntheticTask, which is used to query the information about a scheduled synthetic monitoring task.
Initializers
import com.aliyun.ros.cdk.arms.datasource.SyntheticTask;
SyntheticTask.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.taskId(java.lang.String)
.taskId(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(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. |
taskId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property taskId: The ID of the synthetic monitoring task. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
taskIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property taskId: The ID of the synthetic monitoring task.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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.arms.datasource.SyntheticTask;
SyntheticTask.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. |
attrAvailableAssertions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AvailableAssertions: The list of assertions. |
attrCommonSetting | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CommonSetting: The general settings. |
attrCustomPeriod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CustomPeriod: The custom cycle. |
attrFrequency | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Frequency: The detection frequency. |
attrMonitorCategory | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MonitorCategory: The detection point type. |
attrMonitorConf | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MonitorConf: The monitoring configurations. |
attrMonitors | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Monitors: The list of monitoring points. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrSyntheticTaskName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SyntheticTaskName: The name of synthetic task. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tags of the instance. |
attrTaskId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TaskId: The ID of the synthetic monitoring task. |
attrTaskType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TaskType: The type of the task. |
props | SyntheticTaskProps | 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
attrAvailableAssertionsRequired
public java.lang.Object getAttrAvailableAssertions();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AvailableAssertions: The list of assertions.
attrCommonSettingRequired
public java.lang.Object getAttrCommonSetting();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CommonSetting: The general settings.
attrCustomPeriodRequired
public java.lang.Object getAttrCustomPeriod();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CustomPeriod: The custom cycle.
attrFrequencyRequired
public java.lang.Object getAttrFrequency();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Frequency: The detection frequency.
attrMonitorCategoryRequired
public java.lang.Object getAttrMonitorCategory();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MonitorCategory: The detection point type.
1: PC. 2: mobile device.
attrMonitorConfRequired
public java.lang.Object getAttrMonitorConf();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MonitorConf: The monitoring configurations.
attrMonitorsRequired
public java.lang.Object getAttrMonitors();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Monitors: The list of monitoring points.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrSyntheticTaskNameRequired
public java.lang.Object getAttrSyntheticTaskName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SyntheticTaskName: The name of synthetic task.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags of the instance.
attrTaskIdRequired
public java.lang.Object getAttrTaskId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TaskId: The ID of the synthetic monitoring task.
attrTaskTypeRequired
public java.lang.Object getAttrTaskType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TaskType: The type of the task.
propsRequired
public SyntheticTaskProps getProps();
- Type: SyntheticTaskProps