software.amazon.awssdk.services.elasticsearch.model

Class DescribeReservedElasticsearchInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticsearch.model.ElasticsearchRequest

software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeReservedElasticsearchInstancesRequest.Builder,DescribeReservedElasticsearchInstancesRequest>

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

Container for parameters to DescribeReservedElasticsearchInstances

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeReservedElasticsearchInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeReservedElasticsearchInstancesRequest.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()
Integer	maxResults() Set this value to limit the number of results returned.
String	nextToken() NextToken should be sent in case if earlier API call produced result containing NextToken.
String	reservedElasticsearchInstanceId() The reserved instance identifier filter value.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeReservedElasticsearchInstancesRequest.Builder>	serializableBuilderClass()
DescribeReservedElasticsearchInstancesRequest.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

reservedElasticsearchInstanceId

public String reservedElasticsearchInstanceId()

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

Returns:

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

maxResults

public Integer maxResults()

Set this value to limit the number of results returned. If not specified, defaults to 100.

Returns:

Set this value to limit the number of results returned. If not specified, defaults to 100.

nextToken

public String nextToken()

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

Returns:

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

toBuilder

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

Specified by:

toBuilder in class ElasticsearchRequest

Returns:

a builder for type T

builder

public static DescribeReservedElasticsearchInstancesRequest.Builder builder()

serializableBuilderClass

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