com.tencentcloudapi.as.v20180419.models

Class UpgradeLifecycleHookRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.as.v20180419.models.UpgradeLifecycleHookRequest

public class UpgradeLifecycleHookRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
UpgradeLifecycleHookRequest()
UpgradeLifecycleHookRequest(UpgradeLifecycleHookRequest 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	getDefaultResult() Get Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure.
Long	getHeartbeatTimeout() Get The maximum length of time (in seconds) that can elapse before the lifecycle hook times out.
LifecycleCommand	getLifecycleCommand() Get Remote command execution object.
String	getLifecycleHookId() Get Lifecycle hook ID.
String	getLifecycleHookName() Get Lifecycle hook name, which can contain chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) with a maximum length of 128 characters.
String	getLifecycleTransition() Get Scenario for performing the lifecycle hook.
String	getLifecycleTransitionType() Get The scenario where the lifecycle hook is applied.
String	getNotificationMetadata() Get Additional information sent by auto scaling to notification targets, used when configuring a notification (default value: "").
NotificationTarget	getNotificationTarget() Get Notification result.
void	setDefaultResult(String DefaultResult) Set Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure.
void	setHeartbeatTimeout(Long HeartbeatTimeout) Set The maximum length of time (in seconds) that can elapse before the lifecycle hook times out.
void	setLifecycleCommand(LifecycleCommand LifecycleCommand) Set Remote command execution object.
void	setLifecycleHookId(String LifecycleHookId) Set Lifecycle hook ID.
void	setLifecycleHookName(String LifecycleHookName) Set Lifecycle hook name, which can contain chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) with a maximum length of 128 characters.
void	setLifecycleTransition(String LifecycleTransition) Set Scenario for performing the lifecycle hook.
void	setLifecycleTransitionType(String LifecycleTransitionType) Set The scenario where the lifecycle hook is applied.
void	setNotificationMetadata(String NotificationMetadata) Set Additional information sent by auto scaling to notification targets, used when configuring a notification (default value: "").
void	setNotificationTarget(NotificationTarget NotificationTarget) Set Notification result.
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

UpgradeLifecycleHookRequest

public UpgradeLifecycleHookRequest()

UpgradeLifecycleHookRequest

public UpgradeLifecycleHookRequest(UpgradeLifecycleHookRequest 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

getLifecycleHookId

public String getLifecycleHookId()

Get Lifecycle hook ID. you can call the api [DescribeLifecycleHooks](https://intl.cloud.tencent.com/document/api/377/34452?from_cn_redirect=1) and retrieve the LifecycleHookId from the returned information to obtain the lifecycle hook ID.

Returns:

LifecycleHookId Lifecycle hook ID. you can call the api [DescribeLifecycleHooks](https://intl.cloud.tencent.com/document/api/377/34452?from_cn_redirect=1) and retrieve the LifecycleHookId from the returned information to obtain the lifecycle hook ID.

setLifecycleHookId

public void setLifecycleHookId(String LifecycleHookId)

Set Lifecycle hook ID. you can call the api [DescribeLifecycleHooks](https://intl.cloud.tencent.com/document/api/377/34452?from_cn_redirect=1) and retrieve the LifecycleHookId from the returned information to obtain the lifecycle hook ID.

Parameters:

LifecycleHookId - Lifecycle hook ID. you can call the api [DescribeLifecycleHooks](https://intl.cloud.tencent.com/document/api/377/34452?from_cn_redirect=1) and retrieve the LifecycleHookId from the returned information to obtain the lifecycle hook ID.

getLifecycleHookName

public String getLifecycleHookName()

Get Lifecycle hook name, which can contain chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) with a maximum length of 128 characters.

Returns:

LifecycleHookName Lifecycle hook name, which can contain chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) with a maximum length of 128 characters.

setLifecycleHookName

public void setLifecycleHookName(String LifecycleHookName)

Set Lifecycle hook name, which can contain chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) with a maximum length of 128 characters.

Parameters:

LifecycleHookName - Lifecycle hook name, which can contain chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) with a maximum length of 128 characters.

getLifecycleTransition

public String getLifecycleTransition()

Get Scenario for performing the lifecycle hook. valid values:. `INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out. `INSTANCE_TERMINATING`: the lifecycle hook is being scaled in.

Returns:

LifecycleTransition Scenario for performing the lifecycle hook. valid values:. `INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out. `INSTANCE_TERMINATING`: the lifecycle hook is being scaled in.

setLifecycleTransition

public void setLifecycleTransition(String LifecycleTransition)

Set Scenario for performing the lifecycle hook. valid values:. `INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out. `INSTANCE_TERMINATING`: the lifecycle hook is being scaled in.

Parameters:

LifecycleTransition - Scenario for performing the lifecycle hook. valid values:. `INSTANCE_LAUNCHING`: the lifecycle hook is being scaled out. `INSTANCE_TERMINATING`: the lifecycle hook is being scaled in.

getDefaultResult

public String getDefaultResult()

Get Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values are as follows:. Default value, means CONTINUE to execute capacity expansion or reduction. ABANDON: for scale-out hooks, cvms that time out or fail to execute LifecycleCommand will be released directly or removed. for scale-in hooks, scale-in activities will continue.

Returns:

DefaultResult Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values are as follows:. Default value, means CONTINUE to execute capacity expansion or reduction. ABANDON: for scale-out hooks, cvms that time out or fail to execute LifecycleCommand will be released directly or removed. for scale-in hooks, scale-in activities will continue.

setDefaultResult

public void setDefaultResult(String DefaultResult)

Set Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values are as follows:. Default value, means CONTINUE to execute capacity expansion or reduction. ABANDON: for scale-out hooks, cvms that time out or fail to execute LifecycleCommand will be released directly or removed. for scale-in hooks, scale-in activities will continue.

Parameters:

DefaultResult - Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values are as follows:. Default value, means CONTINUE to execute capacity expansion or reduction. ABANDON: for scale-out hooks, cvms that time out or fail to execute LifecycleCommand will be released directly or removed. for scale-in hooks, scale-in activities will continue.

getHeartbeatTimeout

public Long getHeartbeatTimeout()

Get The maximum length of time (in seconds) that can elapse before the lifecycle hook times out. Value range: 30-7200. Default value: 300

Returns:

HeartbeatTimeout The maximum length of time (in seconds) that can elapse before the lifecycle hook times out. Value range: 30-7200. Default value: 300

setHeartbeatTimeout

public void setHeartbeatTimeout(Long HeartbeatTimeout)

Set The maximum length of time (in seconds) that can elapse before the lifecycle hook times out. Value range: 30-7200. Default value: 300

Parameters:

HeartbeatTimeout - The maximum length of time (in seconds) that can elapse before the lifecycle hook times out. Value range: 30-7200. Default value: 300

getNotificationMetadata

public String getNotificationMetadata()

Get Additional information sent by auto scaling to notification targets, used when configuring a notification (default value: ""). NotificationMetadata and LifecycleCommand are mutually exclusive parameters and cannot be specified simultaneously.

Returns:

NotificationMetadata Additional information sent by auto scaling to notification targets, used when configuring a notification (default value: ""). NotificationMetadata and LifecycleCommand are mutually exclusive parameters and cannot be specified simultaneously.

setNotificationMetadata

public void setNotificationMetadata(String NotificationMetadata)

Set Additional information sent by auto scaling to notification targets, used when configuring a notification (default value: ""). NotificationMetadata and LifecycleCommand are mutually exclusive parameters and cannot be specified simultaneously.

Parameters:

NotificationMetadata - Additional information sent by auto scaling to notification targets, used when configuring a notification (default value: ""). NotificationMetadata and LifecycleCommand are mutually exclusive parameters and cannot be specified simultaneously.

getNotificationTarget

public NotificationTarget getNotificationTarget()

Get Notification result. `NotificationTarget` and `LifecycleCommand` cannot be specified at the same time.

Returns:

NotificationTarget Notification result. `NotificationTarget` and `LifecycleCommand` cannot be specified at the same time.

setNotificationTarget

public void setNotificationTarget(NotificationTarget NotificationTarget)

Set Notification result. `NotificationTarget` and `LifecycleCommand` cannot be specified at the same time.

Parameters:

NotificationTarget - Notification result. `NotificationTarget` and `LifecycleCommand` cannot be specified at the same time.

getLifecycleTransitionType

public String getLifecycleTransitionType()

Get The scenario where the lifecycle hook is applied. `EXTENSION`: the lifecycle hook will be triggered when AttachInstances, DetachInstances or RemoveInstaces is called. `NORMAL`: the lifecycle hook is not triggered by the above APIs.

Returns:

LifecycleTransitionType The scenario where the lifecycle hook is applied. `EXTENSION`: the lifecycle hook will be triggered when AttachInstances, DetachInstances or RemoveInstaces is called. `NORMAL`: the lifecycle hook is not triggered by the above APIs.

setLifecycleTransitionType

public void setLifecycleTransitionType(String LifecycleTransitionType)

Set The scenario where the lifecycle hook is applied. `EXTENSION`: the lifecycle hook will be triggered when AttachInstances, DetachInstances or RemoveInstaces is called. `NORMAL`: the lifecycle hook is not triggered by the above APIs.

Parameters:

LifecycleTransitionType - The scenario where the lifecycle hook is applied. `EXTENSION`: the lifecycle hook will be triggered when AttachInstances, DetachInstances or RemoveInstaces is called. `NORMAL`: the lifecycle hook is not triggered by the above APIs.

getLifecycleCommand

public LifecycleCommand getLifecycleCommand()

Get Remote command execution object. `NotificationMetadata`, `NotificationTarget`, and `LifecycleCommand` are mutually exclusive and cannot be specified simultaneously.

Returns:

LifecycleCommand Remote command execution object. `NotificationMetadata`, `NotificationTarget`, and `LifecycleCommand` are mutually exclusive and cannot be specified simultaneously.

setLifecycleCommand

public void setLifecycleCommand(LifecycleCommand LifecycleCommand)

Set Remote command execution object. `NotificationMetadata`, `NotificationTarget`, and `LifecycleCommand` are mutually exclusive and cannot be specified simultaneously.

Parameters:

LifecycleCommand - Remote command execution object. `NotificationMetadata`, `NotificationTarget`, and `LifecycleCommand` are mutually exclusive and cannot be specified simultaneously.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.