Class NotebookRunSummary

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

The summary of a notebook run in Amazon SageMaker Unified Studio.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the notebook run.

      Returns:
      The identifier of the notebook run.

    • domainId

      public final String domainId()

      The identifier of the Amazon SageMaker Unified Studio domain.

      Returns:
      The identifier of the Amazon SageMaker Unified Studio domain.

    • owningProjectId

      public final String owningProjectId()

      The identifier of the project that owns the notebook run.

      Returns:
      The identifier of the project that owns the notebook run.

    • notebookId

      public final String notebookId()

      The identifier of the notebook.

      Returns:
      The identifier of the notebook.

    • scheduleId

      public final String scheduleId()

      The identifier of the schedule associated with the notebook run.

      Returns:
      The identifier of the schedule associated with the notebook run.

    • status

      public final NotebookRunStatus status()

      The status of the notebook run.

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

      Returns:
      The status of the notebook run.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the notebook run.

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

      Returns:
      The status of the notebook run.
      See Also:

    • triggerSource

      public final TriggerSource triggerSource()

      The source that triggered the notebook run.

      Returns:
      The source that triggered the notebook run.

    • createdAt

      public final Instant createdAt()

      The timestamp of when the notebook run was created.

      Returns:
      The timestamp of when the notebook run was created.

    • createdBy

      public final String createdBy()

      The identifier of the user who created the notebook run.

      Returns:
      The identifier of the user who created the notebook run.

    • updatedAt

      public final Instant updatedAt()

      The timestamp of when the notebook run was last updated.

      Returns:
      The timestamp of when the notebook run was last updated.

    • updatedBy

      public final String updatedBy()

      The identifier of the user who last updated the notebook run.

      Returns:
      The identifier of the user who last updated the notebook run.

    • startedAt

      public final Instant startedAt()

      The timestamp of when the notebook run started executing.

      Returns:
      The timestamp of when the notebook run started executing.

    • completedAt

      public final Instant completedAt()

      The timestamp of when the notebook run completed.

      Returns:
      The timestamp of when the notebook run completed.

    • toBuilder

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

    • builder

      public static NotebookRunSummary.Builder builder()

    • serializableBuilderClass

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