Skip to content

JobMonitorRule

  • Implements: com.aliyun.ros.cdk.dts.datasource.IJobMonitorRule

This class encapsulates and extends the ROS resource type DATASOURCE::DTS::JobMonitorRule.

Initializers

import com.aliyun.ros.cdk.dts.datasource.JobMonitorRule;
JobMonitorRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dtsJobId(java.lang.String)
    .dtsJobId(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.
dtsJobId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dtsJobId: The ID of the data migration, data synchronization, or change tracking 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

dtsJobIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dtsJobId: The ID of the data migration, data synchronization, or change tracking 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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

import com.aliyun.ros.cdk.dts.datasource.JobMonitorRule;
JobMonitorRule.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • 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.
attrDelayRuleTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DelayRuleTime: The threshold that triggers the alert.
attrDtsJobId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DtsJobId: The ID of the data migration, data synchronization, or change tracking task.
attrPeriod java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Period: The statistical period for incremental validation tasks, in minutes.
attrPhone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Phone: The mobile phone numbers that receive alert notifications.
attrState java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute State: Indicates whether the monitoring rule is enabled.
attrTimes java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Times: The number of cycles for the incremental validation task.
attrType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Type: The type of the monitoring rule.
props JobMonitorRuleProps 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

attrDelayRuleTimeRequired

public java.lang.Object getAttrDelayRuleTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DelayRuleTime: The threshold that triggers the alert.


attrDtsJobIdRequired

public java.lang.Object getAttrDtsJobId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DtsJobId: The ID of the data migration, data synchronization, or change tracking task.


attrPeriodRequired

public java.lang.Object getAttrPeriod();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Period: The statistical period for incremental validation tasks, in minutes.


attrPhoneRequired

public java.lang.Object getAttrPhone();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Phone: The mobile phone numbers that receive alert notifications.

Multiple mobile numbers are separated by commas (,).


attrStateRequired

public java.lang.Object getAttrState();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute State: Indicates whether the monitoring rule is enabled.


attrTimesRequired

public java.lang.Object getAttrTimes();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Times: The number of cycles for the incremental validation task.


attrTypeRequired

public java.lang.Object getAttrType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Type: The type of the monitoring rule.


propsRequired

public JobMonitorRuleProps getProps();