Skip to content

AggTaskGroupProps

Properties for defining a AggTaskGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cms2-aggtaskgroup

Initializer

import com.aliyun.ros.cdk.cms2.AggTaskGroupProps;
AggTaskGroupProps.builder()
    .aggTaskGroupConfig(java.lang.String)
    .aggTaskGroupConfig(IResolvable)
    .aggTaskGroupName(java.lang.String)
    .aggTaskGroupName(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .targetPrometheusId(java.lang.String)
    .targetPrometheusId(IResolvable)
//  .aggTaskGroupConfigType(java.lang.String)
//  .aggTaskGroupConfigType(IResolvable)
//  .cronExpr(java.lang.String)
//  .cronExpr(IResolvable)
//  .delay(java.lang.Number)
//  .delay(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .fromTime(java.lang.Number)
//  .fromTime(IResolvable)
//  .maxRetries(java.lang.Number)
//  .maxRetries(IResolvable)
//  .maxRunTimeInSeconds(java.lang.Number)
//  .maxRunTimeInSeconds(IResolvable)
//  .overrideIfExists(java.lang.Boolean)
//  .overrideIfExists(IResolvable)
//  .precheckString(IResolvable)
//  .precheckString(java.util.Map<java.lang.String, java.lang.Object>)
//  .scheduleMode(java.lang.String)
//  .scheduleMode(IResolvable)
//  .scheduleTimeExpr(java.lang.String)
//  .scheduleTimeExpr(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .toTime(java.lang.Number)
//  .toTime(IResolvable)
    .build();

Properties

Name Type Description
aggTaskGroupConfig java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property aggTaskGroupConfig: The config of the agg task group.
aggTaskGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property aggTaskGroupName: The name of the agg task group.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the source Prometheus instance the agg task group reads data from.
targetPrometheusId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetPrometheusId: The ID of the target Prometheus instance of the agg task group.
aggTaskGroupConfigType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property aggTaskGroupConfigType: The config type of the agg task group.
cronExpr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cronExpr: The cron expression used when ScheduleMode is "Cron".
delay java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property delay: The fixed delay of the schedule, in seconds.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the agg task group.
fromTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property fromTime: The second-level timestamp corresponding to the schedule start time.
maxRetries java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxRetries: The maximum number of retries for executing the agg task.
maxRunTimeInSeconds java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxRunTimeInSeconds: The maximum retry time for executing the agg task, in seconds.
overrideIfExists java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property overrideIfExists: Whether to override and update an existing agg task group with the same name when creating.
precheckString com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property precheckString: The precheck config.
scheduleMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scheduleMode: The schedule mode, "Cron" or "FixedRate".
scheduleTimeExpr java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scheduleTimeExpr: The schedule time expression, "@s" or "@m" is recommended, indicating the rounding granularity of the schedule time window.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The status of the agg task group, "Running" or "Stopped".
tags java.util.List<TagsProperty> Property tags: The tags of the agg task group.
toTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property toTime: The second-level timestamp corresponding to the schedule end time.

aggTaskGroupConfigRequired

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

Property aggTaskGroupConfig: The config of the agg task group.

Only "RecordingRuleYaml" format is supported, which must conform to the RecordingRule format of the open source Prometheus.


aggTaskGroupNameRequired

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

Property aggTaskGroupName: The name of the agg task group.


instanceIdRequired

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

Property instanceId: The ID of the source Prometheus instance the agg task group reads data from.


targetPrometheusIdRequired

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

Property targetPrometheusId: The ID of the target Prometheus instance of the agg task group.


aggTaskGroupConfigTypeOptional

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

Property aggTaskGroupConfigType: The config type of the agg task group.

Default: "RecordingRuleYaml".


cronExprOptional

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

Property cronExpr: The cron expression used when ScheduleMode is "Cron".

For example, "0/1 * * * *" means scheduling every 1 minute starting from minute 0.


delayOptional

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

Property delay: The fixed delay of the schedule, in seconds.

Default: 30.


descriptionOptional

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

Property description: The description of the agg task group.


fromTimeOptional

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

Property fromTime: The second-level timestamp corresponding to the schedule start time.


maxRetriesOptional

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

Property maxRetries: The maximum number of retries for executing the agg task.

Default: 20.


maxRunTimeInSecondsOptional

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

Property maxRunTimeInSeconds: The maximum retry time for executing the agg task, in seconds.

Default: 600.


overrideIfExistsOptional

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

Property overrideIfExists: Whether to override and update an existing agg task group with the same name when creating.

Create-only, cannot be updated.


precheckStringOptional

public java.lang.Object getPrecheckString();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property precheckString: The precheck config.

Not configured by default.


scheduleModeOptional

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

Property scheduleMode: The schedule mode, "Cron" or "FixedRate".

Default: "FixedRate".


scheduleTimeExprOptional

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

Property scheduleTimeExpr: The schedule time expression, "@s" or "@m" is recommended, indicating the rounding granularity of the schedule time window.

Default: "@m".


statusOptional

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

Property status: The status of the agg task group, "Running" or "Stopped".

Default: Running.


tagsOptional

public java.util.List<TagsProperty> getTags();

Property tags: The tags of the agg task group.


toTimeOptional

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

Property toTime: The second-level timestamp corresponding to the schedule end time.

0 means the schedule never stops.