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(value="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 and Description
static interface	OpsItemEventFilter.Builder

Method Summary

Modifier and Type	Method and Description
static OpsItemEventFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.
List<SdkField<?>>	sdkFields()
static Class<? extends OpsItemEventFilter.Builder>	serializableBuilderClass()
OpsItemEventFilter.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

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

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasValues() to see if a value was sent in this field.

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<OpsItemEventFilter.Builder,OpsItemEventFilter>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.