Package software.amazon.awssdk.services.inspector2.model

Class AmiAggregation

java.lang.Object

software.amazon.awssdk.services.inspector2.model.AmiAggregation

All Implemented Interfaces:

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

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

The details that define an aggregation based on Amazon machine images (AMIs).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AmiAggregation.Builder

Method Summary

Modifier and Type	Method	Description
List<StringFilter>	amis()	The IDs of AMIs to aggregate findings for.
static AmiAggregation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAmis()	For responses, this returns true if the service returned a value for the Amis property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AmiAggregation.Builder>	serializableBuilderClass()
AmiSortBy	sortBy()	The value to sort results by.
String	sortByAsString()	The value to sort results by.
SortOrder	sortOrder()	The order to sort results by.
String	sortOrderAsString()	The order to sort results by.
AmiAggregation.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

hasAmis

public final boolean hasAmis()

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

amis

public final List<StringFilter> amis()

The IDs of AMIs to aggregate findings for.

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

Returns:

The IDs of AMIs to aggregate findings for.

sortBy

public final AmiSortBy sortBy()

The value to sort results by.

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

Returns:

The value to sort results by.

See Also:

AmiSortBy

sortByAsString

public final String sortByAsString()

The value to sort results by.

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

Returns:

The value to sort results by.

See Also:

AmiSortBy

sortOrder

public final SortOrder sortOrder()

The order to sort results by.

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

Returns:

The order to sort results by.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The order to sort results by.

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

Returns:

The order to sort results by.

See Also:

SortOrder

toBuilder

public AmiAggregation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AmiAggregation.Builder,AmiAggregation>

builder

public static AmiAggregation.Builder builder()

serializableBuilderClass

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