StopInstancesRequest (ecs20140526 3.1.10 API)

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

public class StopInstancesRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`batchOptimization` The batch operation mode.
`Boolean`	`dryRun` Specifies whether to check the validity of the request without actually making the request.
`Boolean`	`forceStop` Specifies whether to forcibly stop the instance.
`List<String>`	`instanceId` The list of instance ID.
`String`	`ownerAccount`
`Long`	`ownerId`
`String`	`regionId` The region ID of the instance.
`String`	`resourceOwnerAccount`
`Long`	`resourceOwnerId`
`String`	`stoppedMode` The stop mode of the pay-as-you-go instance.

构造器概要

构造器
构造器和说明

StopInstancesRequest()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static StopInstancesRequest`	`build(Map<String,?> map)`
`String`	`getBatchOptimization()`
`Boolean`	`getDryRun()`
`Boolean`	`getForceStop()`
`List<String>`	`getInstanceId()`
`String`	`getOwnerAccount()`
`Long`	`getOwnerId()`
`String`	`getRegionId()`
`String`	`getResourceOwnerAccount()`
`Long`	`getResourceOwnerId()`
`String`	`getStoppedMode()`
`StopInstancesRequest`	`setBatchOptimization(String batchOptimization)`
`StopInstancesRequest`	`setDryRun(Boolean dryRun)`
`StopInstancesRequest`	`setForceStop(Boolean forceStop)`
`StopInstancesRequest`	`setInstanceId(List<String> instanceId)`
`StopInstancesRequest`	`setOwnerAccount(String ownerAccount)`
`StopInstancesRequest`	`setOwnerId(Long ownerId)`
`StopInstancesRequest`	`setRegionId(String regionId)`
`StopInstancesRequest`	`setResourceOwnerAccount(String resourceOwnerAccount)`
`StopInstancesRequest`	`setResourceOwnerId(Long resourceOwnerId)`
`StopInstancesRequest`	`setStoppedMode(String stoppedMode)`

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

- 字段详细资料
  - batchOptimization
```
@NameInMap(value="BatchOptimization")
public String batchOptimization
```
    The batch operation mode. Valid values:
    
    * AllTogether: In this mode, if all instances are stopped, a success message is returned. If an instance fails the verification, all instances fail to stop and an error message is returned.
    
    * SuccessFirst: In this mode, each instance is separately stopped. The response contains the operation results for each instance.
    
    Default value: AllTogether.
  - dryRun
```
@NameInMap(value="DryRun")
public Boolean dryRun
```
    Specifies whether to check the validity of the request without actually making the request. Valid values:
    
    * true: The validity of the request is checked, but the request is not made. Check items include the request format, instance status, and whether the required parameters are specified. If the check fails, the corresponding error message is returned. If the check succeeds, `DRYRUN.SUCCESS` is returned.
    
    > If you set `BatchOptimization` to `SuccessFirst` and `DryRun` to true, only `DRYRUN.SUCCESS` is returned regardless of whether the check succeeds.
    
    * false: The validity of the request is checked, and the request is made if the check succeeds.
    
    Default value: false.
  - forceStop
```
@NameInMap(value="ForceStop")
public Boolean forceStop
```
    Specifies whether to forcibly stop the instance. Valid values:
    
    * true: forcibly stops the instance. This operation is equivalent to the typical power-off operation. Cache data that is not written to storage in the instance will be lost.
    
    * false: normally stops the instance.
    
    Default value: false.
  - instanceId
```
@NameInMap(value="InstanceId")
public List<String> instanceId
```
    The list of instance ID.
  - ownerAccount
```
@NameInMap(value="OwnerAccount")
public String ownerAccount
```
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the instance. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.
  - resourceOwnerAccount
```
@NameInMap(value="ResourceOwnerAccount")
public String resourceOwnerAccount
```
  - resourceOwnerId
```
@NameInMap(value="ResourceOwnerId")
public Long resourceOwnerId
```
  - stoppedMode
```
@NameInMap(value="StoppedMode")
public String stoppedMode
```
    The stop mode of the pay-as-you-go instance. Valid values:
    
    * StopCharging: economical mode. For information about how `StopCharging` takes effect, see the "Prerequisites" section in [Economical mode](~~63353~~).
    
    * KeepCharging: standard mode. After the instances are stopped in standard mode, you continue to be charged for them.
    
    Default value: If the prerequisites required for enabling the economical mode are met and you have enabled this mode in the ECS console, the default value is `StopCharging`. For more information, see "Enable the economical mode" in [Economical mode](~~63353#default~~). Otherwise, the default value is `KeepCharging`.
- 构造器详细资料
  - StopInstancesRequest
```
public StopInstancesRequest()
```
- 方法详细资料
  - build
```
public static StopInstancesRequest build(Map<String,?> map)
                                  throws Exception
```
    抛出:
    
    Exception
  - setBatchOptimization
```
public StopInstancesRequest setBatchOptimization(String batchOptimization)
```
  - getBatchOptimization
```
public String getBatchOptimization()
```
  - setDryRun
```
public StopInstancesRequest setDryRun(Boolean dryRun)
```
  - getDryRun
```
public Boolean getDryRun()
```
  - setForceStop
```
public StopInstancesRequest setForceStop(Boolean forceStop)
```
  - getForceStop
```
public Boolean getForceStop()
```
  - setInstanceId
```
public StopInstancesRequest setInstanceId(List<String> instanceId)
```
  - getInstanceId
```
public List<String> getInstanceId()
```
  - setOwnerAccount
```
public StopInstancesRequest setOwnerAccount(String ownerAccount)
```
  - getOwnerAccount
```
public String getOwnerAccount()
```
  - setOwnerId
```
public StopInstancesRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setRegionId
```
public StopInstancesRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```
  - setResourceOwnerAccount
```
public StopInstancesRequest setResourceOwnerAccount(String resourceOwnerAccount)
```
  - getResourceOwnerAccount
```
public String getResourceOwnerAccount()
```
  - setResourceOwnerId
```
public StopInstancesRequest setResourceOwnerId(Long resourceOwnerId)
```
  - getResourceOwnerId
```
public Long getResourceOwnerId()
```
  - setStoppedMode
```
public StopInstancesRequest setStoppedMode(String stoppedMode)
```
  - getStoppedMode
```
public String getStoppedMode()
```

类 StopInstancesRequest

字段概要

构造器概要

方法概要

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

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

字段详细资料

batchOptimization

dryRun

forceStop

instanceId

ownerAccount

ownerId

regionId

resourceOwnerAccount

resourceOwnerId

stoppedMode

构造器详细资料

StopInstancesRequest

方法详细资料

build

setBatchOptimization

getBatchOptimization

setDryRun

getDryRun

setForceStop

getForceStop

setInstanceId

getInstanceId

setOwnerAccount

getOwnerAccount

setOwnerId

getOwnerId

setRegionId

getRegionId

setResourceOwnerAccount

getResourceOwnerAccount

setResourceOwnerId

getResourceOwnerId

setStoppedMode

getStoppedMode