Class Algorithm

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

Describes a custom algorithm.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the algorithm.

      Returns:
      The name of the algorithm.

    • algorithmArn

      public final String algorithmArn()

      The Amazon Resource Name (ARN) of the algorithm.

      Returns:
      The Amazon Resource Name (ARN) of the algorithm.

    • algorithmImage

      public final AlgorithmImage algorithmImage()

      The URI of the Docker container for the algorithm image.

      Returns:
      The URI of the Docker container for the algorithm image.

    • hasDefaultHyperParameters

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

    • defaultHyperParameters

      public final Map<String,String> defaultHyperParameters()

      Specifies the default hyperparameters.

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

      Returns:
      Specifies the default hyperparameters.

    • defaultHyperParameterRanges

      public final DefaultHyperParameterRanges defaultHyperParameterRanges()

      Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

      Returns:
      Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

    • hasDefaultResourceConfig

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

    • defaultResourceConfig

      public final Map<String,String> defaultResourceConfig()

      Specifies the default maximum number of training jobs and parallel training jobs.

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

      Returns:
      Specifies the default maximum number of training jobs and parallel training jobs.

    • trainingInputMode

      public final String trainingInputMode()

      The training input mode.

      Returns:
      The training input mode.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role.

      Returns:
      The Amazon Resource Name (ARN) of the role.

    • creationDateTime

      public final Instant creationDateTime()

      The date and time (in Unix time) that the algorithm was created.

      Returns:
      The date and time (in Unix time) that the algorithm was created.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The date and time (in Unix time) that the algorithm was last updated.

      Returns:
      The date and time (in Unix time) that the algorithm was last updated.

    • toBuilder

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

    • builder

      public static Algorithm.Builder builder()

    • serializableBuilderClass

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