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:

  • Method Details

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

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

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

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

    • 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()
      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<FlywheelProperties.Builder,FlywheelProperties>
      Returns:
      a builder for type T

    • 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)
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.