Class ProjectDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ProjectDescription.Builder,
ProjectDescription>
A description of an Amazon Rekognition Custom Labels project. For more information, see DescribeProjects.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ProjectAutoUpdate
Indicates whether automatic retraining will be attempted for the versions of the project.final String
Indicates whether automatic retraining will be attempted for the versions of the project.static ProjectDescription.Builder
builder()
final Instant
The Unix timestamp for the date and time that the project was created.final List
<DatasetMetadata> datasets()
Information about the training and test datasets in the project.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final CustomizationFeature
feature()
Specifies the project that is being customized.final String
Specifies the project that is being customized.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Datasets property.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the project.static Class
<? extends ProjectDescription.Builder> final ProjectStatus
status()
The current status of the project.final String
The current status of the project.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
projectArn
The Amazon Resource Name (ARN) of the project.
- Returns:
- The Amazon Resource Name (ARN) of the project.
-
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
The current status of the project.
If the service returns an enum value that is not available in the current SDK version,
status
will returnProjectStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the project.
- See Also:
-
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 returnProjectStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 theisEmpty()
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
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
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 returnCustomizationFeature.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureAsString()
.- Returns:
- Specifies the project that is being customized.
- See Also:
-
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 returnCustomizationFeature.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureAsString()
.- Returns:
- Specifies the project that is being customized.
- See Also:
-
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 returnProjectAutoUpdate.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoUpdateAsString()
.- Returns:
- Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.
- See Also:
-
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 returnProjectAutoUpdate.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoUpdateAsString()
.- Returns:
- Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.
- See Also:
-
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 interfaceToCopyableBuilder<ProjectDescription.Builder,
ProjectDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-