software.amazon.awssdk.services.ssm.model

Class DescribeParametersRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeParametersRequest.Builder,DescribeParametersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeParametersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeParametersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ParametersFilter>	filters() This data type is deprecated.
<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()
boolean	hasParameterFilters() For responses, this returns true if the service returned a value for the ParameterFilters property.
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<ParameterStringFilter>	parameterFilters() Filters to limit the request results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeParametersRequest.Builder>	serializableBuilderClass()
DescribeParametersRequest.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<ParametersFilter> filters()

This data type is deprecated. Instead, use ParameterFilters.

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:

This data type is deprecated. Instead, use ParameterFilters.

hasParameterFilters

public final boolean hasParameterFilters()

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

parameterFilters

public final List<ParameterStringFilter> parameterFilters()

Filters to limit the request results.

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

Returns:

Filters to limit the request results.

maxResults

public final 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 final 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 DescribeParametersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeParametersRequest.Builder,DescribeParametersRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static DescribeParametersRequest.Builder builder()

serializableBuilderClass

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