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

Class OpsItemEventFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.OpsItemEventFilter

All Implemented Interfaces:

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

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

Describes a filter for a specific list of OpsItem events. You can filter event information by using tags. You specify tags by using a key-value pair mapping.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpsItemEventFilter.Builder

Method Summary

Modifier and Type	Method	Description
static OpsItemEventFilter.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.
OpsItemEventFilterKey	key()	The name of the filter key.
String	keyAsString()	The name of the filter key.
OpsItemEventFilterOperator	operator()	The operator used by the filter call.
String	operatorAsString()	The operator used by the filter call.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OpsItemEventFilter.Builder>	serializableBuilderClass()
OpsItemEventFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The values for the filter, consisting of one or more OpsItem IDs.

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 OpsItemEventFilterKey key()

The name of the filter key. Currently, the only supported value is OpsItemId.

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

Returns:

The name of the filter key. Currently, the only supported value is OpsItemId.

See Also:

OpsItemEventFilterKey

keyAsString

public final String keyAsString()

The name of the filter key. Currently, the only supported value is OpsItemId.

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

Returns:

The name of the filter key. Currently, the only supported value is OpsItemId.

See Also:

OpsItemEventFilterKey

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 for the filter, consisting of one or more OpsItem IDs.

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 for the filter, consisting of one or more OpsItem IDs.

operator

public final OpsItemEventFilterOperator operator()

The operator used by the filter call. Currently, the only supported value is Equal.

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

Returns:

The operator used by the filter call. Currently, the only supported value is Equal.

See Also:

OpsItemEventFilterOperator

operatorAsString

public final String operatorAsString()

The operator used by the filter call. Currently, the only supported value is Equal.

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

Returns:

The operator used by the filter call. Currently, the only supported value is Equal.

See Also:

OpsItemEventFilterOperator

toBuilder

public OpsItemEventFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OpsItemEventFilter.Builder,OpsItemEventFilter>

builder

public static OpsItemEventFilter.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo