software.amazon.awssdk.services.rekognition.model

Class DescribeCollectionResponse

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.DescribeCollectionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCollectionResponse.Builder,DescribeCollectionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCollectionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCollectionResponse.Builder	builder()
String	collectionARN() The Amazon Resource Name (ARN) of the collection.
Instant	creationTimestamp() The number of milliseconds since the Unix epoch time until the creation of the collection.
boolean	equals(Object obj)
Long	faceCount() The number of faces that are indexed into the collection.
String	faceModelVersion() The version of the face model that's used by the collection for face detection.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCollectionResponse.Builder>	serializableBuilderClass()
DescribeCollectionResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

faceCount

public Long faceCount()

The number of faces that are indexed into the collection. To index faces into a collection, use .

Returns:

The number of faces that are indexed into the collection. To index faces into a collection, use .

faceModelVersion

public String faceModelVersion()

The version of the face model that's used by the collection for face detection.

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

Returns:

The version of the face model that's used by the collection for face detection.

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

collectionARN

public String collectionARN()

The Amazon Resource Name (ARN) of the collection.

Returns:

The Amazon Resource Name (ARN) of the collection.

creationTimestamp

public Instant creationTimestamp()

The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

Returns:

The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

toBuilder

public DescribeCollectionResponse.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<DescribeCollectionResponse.Builder,DescribeCollectionResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeCollectionResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.