DescribeInvocationsRequest (ecs20140526 3.1.10 API)

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

public class DescribeInvocationsRequest
extends com.aliyun.tea.TeaModel

嵌套类概要

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

static class DescribeInvocationsRequest.DescribeInvocationsRequestTag

嵌套类
限定符和类型	类和说明
`static class`	`DescribeInvocationsRequest.DescribeInvocationsRequestTag`

字段概要

字段
限定符和类型	字段和说明
`String`	`commandId` The ID of the command.
`String`	`commandName` The name of the command.
`String`	`commandType` The type of the command.
`String`	`contentEncoding` The encoding mode of the `CommandContent` and `Output` response parameters.
`Boolean`	`includeOutput` Specifies whether to return the command outputs in the response.
`String`	`instanceId` The ID of the instance.
`String`	`invokeId` The ID of the command task.
`String`	`invokeStatus` The overall execution state of the command.
`String`	`ownerAccount`
`Long`	`ownerId`
`Long`	`pageNumber` The number of the page to return.
`Long`	`pageSize` The number of entries to return on each page.
`String`	`regionId` The region ID of the command.
`String`	`repeatMode` The execution mode of the command.
`String`	`resourceGroupId` The ID of the resource group.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`List<DescribeInvocationsRequest.DescribeInvocationsRequestTag>`	`tag` The tags of the command.
`Boolean`	`timed` Specifies whether to query the commands that are to be automatically run.

构造器概要

构造器
构造器和说明

DescribeInvocationsRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static DescribeInvocationsRequest`	`build(Map<String,?> map)`
`String`	`getCommandId()`
`String`	`getCommandName()`
`String`	`getCommandType()`
`String`	`getContentEncoding()`
`Boolean`	`getIncludeOutput()`
`String`	`getInstanceId()`
`String`	`getInvokeId()`
`String`	`getInvokeStatus()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`Long`	`getPageNumber()`
`Long`	`getPageSize()`
`String`	`getRegionId()`
`String`	`getRepeatMode()`
`String`	`getResourceGroupId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`List<DescribeInvocationsRequest.DescribeInvocationsRequestTag>`	`getTag()`
`Boolean`	`getTimed()`
`DescribeInvocationsRequest`	`setCommandId(String commandId)`
`DescribeInvocationsRequest`	`setCommandName(String commandName)`
`DescribeInvocationsRequest`	`setCommandType(String commandType)`
`DescribeInvocationsRequest`	`setContentEncoding(String contentEncoding)`
`DescribeInvocationsRequest`	`setIncludeOutput(Boolean includeOutput)`
`DescribeInvocationsRequest`	`setInstanceId(String instanceId)`
`DescribeInvocationsRequest`	`setInvokeId(String invokeId)`
`DescribeInvocationsRequest`	`setInvokeStatus(String invokeStatus)`
`DescribeInvocationsRequest`	`setOwnerAccount(String ownerAccount)`
`DescribeInvocationsRequest`	`setOwnerId(Long ownerId)`
`DescribeInvocationsRequest`	`setPageNumber(Long pageNumber)`
`DescribeInvocationsRequest`	`setPageSize(Long pageSize)`
`DescribeInvocationsRequest`	`setRegionId(String regionId)`
`DescribeInvocationsRequest`	`setRepeatMode(String repeatMode)`
`DescribeInvocationsRequest`	`setResourceGroupId(String resourceGroupId)`
`DescribeInvocationsRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`DescribeInvocationsRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`DescribeInvocationsRequest`	`setTag(List<DescribeInvocationsRequest.DescribeInvocationsRequestTag> tag)`
`DescribeInvocationsRequest`	`setTimed(Boolean timed)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, 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. You can call the [DescribeCommands](~~64843~~) operation to query all available command IDs.
  - commandName
```
@NameInMap(value="CommandName")
public String commandName
```
    The name of the command.
  - commandType
```
@NameInMap(value="CommandType")
public String commandType
```
    The type of the command. If this parameter and `InstanceId` are both specified, this parameter does not take effect.
  - contentEncoding
```
@NameInMap(value="ContentEncoding")
public String contentEncoding
```
    The encoding mode of the `CommandContent` and `Output` response parameters. Valid values:
    
    * PlainText: returns the original command content and command outputs.
    
    * Base64: returns the Base64-encoded command content and command outputs.
    
    Default value: Base64.
  - includeOutput
```
@NameInMap(value="IncludeOutput")
public Boolean includeOutput
```
    Specifies whether to return the command outputs in the response.
    
    * true: The command outputs are returned. When this parameter is set to true, you must specify `InvokeId`, `InstanceId`, or both.
    
    * false: The command outputs are not returned.
    
    Default value: false.
  - instanceId
```
@NameInMap(value="InstanceId")
public String instanceId
```
    The ID of the instance. When you specify this parameter, the system queries all the execution records of all the commands that run on the instance.
  - invokeId
```
@NameInMap(value="InvokeId")
public String invokeId
```
    The ID of the command task.
  - invokeStatus
```
@NameInMap(value="InvokeStatus")
public String invokeStatus
```
    The overall execution state of the command. The value of this parameter depends on the execution states on all involved instances. Valid values:
    
    * Running:
    
    * Scheduled execution: Before you manually stop the execution of the command, the overall execution state is always Running.
    
    * One-time execution: If the execution is in progress on one or more instances, the overall execution state is Running.
    
    * Finished:
    
    * Scheduled execution: The overall execution state can never be Finished.
    
    * One-time execution: The execution is complete on all instances, or the execution is manually stopped on some instances and is complete on other instances.
    
    * Failed:
    
    * Scheduled execution: The overall execution state can never be Failed.
    
    * One-time execution: The execution fails on all instances.
    
    * PartialFailed:
    
    * Scheduled execution: The overall execution state can never be PartialFailed.
    
    * One-time execution: The execution fails on some instances.
    
    * Stopped: The execution is stopped.
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - pageNumber
```
@NameInMap(value="PageNumber")
public Long pageNumber
```
    The number of the page to return.
    
    Page start from page 1.
    
    Default value: 1.
  - pageSize
```
@NameInMap(value="PageSize")
public Long pageSize
```
    The number of entries to return on each page.
    
    Maximum value: 50.
    
    Default value: 10.
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the command. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.
  - repeatMode
```
@NameInMap(value="RepeatMode")
public String repeatMode
```
    The execution mode of the command. Valid values:
    
    * Once: The command is immediately run.
    
    * Period: The command is run on a schedule.
    
    * NextRebootOnly: The command is automatically run the next time the instance starts.
    
    * EveryReboot: The command is automatically run every time the instance starts.
    
    This parameter is empty by default, which indicates that commands run in all modes are queried.
  - resourceGroupId
```
@NameInMap(value="ResourceGroupId")
public String resourceGroupId
```
    The ID of the resource group. After you set this parameter, command execution results in the specified resource group are queried.
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - tag
```
@NameInMap(value="Tag")
public List<DescribeInvocationsRequest.DescribeInvocationsRequestTag> tag
```
    The tags of the command.
  - timed
```
@NameInMap(value="Timed")
public Boolean timed
```
    Specifies whether to query the commands that are to be automatically run. Valid values:
    
    * true: queries the commands that meet the following requirements: The commands are run by calling the `RunCommand` or `InvokeCommand` operation with `RepeatMode` set to `Period`, `NextRebootOnly`, or `EveryReboot`. The executions of the commands are not canceled and not complete or are not stopped and not complete.
    
    * false: queries commands that meet the following requirements:
    
    * The commands are run by calling the `RunCommand` or `InvokeCommand` operation with `RepeatMode` set to `Once`.
    
    * The executions of the commands are canceled, stopped, or complete.
    
    Default value: false.
- 构造器详细资料
  - DescribeInvocationsRequest
```
public DescribeInvocationsRequest()
```
- 方法详细资料
  - build
```
public static DescribeInvocationsRequest build(Map<String,?> map)
                                        throws Exception
```
    抛出:
    
    Exception
  - setCommandId
```
public DescribeInvocationsRequest setCommandId(String commandId)
```
  - getCommandId
```
public String getCommandId()
```
  - setCommandName
```
public DescribeInvocationsRequest setCommandName(String commandName)
```
  - getCommandName
```
public String getCommandName()
```
  - setCommandType
```
public DescribeInvocationsRequest setCommandType(String commandType)
```
  - getCommandType
```
public String getCommandType()
```
  - setContentEncoding
```
public DescribeInvocationsRequest setContentEncoding(String contentEncoding)
```
  - getContentEncoding
```
public String getContentEncoding()
```
  - setIncludeOutput
```
public DescribeInvocationsRequest setIncludeOutput(Boolean includeOutput)
```
  - getIncludeOutput
```
public Boolean getIncludeOutput()
```
  - setInstanceId
```
public DescribeInvocationsRequest setInstanceId(String instanceId)
```
  - getInstanceId
```
public String getInstanceId()
```
  - setInvokeId
```
public DescribeInvocationsRequest setInvokeId(String invokeId)
```
  - getInvokeId
```
public String getInvokeId()
```
  - setInvokeStatus
```
public DescribeInvocationsRequest setInvokeStatus(String invokeStatus)
```
  - getInvokeStatus
```
public String getInvokeStatus()
```
  - setOwnerAccount
```
public DescribeInvocationsRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public DescribeInvocationsRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setPageNumber
```
public DescribeInvocationsRequest setPageNumber(Long pageNumber)
```
  - getPageNumber
```
public Long getPageNumber()
```
  - setPageSize
```
public DescribeInvocationsRequest setPageSize(Long pageSize)
```
  - getPageSize
```
public Long getPageSize()
```
  - setRegionId
```
public DescribeInvocationsRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setRepeatMode
```
public DescribeInvocationsRequest setRepeatMode(String repeatMode)
```
  - getRepeatMode
```
public String getRepeatMode()
```
  - setResourceGroupId
```
public DescribeInvocationsRequest setResourceGroupId(String resourceGroupId)
```
  - getResourceGroupId
```
public String getResourceGroupId()
```
  - setResourceOwnerAccount
```
public DescribeInvocationsRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public DescribeInvocationsRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setTag
```
public DescribeInvocationsRequest setTag(List<DescribeInvocationsRequest.DescribeInvocationsRequestTag> tag)
```
  - getTag
```
public List<DescribeInvocationsRequest.DescribeInvocationsRequestTag> getTag()
```
  - setTimed
```
public DescribeInvocationsRequest setTimed(Boolean timed)
```
  - getTimed
```
public Boolean getTimed()
```

类 DescribeInvocationsRequest

嵌套类概要

字段概要

构造器概要

方法概要

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

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

字段详细资料

commandId

commandName

commandType

contentEncoding

includeOutput

instanceId

invokeId

invokeStatus

ownerAccount

ownerId

pageNumber

pageSize

regionId

repeatMode

resourceGroupId

resourceOwnerAccount

resourceOwnerId

tag

timed

构造器详细资料

DescribeInvocationsRequest

方法详细资料

build

setCommandId

getCommandId

setCommandName

getCommandName

setCommandType

getCommandType

setContentEncoding

getContentEncoding

setIncludeOutput

getIncludeOutput

setInstanceId

getInstanceId

setInvokeId

getInvokeId

setInvokeStatus

getInvokeStatus

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setPageNumber

getPageNumber

setPageSize

getPageSize

setRegionId

getRegionId

setRepeatMode

getRepeatMode

setResourceGroupId

getResourceGroupId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setTag

getTag

setTimed

getTimed