Package software.amazon.awssdk.services.comprehend.model

Class FlywheelProperties

java.lang.Object

software.amazon.awssdk.services.comprehend.model.FlywheelProperties

All Implemented Interfaces:

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

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

The flywheel properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FlywheelProperties.Builder

Method Summary

Modifier and Type	Method	Description
String	activeModelArn()	The Amazon Resource Number (ARN) of the active model version.
static FlywheelProperties.Builder	builder()
Instant	creationTime()	Creation time of the flywheel.
String	dataAccessRoleArn()	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
String	dataLakeS3Uri()	Amazon S3 URI of the data lake location.
DataSecurityConfig	dataSecurityConfig()	Data security configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flywheelArn()	The Amazon Resource Number (ARN) of the flywheel.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTime()	Last modified time for the flywheel.
String	latestFlywheelIteration()	The most recent flywheel iteration.
String	message()	A description of the status of the flywheel.
ModelType	modelType()	Model type of the flywheel's model.
String	modelTypeAsString()	Model type of the flywheel's model.
List<SdkField<?>>	sdkFields()
static Class<? extends FlywheelProperties.Builder>	serializableBuilderClass()
FlywheelStatus	status()	The status of the flywheel.
String	statusAsString()	The status of the flywheel.
TaskConfig	taskConfig()	Configuration about the model associated with a flywheel.
FlywheelProperties.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

flywheelArn

public final String flywheelArn()

The Amazon Resource Number (ARN) of the flywheel.

Returns:

The Amazon Resource Number (ARN) of the flywheel.

activeModelArn

public final String activeModelArn()

The Amazon Resource Number (ARN) of the active model version.

Returns:

The Amazon Resource Number (ARN) of the active model version.

dataAccessRoleArn

public final String dataAccessRoleArn()

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

Returns:

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

taskConfig

public final TaskConfig taskConfig()

Configuration about the model associated with a flywheel.

Returns:

Configuration about the model associated with a flywheel.

dataLakeS3Uri

public final String dataLakeS3Uri()

Amazon S3 URI of the data lake location.

Returns:

Amazon S3 URI of the data lake location.

dataSecurityConfig

public final DataSecurityConfig dataSecurityConfig()

Data security configuration.

Returns:

Data security configuration.

status

public final FlywheelStatus status()

The status of the flywheel.

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

Returns:

The status of the flywheel.

See Also:

FlywheelStatus

statusAsString

public final String statusAsString()

The status of the flywheel.

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

Returns:

The status of the flywheel.

See Also:

FlywheelStatus

modelType

public final ModelType modelType()

Model type of the flywheel's model.

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

Returns:

Model type of the flywheel's model.

See Also:

ModelType

modelTypeAsString

public final String modelTypeAsString()

Model type of the flywheel's model.

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

Returns:

Model type of the flywheel's model.

See Also:

ModelType

message

public final String message()

A description of the status of the flywheel.

Returns:

A description of the status of the flywheel.

creationTime

public final Instant creationTime()

Creation time of the flywheel.

Returns:

Creation time of the flywheel.

lastModifiedTime

public final Instant lastModifiedTime()

Last modified time for the flywheel.

Returns:

Last modified time for the flywheel.

latestFlywheelIteration

public final String latestFlywheelIteration()

The most recent flywheel iteration.

Returns:

The most recent flywheel iteration.

toBuilder

public FlywheelProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FlywheelProperties.Builder,FlywheelProperties>

builder

public static FlywheelProperties.Builder builder()

serializableBuilderClass

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