software.amazon.awssdk.services.ssm.model

Class StepExecutionFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.StepExecutionFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StepExecutionFilter.Builder,StepExecutionFilter>

@Generated(value="software.amazon.awssdk:codegen")
public final class StepExecutionFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StepExecutionFilter.Builder,StepExecutionFilter>

A filter to limit the amount of step execution information returned by the call.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StepExecutionFilter.Builder

Method Summary

Modifier and Type	Method and Description
static StepExecutionFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() For responses, this returns true if the service returned a value for the Values property.
StepExecutionFilterKey	key() One or more keys to limit the results.
String	keyAsString() One or more keys to limit the results.
List<SdkField<?>>	sdkFields()
static Class<? extends StepExecutionFilter.Builder>	serializableBuilderClass()
StepExecutionFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() The values of the filter key.

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

key

public final StepExecutionFilterKey key()

One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.

If the service returns an enum value that is not available in the current SDK version, key will return StepExecutionFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.

See Also:

StepExecutionFilterKey

keyAsString

public final String keyAsString()

One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.

If the service returns an enum value that is not available in the current SDK version, key will return StepExecutionFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.

See Also:

StepExecutionFilterKey

hasValues

public final boolean hasValues()

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

values

public final List<String> values()

The values of the filter key.

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

Returns:

The values of the filter key.

toBuilder

public StepExecutionFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StepExecutionFilter.Builder,StepExecutionFilter>

builder

public static StepExecutionFilter.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo