Package software.amazon.awssdk.services.opsworks.model

Class DescribeInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworks.model.OpsWorksRequest

software.amazon.awssdk.services.opsworks.model.DescribeInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeInstancesRequest.Builder,DescribeInstancesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeInstancesRequest
extends OpsWorksRequest
implements ToCopyableBuilder<DescribeInstancesRequest.Builder,DescribeInstancesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeInstancesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeInstancesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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.
List<String>	instanceIds()	An array of instance IDs to be described.
String	layerId()	A layer ID.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInstancesRequest.Builder>	serializableBuilderClass()
String	stackId()	A stack ID.
DescribeInstancesRequest.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

stackId

public final String stackId()

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

Returns:

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

layerId

public final String layerId()

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

Returns:

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

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 the isEmpty() 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()

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

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:

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

toBuilder

public DescribeInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInstancesRequest.Builder,DescribeInstancesRequest>

Specified by:

toBuilder in class OpsWorksRequest

builder

public static DescribeInstancesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo