Package software.amazon.awssdk.services.opensearch.model

Class DescribePackagesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearch.model.OpenSearchRequest

software.amazon.awssdk.services.opensearch.model.DescribePackagesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribePackagesRequest.Builder,DescribePackagesRequest>

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

Container for the request parameters to the DescribePackage operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribePackagesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribePackagesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<DescribePackagesFilter>	filters()	Only returns packages that match the DescribePackagesFilterList values.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	maxResults()	An optional parameter that specifies the maximum number of results to return.
String	nextToken()	If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribePackagesRequest.Builder>	serializableBuilderClass()
DescribePackagesRequest.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

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<DescribePackagesFilter> filters()

Only returns packages that match the DescribePackagesFilterList values.

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 hasFilters() method.

Returns:

Only returns packages that match the DescribePackagesFilterList values.

maxResults

public final Integer maxResults()

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Returns:

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

nextToken

public final String nextToken()

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

Returns:

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

toBuilder

public DescribePackagesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePackagesRequest.Builder,DescribePackagesRequest>

Specified by:

toBuilder in class OpenSearchRequest

builder

public static DescribePackagesRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo