Package software.amazon.awssdk.services.sagemaker.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeAppResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	appArn()	The Amazon Resource Name (ARN) of the app.
String	appName()	The name of the app.
AppType	appType()	The type of app.
String	appTypeAsString()	The type of app.
static DescribeAppResponse.Builder	builder()
Instant	creationTime()	The creation time of the application.
String	domainId()	The domain ID.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	The failure reason.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastHealthCheckTimestamp()	The timestamp of the last health check.
Instant	lastUserActivityTimestamp()	The timestamp of the last user's activity.
ResourceSpec	resourceSpec()	The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAppResponse.Builder>	serializableBuilderClass()
String	spaceName()	The name of the space.
AppStatus	status()	The status.
String	statusAsString()	The status.
DescribeAppResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userProfileName()	The user profile name.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

AppType

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:

AppType

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:

AppStatus

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:

AppStatus

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.

toBuilder

public DescribeAppResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAppResponse.Builder,DescribeAppResponse>

Specified by:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo