com.tencentcloudapi.tat.v20201028.models

Class CreateCommandRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tat.v20201028.models.CreateCommandRequest

public class CreateCommandRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateCommandRequest()
CreateCommandRequest(CreateCommandRequest 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	getCommandName() Get Command name.
String	getCommandType() Get Command type.
String	getContent() Get Base64-encoded command.
String	getDefaultParameters() Get The default value of the custom parameter value when it is enabled.
String	getDescription() Get Command description.
Boolean	getEnableParameter() Get Whether to enable the custom parameter feature.
String	getOutputCOSBucketUrl() Get The COS bucket URL for uploading logs.
String	getOutputCOSKeyPrefix() Get The COS bucket directory where the logs are saved.
Tag[]	getTags() Get Tags bound to 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 Command execution path.
void	setCommandName(String CommandName) Set Command name.
void	setCommandType(String CommandType) Set Command type.
void	setContent(String Content) Set Base64-encoded command.
void	setDefaultParameters(String DefaultParameters) Set The default value of the custom parameter value when it is enabled.
void	setDescription(String Description) Set Command description.
void	setEnableParameter(Boolean EnableParameter) Set Whether to enable the custom parameter feature.
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	setTags(Tag[] Tags) Set Tags bound to 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 Command execution path.
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

CreateCommandRequest

public CreateCommandRequest()

CreateCommandRequest

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

getCommandName

public String getCommandName()

Get Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].

Returns:

CommandName Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].

setCommandName

public void setCommandName(String CommandName)

Set Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].

Parameters:

CommandName - Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].

getContent

public String getContent()

Get Base64-encoded command. The maximum length is 64 KB.

Returns:

Content Base64-encoded command. The maximum length is 64 KB.

setContent

public void setContent(String Content)

Set Base64-encoded command. The maximum length is 64 KB.

Parameters:

Content - Base64-encoded command. The maximum length is 64 KB.

getDescription

public String getDescription()

Get Command description. The maximum length is 120 characters.

Returns:

Description Command description. The maximum length is 120 characters.

setDescription

public void setDescription(String Description)

Set Command description. The maximum length is 120 characters.

Parameters:

Description - Command description. The maximum length is 120 characters.

getCommandType

public String getCommandType()

Get Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`.

Returns:

CommandType Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`.

setCommandType

public void setCommandType(String CommandType)

Set Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`.

Parameters:

CommandType - Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`.

getWorkingDirectory

public String getWorkingDirectory()

Get Command execution path. The default value is /root for `SHELL` commands and C:\Program Files\qcloud\tat_agent\workdir for `POWERSHELL` commands.

Returns:

WorkingDirectory Command execution path. The default value is /root for `SHELL` commands and C:\Program Files\qcloud\tat_agent\workdir for `POWERSHELL` commands.

setWorkingDirectory

public void setWorkingDirectory(String WorkingDirectory)

Set Command execution path. The default value is /root for `SHELL` commands and C:\Program Files\qcloud\tat_agent\workdir for `POWERSHELL` commands.

Parameters:

WorkingDirectory - Command execution path. The default value is /root for `SHELL` commands and C:\Program Files\qcloud\tat_agent\workdir for `POWERSHELL` commands.

getTimeout

public Long getTimeout()

Get Command timeout period. Default value: 60 seconds. Value range: [1, 86400].

Returns:

Timeout Command timeout period. Default value: 60 seconds. Value range: [1, 86400].

setTimeout

public void setTimeout(Long Timeout)

Set Command timeout period. Default value: 60 seconds. Value range: [1, 86400].

Parameters:

Timeout - Command timeout period. Default value: 60 seconds. Value range: [1, 86400].

getEnableParameter

public Boolean getEnableParameter()

Get Whether to enable the custom parameter feature. This cannot be modified once created. Default value: `false`.

Returns:

EnableParameter Whether to enable the custom parameter feature. This cannot be modified once created. Default value: `false`.

setEnableParameter

public void setEnableParameter(Boolean EnableParameter)

Set Whether to enable the custom parameter feature. This cannot be modified once created. Default value: `false`.

Parameters:

EnableParameter - Whether to enable the custom parameter feature. This cannot be modified once created. Default value: `false`.

getDefaultParameters

public String getDefaultParameters()

Get The default value of the custom parameter value when it is enabled. 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 in the `InvokeCommand` API, the default value 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:

DefaultParameters The default value of the custom parameter value when it is enabled. 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 in the `InvokeCommand` API, the default value 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 [-_].

setDefaultParameters

public void setDefaultParameters(String DefaultParameters)

Set The default value of the custom parameter value when it is enabled. 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 in the `InvokeCommand` API, the default value 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:

DefaultParameters - The default value of the custom parameter value when it is enabled. 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 in the `InvokeCommand` API, the default value 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 [-_].

getTags

public Tag[] getTags()

Get Tags bound to the command. At most 10 tags are allowed.

Returns:

Tags Tags bound to the command. At most 10 tags are allowed.

setTags

public void setTags(Tag[] Tags)

Set Tags bound to the command. At most 10 tags are allowed.

Parameters:

Tags - Tags bound to the command. At most 10 tags are allowed.

getUsername

public String getUsername()

Get The username used to execute the command on the CVM or Lighthouse instance. The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.

Returns:

Username The username used to execute the command on the CVM or Lighthouse instance. The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.

setUsername

public void setUsername(String Username)

Set The username used to execute the command on the CVM or Lighthouse instance. The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.

Parameters:

Username - The username used to execute the command on the CVM or Lighthouse instance. The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.

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. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).

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. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).

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. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).

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. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel