Skip to content

SubscriptionJob2

This class encapsulates and extends the ROS resource type ALIYUN::DTS::SubscriptionJob2, which is used to configure a change tracking task.

Initializers 

import com.aliyun.ros.cdk.dts.SubscriptionJob2;
SubscriptionJob2.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbList(IResolvable)
    .dbList(java.util.Map<java.lang.String, java.lang.Object>)
    .dtsJobName(java.lang.String)
    .dtsJobName(IResolvable)
    .sourceEndpoint(IResolvable)
    .sourceEndpoint(SourceEndpointProperty)
    .subscriptionInstance(IResolvable)
    .subscriptionInstance(SubscriptionInstanceProperty)
//  .checkpoint(java.lang.String)
//  .checkpoint(IResolvable)
//  .dedicatedClusterId(java.lang.String)
//  .dedicatedClusterId(IResolvable)
//  .delayNotice(java.lang.Boolean)
//  .delayNotice(IResolvable)
//  .delayPhone(java.lang.String)
//  .delayPhone(IResolvable)
//  .delayRuleTime(java.lang.Number)
//  .delayRuleTime(IResolvable)
//  .dtsBisLabel(java.lang.String)
//  .dtsBisLabel(IResolvable)
//  .dtsInstanceId(java.lang.String)
//  .dtsInstanceId(IResolvable)
//  .dtsJobId(java.lang.String)
//  .dtsJobId(IResolvable)
//  .errorNotice(java.lang.Boolean)
//  .errorNotice(IResolvable)
//  .errorPhone(java.lang.String)
//  .errorPhone(IResolvable)
//  .reserve(IResolvable)
//  .reserve(java.util.Map<java.lang.String, java.lang.Object>)
//  .status(java.lang.String)
//  .status(IResolvable)
//  .subscriptionDataType(IResolvable)
//  .subscriptionDataType(SubscriptionDataTypeProperty)
    .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.
dbList com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property dbList: The objects for which you want to track data changes.
dtsJobName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dtsJobName: The name of the DTS instance.
sourceEndpoint com.aliyun.ros.cdk.core.IResolvable OR SourceEndpointProperty Property sourceEndpoint: Source instance configuration.
subscriptionInstance com.aliyun.ros.cdk.core.IResolvable OR SubscriptionInstanceProperty Property subscriptionInstance: Subscription instance configuration.
checkpoint java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property checkpoint: The start offset of incremental data migration or synchronization.
dedicatedClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.
delayNotice java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property delayNotice: Specifies whether to monitor the task latency.
delayPhone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property delayPhone: The mobile numbers that receive latency-related alerts.
delayRuleTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property delayRuleTime: The threshold for latency alerts.
dtsBisLabel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dtsBisLabel: The environment tag of the DTS instance.
dtsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dtsInstanceId: The ID of the DTS instance.
dtsJobId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dtsJobId: The ID of the DTS task.
errorNotice java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property errorNotice: Specifies whether to monitor the task status.
errorPhone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property errorPhone: The mobile numbers that receive status-related alerts.
reserve com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property reserve: The reserved parameter of DTS.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The status of the resource.
subscriptionDataType com.aliyun.ros.cdk.core.IResolvable OR SubscriptionDataTypeProperty Property subscriptionDataType: Subscription data type.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbListRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property dbList: The objects for which you want to track data changes.

dtsJobNameRequired

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

Property dtsJobName: The name of the DTS instance.

sourceEndpointRequired

Property sourceEndpoint: Source instance configuration.

subscriptionInstanceRequired

Property subscriptionInstance: Subscription instance configuration.

checkpointOptional

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

Property checkpoint: The start offset of incremental data migration or synchronization.

This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

dedicatedClusterIdOptional

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

Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.

delayNoticeOptional

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

Property delayNotice: Specifies whether to monitor the task latency.

Valid values: true and false

delayPhoneOptional

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

Property delayPhone: The mobile numbers that receive latency-related alerts.

Separate multiple mobile numbers with commas (,). Note: This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console.

delayRuleTimeOptional

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

Property delayRuleTime: The threshold for latency alerts.

Unit: seconds. You can set the threshold based on your business requirements. To prevent jitters caused by network and database overloads, we recommend that you set the threshold to more than 10 seconds.

dtsBisLabelOptional

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

Property dtsBisLabel: The environment tag of the DTS instance.

Valid values: normal and online.

dtsInstanceIdOptional

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

Property dtsInstanceId: The ID of the DTS instance.

dtsJobIdOptional

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

Property dtsJobId: The ID of the DTS task.

errorNoticeOptional

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

Property errorNotice: Specifies whether to monitor the task status.

Valid values: true and false.

errorPhoneOptional

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

Property errorPhone: The mobile numbers that receive status-related alerts.

Separate multiple mobile numbers with commas (,). Note: This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console.

reserveOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property reserve: The reserved parameter of DTS.

You can specify this parameter to add more configurations of the source or destination instance to the DTS task. For example, you can specify the data storage format of the destination Kafka database and the ID of the CEN instance.

statusOptional

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

Property status: The status of the resource.

Valid values:

  • Subscribing: Start the task.
  • Suspending: Suspend the task.
  • Stopping: Stop the task.

subscriptionDataTypeOptional

Property subscriptionDataType: Subscription data type.

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

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.SubscriptionJob2;
SubscriptionJob2.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.
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.
attrDtsInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute DtsInstanceId: The ID of the DTS instance.
attrDtsJobId com.aliyun.ros.cdk.core.IResolvable Attribute DtsJobId: The ID of the task.
attrDtsJobName com.aliyun.ros.cdk.core.IResolvable Attribute DtsJobName: The name of the DTS job.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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

attrDtsInstanceIdRequired 

public IResolvable getAttrDtsInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DtsInstanceId: The ID of the DTS instance.

attrDtsJobIdRequired 

public IResolvable getAttrDtsJobId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DtsJobId: The ID of the task.

attrDtsJobNameRequired 

public IResolvable getAttrDtsJobName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DtsJobName: The name of the DTS job.