Class DescribeAppResponse

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

  • Method Details

    • appArn

      public final String appArn()

      The Amazon Resource Name (ARN) of the app.

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

    • appType

      public final AppType appType()

      The type of app.

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

      Returns:
      The type of app.
      See Also:

    • appTypeAsString

      public final String appTypeAsString()

      The type of app.

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

      Returns:
      The type of app.
      See Also:

    • appName

      public final String appName()

      The name of the app.

      Returns:
      The name of the app.

    • domainId

      public final String domainId()

      The domain ID.

      Returns:
      The domain ID.

    • userProfileName

      public final String userProfileName()

      The user profile name.

      Returns:
      The user profile name.

    • spaceName

      public final String spaceName()

      The name of the space. If this value is not set, then UserProfileName must be set.

      Returns:
      The name of the space. If this value is not set, then UserProfileName must be set.

    • status

      public final AppStatus status()

      The status.

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

      Returns:
      The status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status.

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

      Returns:
      The status.
      See Also:

    • lastHealthCheckTimestamp

      public final Instant lastHealthCheckTimestamp()

      The timestamp of the last health check.

      Returns:
      The timestamp of the last health check.

    • lastUserActivityTimestamp

      public final Instant lastUserActivityTimestamp()

      The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

      Returns:
      The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

    • creationTime

      public final Instant creationTime()

      The creation time of the application.

      After an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.

      Returns:
      The creation time of the application.

      After an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.

    • failureReason

      public final String failureReason()

      The failure reason.

      Returns:
      The failure reason.

    • resourceSpec

      public final ResourceSpec resourceSpec()

      The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      Returns:
      The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

    • builtInLifecycleConfigArn

      public final String builtInLifecycleConfigArn()

      The lifecycle configuration that runs before the default lifecycle configuration

      Returns:
      The lifecycle configuration that runs before the default lifecycle configuration

    • toBuilder

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

    • builder

      public static DescribeAppResponse.Builder builder()

    • serializableBuilderClass

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