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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public ProjectDescription.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<ProjectDescription.Builder,ProjectDescription>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.