Class StopInstancesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.StopInstancesRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StopInstancesRequest.Builder,StopInstancesRequest>
@Generated("software.amazon.awssdk:codegen") public final class StopInstancesRequest extends Ec2Request implements ToCopyableBuilder<StopInstancesRequest.Builder,StopInstancesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StopInstancesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StopInstancesRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
Boolean
force()
Forces the instances to stop.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasInstanceIds()
For responses, this returns true if the service returned a value for the InstanceIds property.Boolean
hibernate()
Hibernates the instance if the instance was enabled for hibernation at launch.List<String>
instanceIds()
The IDs of the instances.List<SdkField<?>>
sdkFields()
static Class<? extends StopInstancesRequest.Builder>
serializableBuilderClass()
StopInstancesRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasInstanceIds
public final boolean hasInstanceIds()
For responses, this returns true if the service returned a value for the InstanceIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
instanceIds
public final List<String> instanceIds()
The IDs of the instances.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInstanceIds()
method.- Returns:
- The IDs of the instances.
-
hibernate
public final Boolean hibernate()
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default:
false
- Returns:
- Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot
hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in
the Amazon EC2 User Guide.
Default:
false
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
force
public final Boolean force()
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default:
false
- Returns:
- Forces the instances to stop. The instances do not have an opportunity to flush file system caches or
file system metadata. If you use this option, you must perform file system check and repair procedures.
This option is not recommended for Windows instances.
Default:
false
-
toBuilder
public StopInstancesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StopInstancesRequest.Builder,StopInstancesRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static StopInstancesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StopInstancesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-