Package software.amazon.awssdk.services.controlcatalog.model

Class CommonControlFilter

java.lang.Object

software.amazon.awssdk.services.controlcatalog.model.CommonControlFilter

All Implemented Interfaces:

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

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

An optional filter that narrows the results to a specific objective.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommonControlFilter.Builder

Method Summary

Modifier and Type	Method	Description
static CommonControlFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasObjectives()	For responses, this returns true if the service returned a value for the Objectives property.
List<ObjectiveResourceFilter>	objectives()	The objective that's used as filter criteria.
List<SdkField<?>>	sdkFields()
static Class<? extends CommonControlFilter.Builder>	serializableBuilderClass()
CommonControlFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasObjectives

public final boolean hasObjectives()

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

objectives

public final List<ObjectiveResourceFilter> objectives()

The objective that's used as filter criteria.

You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t currently supported.

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

Returns:

The objective that's used as filter criteria.

You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t currently supported.

toBuilder

public CommonControlFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CommonControlFilter.Builder,CommonControlFilter>

builder

public static CommonControlFilter.Builder builder()

serializableBuilderClass

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