DescribeCommandsRequest (ecs20140526 5.4.5 API)

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

public class DescribeCommandsRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

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

static class DescribeCommandsRequest.DescribeCommandsRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`DescribeCommandsRequest.DescribeCommandsRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`commandId` The ID of the command.
`String`	`contentEncoding` The encoding mode of the `CommandContent` and `Output` values in the response.
`String`	`description` The description of the command.
`Boolean`	`latest` Specifies whether to query only the latest version of common commands when common commands are queried.
`Integer`	`maxResults` The maximum number of entries per page.
`String`	`name` The name of the command.
`String`	`nextToken` The pagination token that is used in the next request to retrieve a new page of results.
`String`	`ownerAccount`
`Long`	`ownerId`
`Long`	`pageNumber` The page number.
`Long`	`pageSize` The number of entries per page.
`String`	`provider` The provider of the common command.
`String`	`regionId` The region ID of the command.
`String`	`resourceGroupId` The ID of the resource group to which the command belongs.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`List<DescribeCommandsRequest.DescribeCommandsRequestTag>`	`tag` The list of tags.
`String`	`type` The type of the command.

构造器概要

构造器
构造器和说明

DescribeCommandsRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static DescribeCommandsRequest`	`build(Map<String,?> map)`
`String`	`getCommandId()`
`String`	`getContentEncoding()`
`String`	`getDescription()`
`Boolean`	`getLatest()`
`Integer`	`getMaxResults()`
`String`	`getName()`
`String`	`getNextToken()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`Long`	`getPageNumber()`
`Long`	`getPageSize()`
`String`	`getProvider()`
`String`	`getRegionId()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`List<DescribeCommandsRequest.DescribeCommandsRequestTag>`	`getTag()`
`String`	`getType()`
`DescribeCommandsRequest`	`setCommandId(String commandId)`
`DescribeCommandsRequest`	`setContentEncoding(String contentEncoding)`
`DescribeCommandsRequest`	`setDescription(String description)`
`DescribeCommandsRequest`	`setLatest(Boolean latest)`
`DescribeCommandsRequest`	`setMaxResults(Integer maxResults)`
`DescribeCommandsRequest`	`setName(String name)`
`DescribeCommandsRequest`	`setNextToken(String nextToken)`
`DescribeCommandsRequest`	`setOwnerAccount(String ownerAccount)`
`DescribeCommandsRequest`	`setOwnerId(Long ownerId)`
`DescribeCommandsRequest`	`setPageNumber(Long pageNumber)`
`DescribeCommandsRequest`	`setPageSize(Long pageSize)`
`DescribeCommandsRequest`	`setProvider(String provider)`
`DescribeCommandsRequest`	`setRegionId(String regionId)`
`DescribeCommandsRequest`	`setResourceGroupId(String resourceGroupId)`
`DescribeCommandsRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`DescribeCommandsRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`DescribeCommandsRequest`	`setTag(List<DescribeCommandsRequest.DescribeCommandsRequestTag> tag)`
`DescribeCommandsRequest`	`setType(String type)`

从类继承的方法 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

- 字段详细资料
  - commandId
```
@NameInMap(value="CommandId")
public String commandId
```
    The ID of the command.
    example:
    c-hz01272yr52****
  - contentEncoding
```
@NameInMap(value="ContentEncoding")
public String contentEncoding
```
    The encoding mode of the CommandContent and Output values in the response. Valid values:
    - PlainText: returns the original command content and command output.
    - Base64: returns the Base64-encoded command content and command output.
    Default value: Base64.
    example:
    PlainText
  - description
```
@NameInMap(value="Description")
public String description
```
    The description of the command.
    
    If you specify Provider, fuzzy search is supported by default.
    
    If you do not specify Provider, prefix-based fuzzy search is supported. For example, if you specify test*, all commands whose descriptions start with test are queried.
    example:
    testDescription
  - latest
```
@NameInMap(value="Latest")
public Boolean latest
```
    Specifies whether to query only the latest version of common commands when common commands are queried. This parameter does not affect the query for private commands.
    - true: queries only the latest version of common commands.
    - false: queries all versions of common commands.
    Default value: false.
    example:
    true
  - maxResults
```
@NameInMap(value="MaxResults")
public Integer maxResults
```
    The maximum number of entries per page.
    
    Valid values: 1 to 50.
    
    Default value: 10.
    example:
    10
  - name
```
@NameInMap(value="Name")
public String name
```
    The name of the command.
    
    If you specify Provider, fuzzy search is supported by default.
    
    If you do not specify Provider, prefix-based fuzzy search is supported. For example, if you specify command*, all commands whose names start with command are queried.
    example:
    testName
  - nextToken
```
@NameInMap(value="NextToken")
public String nextToken
```
    The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.
    example:
    AAAAAdDWBF2
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - pageNumber
```
@NameInMap(value="PageNumber")
public Long pageNumber
```
    The page number.
    
    Pages start from page 1.
    
    Default value: 1.
    example:
    1
  - pageSize
```
@NameInMap(value="PageSize")
public Long pageSize
```
    The number of entries per page.
    
    Valid values: 1 to 50.
    
    Default value: 10.
    example:
    10
  - provider
```
@NameInMap(value="Provider")
public String provider
```
    The provider of the common command. Take note of the following items:
    - If you do not specify this parameter, all the commands that you created are queried.
    - If you set this parameter to AlibabaCloud, all the common commands provided by Alibaba Cloud are queried.
    - If you set this parameter to a specific provider, all the common commands provided by the provider are queried. Examples:
      
      If you set Provider to AlibabaCloud.ECS.GuestOS, all the common commands provided by AlibabaCloud.ECS.GuestOS are queried.
      
      If you set Provider to AlibabaCloud.ECS.GuestOSDiagnose, all the common commands provided by AlibabaCloud.ECS.GuestOSDiagnose are queried.
    example:
    AlibabaCloud
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of 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 the command belongs.
    example:
    rg-123******
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - tag
```
@NameInMap(value="Tag")
public List<DescribeCommandsRequest.DescribeCommandsRequestTag> tag
```
    The list of tags.
  - type
```
@NameInMap(value="Type")
public String type
```
    The type of the command. Valid values:
    - RunBatScript: batch command, applicable to Windows instances
    - RunPowerShellScript: PowerShell command, applicable to Windows instances
    - RunShellScript: shell command, applicable to Linux instances
    example:
    RunShellScript
- 构造器详细资料
  - DescribeCommandsRequest
```
public DescribeCommandsRequest()
```
- 方法详细资料
  - build
```
public static DescribeCommandsRequest build(Map<String,?> map)
                                     throws Exception
```
    抛出:
    
    Exception
  - setCommandId
```
public DescribeCommandsRequest setCommandId(String commandId)
```
  - getCommandId
```
public String getCommandId()
```
  - setContentEncoding
```
public DescribeCommandsRequest setContentEncoding(String contentEncoding)
```
  - getContentEncoding
```
public String getContentEncoding()
```
  - setDescription
```
public DescribeCommandsRequest setDescription(String description)
```
  - getDescription
```
public String getDescription()
```
  - setLatest
```
public DescribeCommandsRequest setLatest(Boolean latest)
```
  - getLatest
```
public Boolean getLatest()
```
  - setMaxResults
```
public DescribeCommandsRequest setMaxResults(Integer maxResults)
```
  - getMaxResults
```
public Integer getMaxResults()
```
  - setName
```
public DescribeCommandsRequest setName(String name)
```
  - getName
```
public String getName()
```
  - setNextToken
```
public DescribeCommandsRequest setNextToken(String nextToken)
```
  - getNextToken
```
public String getNextToken()
```
  - setOwnerAccount
```
public DescribeCommandsRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public DescribeCommandsRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setPageNumber
```
public DescribeCommandsRequest setPageNumber(Long pageNumber)
```
  - getPageNumber
```
public Long getPageNumber()
```
  - setPageSize
```
public DescribeCommandsRequest setPageSize(Long pageSize)
```
  - getPageSize
```
public Long getPageSize()
```
  - setProvider
```
public DescribeCommandsRequest setProvider(String provider)
```
  - getProvider
```
public String getProvider()
```
  - setRegionId
```
public DescribeCommandsRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceGroupId
```
public DescribeCommandsRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public DescribeCommandsRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public DescribeCommandsRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setTag
```
public DescribeCommandsRequest setTag(List<DescribeCommandsRequest.DescribeCommandsRequestTag> tag)
```
  - getTag
```
public List<DescribeCommandsRequest.DescribeCommandsRequestTag> getTag()
```
  - setType
```
public DescribeCommandsRequest setType(String type)
```
  - getType
```
public String getType()
```

类 DescribeCommandsRequest

嵌套类概要

字段概要

构造器概要

方法概要

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

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

字段详细资料

commandId

contentEncoding

description

latest

maxResults

name

nextToken

ownerAccount

ownerId

pageNumber

pageSize

provider

regionId

resourceGroupId

resourceOwnerAccount

resourceOwnerId

tag

type

构造器详细资料

DescribeCommandsRequest

方法详细资料

build

setCommandId

getCommandId

setContentEncoding

getContentEncoding

setDescription

getDescription

setLatest

getLatest

setMaxResults

getMaxResults

setName

getName

setNextToken

getNextToken

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setPageNumber

getPageNumber

setPageSize

getPageSize

setProvider

getProvider

setRegionId

getRegionId

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setTag

getTag

setType

getType