Class FeatureMetadata

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.FeatureMetadata
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FeatureMetadata.Builder,FeatureMetadata>
@Generated("software.amazon.awssdk:codegen") public final class FeatureMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FeatureMetadata.Builder,FeatureMetadata>

The metadata for a feature. It can either be metadata that you specify, or metadata that is updated automatically.

See Also:

  • Method Details

    • featureGroupArn

      public final String featureGroupArn()

      The Amazon Resource Number (ARN) of the feature group.

      Returns:
      The Amazon Resource Number (ARN) of the feature group.

    • featureGroupName

      public final String featureGroupName()

      The name of the feature group containing the feature.

      Returns:
      The name of the feature group containing the feature.

    • featureName

      public final String featureName()

      The name of feature.

      Returns:
      The name of feature.

    • featureType

      public final FeatureType featureType()

      The data type of the feature.

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

      Returns:
      The data type of the feature.
      See Also:

    • featureTypeAsString

      public final String featureTypeAsString()

      The data type of the feature.

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

      Returns:
      The data type of the feature.
      See Also:

    • creationTime

      public final Instant creationTime()

      A timestamp indicating when the feature was created.

      Returns:
      A timestamp indicating when the feature was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      A timestamp indicating when the feature was last modified.

      Returns:
      A timestamp indicating when the feature was last modified.

    • description

      public final String description()

      An optional description that you specify to better describe the feature.

      Returns:
      An optional description that you specify to better describe the feature.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters 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.

    • parameters

      public final List<FeatureParameter> parameters()

      Optional key-value pairs that you specify to better describe the feature.

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

      Returns:
      Optional key-value pairs that you specify to better describe the feature.

    • toBuilder

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

    • builder

      public static FeatureMetadata.Builder builder()

    • serializableBuilderClass

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