Package software.amazon.awssdk.services.rekognition.model

Class ListCollectionsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rekognition.model.RekognitionResponse

software.amazon.awssdk.services.rekognition.model.ListCollectionsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCollectionsResponse.Builder,ListCollectionsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ListCollectionsResponse
extends RekognitionResponse
implements ToCopyableBuilder<ListCollectionsResponse.Builder,ListCollectionsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCollectionsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ListCollectionsResponse.Builder	builder()
List<String>	collectionIds()	An array of collection IDs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	faceModelVersions()	Version numbers of the face detection models associated with the collections in the array CollectionIds.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCollectionIds()	For responses, this returns true if the service returned a value for the CollectionIds property.
boolean	hasFaceModelVersions()	For responses, this returns true if the service returned a value for the FaceModelVersions property.
int	hashCode()
String	nextToken()	If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.
List<SdkField<?>>	sdkFields()
static Class<? extends ListCollectionsResponse.Builder>	serializableBuilderClass()
ListCollectionsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasCollectionIds

public final boolean hasCollectionIds()

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

collectionIds

public final List<String> collectionIds()

An array of collection 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 hasCollectionIds() method.

Returns:

An array of collection IDs.

nextToken

public final String nextToken()

If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

Returns:

If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

hasFaceModelVersions

public final boolean hasFaceModelVersions()

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

faceModelVersions

public final List<String> faceModelVersions()

Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

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

Returns:

Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

toBuilder

public ListCollectionsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCollectionsResponse.Builder,ListCollectionsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListCollectionsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo