CreateCommandRequest (ecs20140526 5.4.5 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.ecs20140526.models.CreateCommandRequest

public class CreateCommandRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

嵌套类
限定符和类型类和说明

static class CreateCommandRequest.CreateCommandRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`CreateCommandRequest.CreateCommandRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`commandContent` The Base64-encoded content of the command.
`String`	`contentEncoding` The encoding mode of the command content (CommandContent).
`String`	`description` The description of the command.
`Boolean`	`enableParameter` Specifies whether to use custom parameters in the command.
`String`	`launcher`
`String`	`name` The name of the command.
`String`	`ownerAccount`
`Long`	`ownerId`
`String`	`regionId` The ID of the region in which to create the command.
`String`	`resourceGroupId` The ID of the resource group to which to assign the command.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`List<CreateCommandRequest.CreateCommandRequestTag>`	`tag` The tags to add to the command.
`Long`	`timeout` he maximum timeout period for the command execution on the instance.
`String`	`type` The command type.
`String`	`workingDir` The execution path of the command on ECS instances.

构造器概要

构造器
构造器和说明

CreateCommandRequest()

构造器
构造器和说明
`CreateCommandRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CreateCommandRequest`	`build(Map<String,?> map)`
`String`	`getCommandContent()`
`String`	`getContentEncoding()`
`String`	`getDescription()`
`Boolean`	`getEnableParameter()`
`String`	`getLauncher()`
`String`	`getName()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`List<CreateCommandRequest.CreateCommandRequestTag>`	`getTag()`
`Long`	`getTimeout()`
`String`	`getType()`
`String`	`getWorkingDir()`
`CreateCommandRequest`	`setCommandContent(String commandContent)`
`CreateCommandRequest`	`setContentEncoding(String contentEncoding)`
`CreateCommandRequest`	`setDescription(String description)`
`CreateCommandRequest`	`setEnableParameter(Boolean enableParameter)`
`CreateCommandRequest`	`setLauncher(String launcher)`
`CreateCommandRequest`	`setName(String name)`
`CreateCommandRequest`	`setOwnerAccount(String ownerAccount)`
`CreateCommandRequest`	`setOwnerId(Long ownerId)`
`CreateCommandRequest`	`setRegionId(String regionId)`
`CreateCommandRequest`	`setResourceGroupId(String resourceGroupId)`
`CreateCommandRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`CreateCommandRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`CreateCommandRequest`	`setTag(List<CreateCommandRequest.CreateCommandRequestTag> tag)`
`CreateCommandRequest`	`setTimeout(Long timeout)`
`CreateCommandRequest`	`setType(String type)`
`CreateCommandRequest`	`setWorkingDir(String workingDir)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - commandContent
```
@NameInMap(value="CommandContent")
public String commandContent
```
    The Base64-encoded content of the command. Take note of the following items:
    - The value must be Base64-encoded and cannot exceed 18 KB in size.
    - You can use custom parameters in the command content. To enable the custom parameter feature, you must set EnableParameter to true.
      
      Custom parameters are defined in the {{}} format. Within {{}}, the spaces and line feeds before and after the parameter names are ignored.
      
      You can specify up to 20 custom parameters.
      
      A custom parameter name can contain only letters, digits, underscores (_), and hyphens (-). The name is case-insensitive. The ACS:: prefix cannot be used to specify non-built-in environment parameters.
      
      Each custom parameter name can be up to 64 bytes in length.
    - You can specify built-in environment parameters as custom parameters in a command. When you run the command, Cloud Assistant automatically uses the environment parameter values for the custom parameters. You can specify the following built-in environment variables:
      
      {{ACS::RegionId}}: the region ID.
      
      {{ACS::AccountId}}: the UID of the Alibaba Cloud account.
      
      {{ACS::InstanceId}}: the instance ID. If you want to run the command on multiple instances and specify {{ACS::InstanceId}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than the following versions:
      
      Linux: 2.2.3.309
      
      Windows: 2.1.3.309
      
      {{ACS::InstanceName}}: the instance name. If you want to run the command on multiple instances and specify {{ACS::InstanceName}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than the following versions:
      
      Linux: 2.2.3.344
      
      Windows: 2.1.3.344
      
      {{ACS::InvokeId}}: the ID of the task. If you want to specify {{ACS::InvokeId}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than the following versions:
      
      Linux: 2.2.3.309
      
      Windows: 2.1.3.309
      
      {{ACS::CommandId}}: the command ID. If you want to call the RunCommand operation to run the command and specify {{ACS::CommandId}} as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than the following versions:
      
      Linux: 2.2.3.309
      
      Windows: 2.1.3.309
    This parameter is required.
    example:
    ZWNobyAxMjM=
  - contentEncoding
```
@NameInMap(value="ContentEncoding")
public String contentEncoding
```
    The encoding mode of the command content (CommandContent). Valid values:
    - PlainText: The command content is not encoded.
    - Base64: The command content is Base64-encoded.
    Default value: Base64.
    
    If the specified value of this parameter is invalid, Base64 is used by default.
    
    example:
    PlainText
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the command. The description supports all character sets and can be up to 512 characters in length.
    example:
    testDescription
  - enableParameter
```
@NameInMap(value="EnableParameter")
public Boolean enableParameter
```
    Specifies whether to use custom parameters in the command.
    
    Default value: false.
    example:
    false
  - launcher
```
@NameInMap(value="Launcher")
public String launcher
```
  - name
```
@NameInMap(value="Name")
public String name
```
    The name of the command. The name supports all character sets and can be up to 128 characters in length.
    
    This parameter is required.
    example:
    testName
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The ID of the region in which to create the command. You can call the DescribeRegions operation to query the most recent region list.
    
    This parameter is required.
    example:
    cn-hangzhou
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group to which to assign the command.
    example:
    rg-123******
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - tag
```
@NameInMap(value="Tag")
public List<CreateCommandRequest.CreateCommandRequestTag> tag
```
    The tags to add to the command.
  - timeout
```
@NameInMap(value="Timeout")
public Long timeout
```
    he maximum timeout period for the command execution on the instance. Unit: seconds. When a command that you created cannot be run, the command times out. When a command execution times out, Cloud Assistant Agent forcefully terminates the command process by canceling the PID.
    
    Default value: 60.
    example:
    60
  - type
```
@NameInMap(value="Type")
public String type
```
    The command type. Valid values:
    - RunBatScript: batch commands. These commands are applicable to Windows instances.
    - RunPowerShellScript: PowerShell commands. These commands are applicable to Windows instances.
    - RunShellScript: shell commands. These commands are applicable to Linux instances.
    This parameter is required.
    example:
    RunShellScript
  - workingDir
```
@NameInMap(value="WorkingDir")
public String workingDir
```
    The execution path of the command on ECS instances. The value can be up to 200 characters in length.
    
    Default values:
    - For Linux instance, the default value is the home directory of the root user, which is the /root directory.
    - For Windows instances, the default value is the directory where the Cloud Assistant Agent process resides, such as C:\\Windows\\System32\\.
    If you set WorkingDir to a directory other than default ones, make sure that the directory exists on the instances.
    
    example:
    /root/
- 构造器详细资料
  - CreateCommandRequest
```
public CreateCommandRequest()
```
- 方法详细资料
  - build
```
public static CreateCommandRequest build(Map<String,?> map)
                                  throws Exception
```
    抛出:
    
    Exception
  - setCommandContent
```
public CreateCommandRequest setCommandContent(String commandContent)
```
  - getCommandContent
```
public String getCommandContent()
```
  - setContentEncoding
```
public CreateCommandRequest setContentEncoding(String contentEncoding)
```
  - getContentEncoding
```
public String getContentEncoding()
```
  - setDescription
```
public CreateCommandRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setEnableParameter
```
public CreateCommandRequest setEnableParameter(Boolean enableParameter)
```
  - getEnableParameter
```
public Boolean getEnableParameter()
```
  - setLauncher
```
public CreateCommandRequest setLauncher(String launcher)
```
  - getLauncher
```
public String getLauncher()
```
  - setName
```
public CreateCommandRequest setName(String name)
```
  - getName
```
public String getName()
```
  - setOwnerAccount
```
public CreateCommandRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public CreateCommandRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setRegionId
```
public CreateCommandRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public CreateCommandRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public CreateCommandRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public CreateCommandRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setTag
```
public CreateCommandRequest setTag(List<CreateCommandRequest.CreateCommandRequestTag> tag)
```
  - getTag
```
public List<CreateCommandRequest.CreateCommandRequestTag> getTag()
```
  - setTimeout
```
public CreateCommandRequest setTimeout(Long timeout)
```
  - getTimeout
```
public Long getTimeout()
```
  - setType
```
public CreateCommandRequest setType(String type)
```
  - getType
```
public String getType()
```
  - setWorkingDir
```
public CreateCommandRequest setWorkingDir(String workingDir)
```
  - getWorkingDir
```
public String getWorkingDir()
```

类 CreateCommandRequest

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

commandContent

contentEncoding

description

enableParameter

launcher

name

ownerAccount

ownerId

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

tag

timeout

type

workingDir

构造器详细资料

CreateCommandRequest

方法详细资料

build

setCommandContent

getCommandContent

setContentEncoding

getContentEncoding

setDescription

getDescription

setEnableParameter

getEnableParameter

setLauncher

getLauncher

setName

getName

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setTag

getTag

setTimeout

getTimeout

setType

getType

setWorkingDir

getWorkingDir