software.amazon.awssdk.services.autoscaling.model

Class SetInstanceHealthRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.autoscaling.model.AutoScalingRequest

software.amazon.awssdk.services.autoscaling.model.SetInstanceHealthRequest

All Implemented Interfaces:

ToCopyableBuilder<SetInstanceHealthRequest.Builder,SetInstanceHealthRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class SetInstanceHealthRequest
extends AutoScalingRequest
implements ToCopyableBuilder<SetInstanceHealthRequest.Builder,SetInstanceHealthRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetInstanceHealthRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SetInstanceHealthRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	healthStatus() The health status of the instance.
String	instanceId() The ID of the instance.
static Class<? extends SetInstanceHealthRequest.Builder>	serializableBuilderClass()
Boolean	shouldRespectGracePeriod() If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period.
SetInstanceHealthRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

instanceId

public String instanceId()

The ID of the instance.

Returns:

The ID of the instance.

healthStatus

public String healthStatus()

The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.

Returns:

The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.

shouldRespectGracePeriod

public Boolean shouldRespectGracePeriod()

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.

For more information, see the description of the health check grace period for CreateAutoScalingGroup.

Returns:

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.

For more information, see the description of the health check grace period for CreateAutoScalingGroup.

toBuilder

public SetInstanceHealthRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SetInstanceHealthRequest.Builder,SetInstanceHealthRequest>

Specified by:

toBuilder in class AutoScalingRequest

Returns:

a builder for type T

builder

public static SetInstanceHealthRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetInstanceHealthRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value