com.tencentcloudapi.as.v20180419.models

Class CreateLifecycleHookRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.as.v20180419.models.CreateLifecycleHookRequest

public class CreateLifecycleHookRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateLifecycleHookRequest()
CreateLifecycleHookRequest(CreateLifecycleHookRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getAutoScalingGroupId() Get 伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
String	getDefaultResult() Get 定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作，取值范围如下： CONTINUE: 默认值，表示继续执行扩缩容活动 ABANDON: 针对扩容挂钩，挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出；而针对缩容挂钩，会继续执行缩容活动。
Long	getHeartbeatTimeout() Get 生命周期挂钩超时之前可以经过的最长时间（以秒为单位），范围从30到7200秒，默认值为300秒
LifecycleCommand	getLifecycleCommand() Get 远程命令执行对象。通知相关参数（NotificationTarget、NotificationMetadata）与该参数互斥，二者不可同时指定。
String	getLifecycleHookName() Get 生命周期挂钩名称。名称仅支持中文、英文、数字、下划线（_）、短横线（-）、小数点（.），最大长度不能超128个字节。
String	getLifecycleTransition() Get 进行生命周期挂钩的场景，取值范围如下: INSTANCE_LAUNCHING: 扩容生命周期挂钩 INSTANCE_TERMINATING: 缩容生命周期挂钩
String	getLifecycleTransitionType() Get 进行生命周期挂钩的场景类型，取值范围包括 NORMAL 和 EXTENSION，默认值为 NORMAL。 说明：设置为EXTENSION值，在 [AttachInstances](https://cloud.tencent.com/document/api/377/20441)、[DetachInstances](https://cloud.tencent.com/document/api/377/20436)、[RemoveInstaces](https://cloud.tencent.com/document/api/377/20431)、[StopAutoScalingInstances](https://cloud.tencent.com/document/api/377/40286)、[StartAutoScalingInstances](https://cloud.tencent.com/document/api/377/40287)、[StartInstanceRefresh](https://cloud.tencent.com/document/api/377/99172) 接口时会触发生命周期挂钩操作，值为NORMAL则不会在这些接口中触发生命周期挂钩。
String	getNotificationMetadata() Get 弹性伸缩向通知目标发送的附加信息，配置通知时使用，默认值为空字符串，最长不超过 1024 字符。NotificationMetadata 和 LifecycleCommand参数互斥，二者不可同时指定。
NotificationTarget	getNotificationTarget() Get 通知目标。NotificationTarget和LifecycleCommand参数互斥，二者不可同时指定。
void	setAutoScalingGroupId(String AutoScalingGroupId) Set 伸缩组ID。可以通过如下方式获取可用的伸缩组ID: 通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。
void	setDefaultResult(String DefaultResult) Set 定义伸缩组在生命周期挂钩超时或 LifecycleCommand 执行失败时应采取的操作，取值范围如下： CONTINUE: 默认值，表示继续执行扩缩容活动 ABANDON: 针对扩容挂钩，挂钩超时或 LifecycleCommand 执行失败的 CVM 实例会直接释放或移出；而针对缩容挂钩，会继续执行缩容活动。
void	setHeartbeatTimeout(Long HeartbeatTimeout) Set 生命周期挂钩超时之前可以经过的最长时间（以秒为单位），范围从30到7200秒，默认值为300秒
void	setLifecycleCommand(LifecycleCommand LifecycleCommand) Set 远程命令执行对象。通知相关参数（NotificationTarget、NotificationMetadata）与该参数互斥，二者不可同时指定。
void	setLifecycleHookName(String LifecycleHookName) Set 生命周期挂钩名称。名称仅支持中文、英文、数字、下划线（_）、短横线（-）、小数点（.），最大长度不能超128个字节。
void	setLifecycleTransition(String LifecycleTransition) Set 进行生命周期挂钩的场景，取值范围如下: INSTANCE_LAUNCHING: 扩容生命周期挂钩 INSTANCE_TERMINATING: 缩容生命周期挂钩
void	setLifecycleTransitionType(String LifecycleTransitionType) Set 进行生命周期挂钩的场景类型，取值范围包括 NORMAL 和 EXTENSION，默认值为 NORMAL。 说明：设置为EXTENSION值，在 [AttachInstances](https://cloud.tencent.com/document/api/377/20441)、[DetachInstances](https://cloud.tencent.com/document/api/377/20436)、[RemoveInstaces](https://cloud.tencent.com/document/api/377/20431)、[StopAutoScalingInstances](https://cloud.tencent.com/document/api/377/40286)、[StartAutoScalingInstances](https://cloud.tencent.com/document/api/377/40287)、[StartInstanceRefresh](https://cloud.tencent.com/document/api/377/99172) 接口时会触发生命周期挂钩操作，值为NORMAL则不会在这些接口中触发生命周期挂钩。
void	setNotificationMetadata(String NotificationMetadata) Set 弹性伸缩向通知目标发送的附加信息，配置通知时使用，默认值为空字符串，最长不超过 1024 字符。NotificationMetadata 和 LifecycleCommand参数互斥，二者不可同时指定。
void	setNotificationTarget(NotificationTarget NotificationTarget) Set 通知目标。NotificationTarget和LifecycleCommand参数互斥，二者不可同时指定。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateLifecycleHookRequest

public CreateLifecycleHookRequest()

CreateLifecycleHookRequest

public CreateLifecycleHookRequest(CreateLifecycleHookRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getAutoScalingGroupId

public String getAutoScalingGroupId()

Get 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:

通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。

Returns:

AutoScalingGroupId 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:

通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。

通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。

setAutoScalingGroupId

public void setAutoScalingGroupId(String AutoScalingGroupId)

Set 伸缩组ID。可以通过如下方式获取可用的伸缩组ID:

通过登录 [控制台](https://console.cloud.tencent.com/autoscaling/group) 查询伸缩组ID。 通过调用接口 [DescribeAutoScalingGroups](https://cloud.tencent.com/document/api/377/20438) ，取返回信息中的 AutoScalingGroupId 获取伸缩组ID。