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:

ToCopyableBuilder<DescribeInstancesRequest.Builder,DescribeInstancesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeInstancesRequest.Builder

Method Summary

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

stackId

public 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 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.

instanceIds

public 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.

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

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<DescribeInstancesRequest.Builder,DescribeInstancesRequest>

Specified by:

toBuilder in class OpsWorksRequest

Returns:

a builder for type T

builder

public static DescribeInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeInstancesRequest.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