com.tencentcloudapi.tat.v20201028.models

Class InvokeCommandRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tat.v20201028.models.InvokeCommandRequest

public class InvokeCommandRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
InvokeCommandRequest()
InvokeCommandRequest(InvokeCommandRequest 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	getCommandId() Get ID of the command to be triggered.
String[]	getInstanceIds() Get IDs of instances about to execute commands.
String	getOutputCOSBucketUrl() Get The COS bucket URL for uploading logs.
String	getOutputCOSKeyPrefix() Get The COS bucket directory where the logs are saved.
String	getParameters() Get Custom parameters of the command.
Long	getTimeout() Get Command timeout period.
String	getUsername() Get The username used to execute the command on the CVM or Lighthouse instance.
String	getWorkingDirectory() Get Execution path of the command.
void	setCommandId(String CommandId) Set ID of the command to be triggered.
void	setInstanceIds(String[] InstanceIds) Set IDs of instances about to execute commands.
void	setOutputCOSBucketUrl(String OutputCOSBucketUrl) Set The COS bucket URL for uploading logs.
void	setOutputCOSKeyPrefix(String OutputCOSKeyPrefix) Set The COS bucket directory where the logs are saved.
void	setParameters(String Parameters) Set Custom parameters of the command.
void	setTimeout(Long Timeout) Set Command timeout period.
void	setUsername(String Username) Set The username used to execute the command on the CVM or Lighthouse instance.
void	setWorkingDirectory(String WorkingDirectory) Set Execution path of the command.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

InvokeCommandRequest

public InvokeCommandRequest()

InvokeCommandRequest

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

getCommandId

public String getCommandId()

Get ID of the command to be triggered.

Returns:

CommandId ID of the command to be triggered.

setCommandId

public void setCommandId(String CommandId)

Set ID of the command to be triggered.

Parameters:

CommandId - ID of the command to be triggered.

getInstanceIds

public String[] getInstanceIds()

Get IDs of instances about to execute commands. At most 100 IDs are allowed.

Returns:

InstanceIds IDs of instances about to execute commands. At most 100 IDs are allowed.

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set IDs of instances about to execute commands. At most 100 IDs are allowed.

Parameters:

InstanceIds - IDs of instances about to execute commands. At most 100 IDs are allowed.

getParameters

public String getParameters()

Get Custom parameters of the command. The field type is JSON encoded string. For example, {\"varA\": \"222\"}. `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings. If no parameter value is provided, the DefaultParameters of the command is used. Up to 20 custom parameters are supported. The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].

Returns:

Parameters Custom parameters of the command. The field type is JSON encoded string. For example, {\"varA\": \"222\"}. `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings. If no parameter value is provided, the DefaultParameters of the command is used. Up to 20 custom parameters are supported. The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].

setParameters

public void setParameters(String Parameters)

Set Custom parameters of the command. The field type is JSON encoded string. For example, {\"varA\": \"222\"}. `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings. If no parameter value is provided, the DefaultParameters of the command is used. Up to 20 custom parameters are supported. The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].

Parameters:

Parameters - Custom parameters of the command. The field type is JSON encoded string. For example, {\"varA\": \"222\"}. `key` is the name of the custom parameter and `value` is the default value. Both `key` and `value` are strings. If no parameter value is provided, the DefaultParameters of the command is used. Up to 20 custom parameters are supported. The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].

getUsername

public String getUsername()

Get The username used to execute the command on the CVM or Lighthouse instance. The principle of the least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. If this is not specified, the Username of the command is used by default.

Returns:

Username The username used to execute the command on the CVM or Lighthouse instance. The principle of the least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. If this is not specified, the Username of the command is used by default.

setUsername

public void setUsername(String Username)

Set The username used to execute the command on the CVM or Lighthouse instance. The principle of the least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. If this is not specified, the Username of the command is used by default.

Parameters:

Username - The username used to execute the command on the CVM or Lighthouse instance. The principle of the least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. If this is not specified, the Username of the command is used by default.

getWorkingDirectory

public String getWorkingDirectory()

Get Execution path of the command. The WorkingDirectory of the command is used by default.

Returns:

WorkingDirectory Execution path of the command. The WorkingDirectory of the command is used by default.

setWorkingDirectory

public void setWorkingDirectory(String WorkingDirectory)

Set Execution path of the command. The WorkingDirectory of the command is used by default.

Parameters:

WorkingDirectory - Execution path of the command. The WorkingDirectory of the command is used by default.

getTimeout

public Long getTimeout()

Get Command timeout period. Value range: [1, 86400]. The Timeout of the command is used by default.

Returns:

Timeout Command timeout period. Value range: [1, 86400]. The Timeout of the command is used by default.

setTimeout

public void setTimeout(Long Timeout)

Set Command timeout period. Value range: [1, 86400]. The Timeout of the command is used by default.

Parameters:

Timeout - Command timeout period. Value range: [1, 86400]. The Timeout of the command is used by default.

getOutputCOSBucketUrl

public String getOutputCOSBucketUrl()

Get The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.

Returns:

OutputCOSBucketUrl The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.

setOutputCOSBucketUrl

public void setOutputCOSBucketUrl(String OutputCOSBucketUrl)

Set The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.

Parameters:

OutputCOSBucketUrl - The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`.

getOutputCOSKeyPrefix

public String getOutputCOSKeyPrefix()

Get The COS bucket directory where the logs are saved. Check below for the rules of the directory name. 1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed. 2. Use a slash (/) to create a subdirectory. 3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.

Returns:

OutputCOSKeyPrefix The COS bucket directory where the logs are saved. Check below for the rules of the directory name. 1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed. 2. Use a slash (/) to create a subdirectory. 3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.

setOutputCOSKeyPrefix

public void setOutputCOSKeyPrefix(String OutputCOSKeyPrefix)

Set The COS bucket directory where the logs are saved. Check below for the rules of the directory name. 1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed. 2. Use a slash (/) to create a subdirectory. 3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.

Parameters:

OutputCOSKeyPrefix - The COS bucket directory where the logs are saved. Check below for the rules of the directory name. 1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed. 2. Use a slash (/) to create a subdirectory. 3. ".." can not be used as the folder name. It cannot start with a slash (/), and cannot contain consecutive slashes.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel