Class InferenceExperimentSummary

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

Lists a summary of properties of an inference experiment.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the inference experiment.

      Returns:
      The name of the inference experiment.

    • type

      public final InferenceExperimentType type()

      The type of the inference experiment.

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

      Returns:
      The type of the inference experiment.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the inference experiment.

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

      Returns:
      The type of the inference experiment.
      See Also:

    • schedule

      public final InferenceExperimentSchedule schedule()

      The duration for which the inference experiment ran or will run.

      The maximum duration that you can set for an inference experiment is 30 days.

      Returns:
      The duration for which the inference experiment ran or will run.

      The maximum duration that you can set for an inference experiment is 30 days.

    • status

      public final InferenceExperimentStatus status()

      The status of the inference experiment.

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

      Returns:
      The status of the inference experiment.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the inference experiment.

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

      Returns:
      The status of the inference experiment.
      See Also:

    • statusReason

      public final String statusReason()

      The error message for the inference experiment status result.

      Returns:
      The error message for the inference experiment status result.

    • description

      public final String description()

      The description of the inference experiment.

      Returns:
      The description of the inference experiment.

    • creationTime

      public final Instant creationTime()

      The timestamp at which the inference experiment was created.

      Returns:
      The timestamp at which the inference experiment was created.

    • completionTime

      public final Instant completionTime()

      The timestamp at which the inference experiment was completed.

      Returns:
      The timestamp at which the inference experiment was completed.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when you last modified the inference experiment.

      Returns:
      The timestamp when you last modified the inference experiment.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

      Returns:
      The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

    • toBuilder

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

    • builder

      public static InferenceExperimentSummary.Builder builder()

    • serializableBuilderClass

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