software.amazon.awssdk.services.ssm.model

Class DescribeInstanceInformationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeInstanceInformationRequest.Builder,DescribeInstanceInformationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeInstanceInformationRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeInstanceInformationRequest.Builder	builder()
boolean	equals(Object obj)
List<InstanceInformationStringFilter>	filters() One or more filters.
<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<InstanceInformationFilter>	instanceInformationFilterList() This is a legacy method.
Integer	maxResults() The maximum number of items to return for this call.
String	nextToken() The token for the next set of items to return.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInstanceInformationRequest.Builder>	serializableBuilderClass()
DescribeInstanceInformationRequest.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

overrideConfiguration

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

instanceInformationFilterList

public List<InstanceInformationFilter> instanceInformationFilterList()

This is a legacy method. We recommend that you don't use this method. Instead, use the InstanceInformationFilter action. The InstanceInformationFilter action enables you to return instance information by using tags that are specified as a key-value mapping.

If you do use this method, then you can't use the InstanceInformationFilter action. Using this method and the InstanceInformationFilter action causes an exception error.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

This is a legacy method. We recommend that you don't use this method. Instead, use the InstanceInformationFilter action. The InstanceInformationFilter action enables you to return instance information by using tags that are specified as a key-value mapping.

If you do use this method, then you can't use the InstanceInformationFilter action. Using this method and the InstanceInformationFilter action causes an exception error.

filters

public List<InstanceInformationStringFilter> filters()

One or more filters. Use a filter to return a more specific list of instances. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more filters. Use a filter to return a more specific list of instances. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.

maxResults

public Integer maxResults()

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

nextToken

public String nextToken()

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

toBuilder

public DescribeInstanceInformationRequest.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<DescribeInstanceInformationRequest.Builder,DescribeInstanceInformationRequest>

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static DescribeInstanceInformationRequest.Builder builder()

serializableBuilderClass

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.