Class GetNotebookRunResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.datazone.model.DataZoneResponse
software.amazon.awssdk.services.datazone.model.GetNotebookRunResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetNotebookRunResponse.Builder,GetNotebookRunResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetNotebookRunResponse extends DataZoneResponse implements ToCopyableBuilder<GetNotebookRunResponse.Builder,GetNotebookRunResponse>

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

    • hasCellOrder

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

    • cellOrder

      public final List<CellInformation> cellOrder()

      The ordered list of cells in the notebook run.

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

      Returns:
      The ordered list of cells in the notebook run.

    • hasMetadata

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

    • metadata

      public final Map<String,String> metadata()

      The metadata of the notebook run.

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

      Returns:
      The metadata of the notebook run.

    • 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 Map<String,String> parameters()

      The sensitive parameters of the notebook run.

      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:
      The sensitive parameters of the notebook run.

    • computeConfiguration

      public final ComputeConfig computeConfiguration()

      The compute configuration of the notebook run.

      Returns:
      The compute configuration of the notebook run.

    • networkConfiguration

      public final NetworkConfig networkConfiguration()

      The network configuration of the notebook run.

      Returns:
      The network configuration of the notebook run.

    • timeoutConfiguration

      public final TimeoutConfig timeoutConfiguration()

      The timeout configuration of the notebook run.

      Returns:
      The timeout configuration of the notebook run.

    • environmentConfiguration

      public final EnvironmentConfig environmentConfiguration()

      The environment configuration of the notebook run, including image version and package settings.

      Returns:
      The environment configuration of the notebook run, including image version and package settings.

    • storageConfiguration

      public final StorageConfig storageConfiguration()

      The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

      Returns:
      The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

    • triggerSource

      public final TriggerSource triggerSource()

      The source that triggered the notebook run.

      Returns:
      The source that triggered the notebook run.

    • error

      public final NotebookRunError error()

      The error details if the notebook run failed.

      Returns:
      The error details if the notebook run failed.

    • 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 GetNotebookRunResponse.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<GetNotebookRunResponse.Builder,GetNotebookRunResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetNotebookRunResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetNotebookRunResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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