Class StopInstanceRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.lightsail.model.LightsailRequest
-
- software.amazon.awssdk.services.lightsail.model.StopInstanceRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<StopInstanceRequest.Builder,StopInstanceRequest>
@Generated("software.amazon.awssdk:codegen") public final class StopInstanceRequest extends LightsailRequest implements ToCopyableBuilder<StopInstanceRequest.Builder,StopInstanceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStopInstanceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StopInstanceRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Booleanforce()When set toTrue, forces a Lightsail instance that is stuck in astoppingstate to stop.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringinstanceName()The name of the instance (a virtual private server) to stop.List<SdkField<?>>sdkFields()static Class<? extends StopInstanceRequest.Builder>serializableBuilderClass()StopInstanceRequest.BuildertoBuilder()StringtoString()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
-
instanceName
public final String instanceName()
The name of the instance (a virtual private server) to stop.
- Returns:
- The name of the instance (a virtual private server) to stop.
-
force
public final Boolean force()
When set to
True, forces a Lightsail instance that is stuck in astoppingstate to stop.Only use the
forceparameter if your instance is stuck in thestoppingstate. In any other state, your instance should stop normally without adding this parameter to your API request.- Returns:
- When set to
True, forces a Lightsail instance that is stuck in astoppingstate to stop.Only use the
forceparameter if your instance is stuck in thestoppingstate. In any other state, your instance should stop normally without adding this parameter to your API request.
-
toBuilder
public StopInstanceRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StopInstanceRequest.Builder,StopInstanceRequest>- Specified by:
toBuilderin classLightsailRequest
-
builder
public static StopInstanceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StopInstanceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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:
getValueForFieldin classSdkRequest
-
-