Package software.amazon.awssdk.services.ssm.model

Class GetParametersResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ssm.model.SsmResponse

software.amazon.awssdk.services.ssm.model.GetParametersResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetParametersResponse.Builder,GetParametersResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetParametersResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetParametersResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInvalidParameters()	For responses, this returns true if the service returned a value for the InvalidParameters property.
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
List<String>	invalidParameters()	A list of parameters that aren't formatted correctly or don't run during an execution.
List<Parameter>	parameters()	A list of details for a parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends GetParametersResponse.Builder>	serializableBuilderClass()
GetParametersResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasParameters

public final boolean hasParameters()

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

parameters

public final List<Parameter> parameters()

A list of details for a parameter.

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

Returns:

A list of details for a parameter.

hasInvalidParameters

public final boolean hasInvalidParameters()

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

invalidParameters

public final List<String> invalidParameters()

A list of parameters that aren't formatted correctly or don't run during an execution.

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

Returns:

A list of parameters that aren't formatted correctly or don't run during an execution.

toBuilder

public GetParametersResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetParametersResponse.Builder,GetParametersResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetParametersResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetParametersResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo