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

Class ProjectDescription

java.lang.Object

software.amazon.awssdk.services.rekognition.model.ProjectDescription

All Implemented Interfaces:

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

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

A description of an Amazon Rekognition Custom Labels project. For more information, see DescribeProjects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProjectDescription.Builder

Method Summary

Modifier and Type	Method	Description
ProjectAutoUpdate	autoUpdate()	Indicates whether automatic retraining will be attempted for the versions of the project.
String	autoUpdateAsString()	Indicates whether automatic retraining will be attempted for the versions of the project.
static ProjectDescription.Builder	builder()
Instant	creationTimestamp()	The Unix timestamp for the date and time that the project was created.
List<DatasetMetadata>	datasets()	Information about the training and test datasets in the project.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
CustomizationFeature	feature()	Specifies the project that is being customized.
String	featureAsString()	Specifies the project that is being customized.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDatasets()	For responses, this returns true if the service returned a value for the Datasets property.
int	hashCode()
String	projectArn()	The Amazon Resource Name (ARN) of the project.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ProjectDescription.Builder>	serializableBuilderClass()
ProjectStatus	status()	The current status of the project.
String	statusAsString()	The current status of the project.
ProjectDescription.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

projectArn

public final String projectArn()

The Amazon Resource Name (ARN) of the project.

Returns:

The Amazon Resource Name (ARN) of the project.

creationTimestamp

public final Instant creationTimestamp()

The Unix timestamp for the date and time that the project was created.

Returns:

The Unix timestamp for the date and time that the project was created.

status

public final ProjectStatus status()

The current status of the project.

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

Returns:

The current status of the project.

See Also:

ProjectStatus

statusAsString

public final String statusAsString()

The current status of the project.

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

Returns:

The current status of the project.

See Also:

ProjectStatus

hasDatasets

public final boolean hasDatasets()

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

datasets

public final List<DatasetMetadata> datasets()

Information about the training and test datasets in the project.

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

Returns:

Information about the training and test datasets in the project.

feature

public final CustomizationFeature feature()

Specifies the project that is being customized.

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

Returns:

Specifies the project that is being customized.

See Also:

CustomizationFeature

featureAsString

public final String featureAsString()

Specifies the project that is being customized.

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

Returns:

Specifies the project that is being customized.

See Also:

CustomizationFeature

autoUpdate

public final ProjectAutoUpdate autoUpdate()

Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.

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

Returns:

Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.

See Also:

ProjectAutoUpdate

autoUpdateAsString

public final String autoUpdateAsString()

Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.

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

Returns:

Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.

See Also:

ProjectAutoUpdate

toBuilder

public ProjectDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProjectDescription.Builder,ProjectDescription>

builder

public static ProjectDescription.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo