Class DescribeAppResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeAppResponse.Builder,
DescribeAppResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
appArn()
The Amazon Resource Name (ARN) of the app.final String
appName()
The name of the app.final AppType
appType()
The type of app.final String
The type of app.static DescribeAppResponse.Builder
builder()
final Instant
The creation time of the application.final String
domainId()
The domain ID.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The failure reason.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Instant
The timestamp of the last health check.final Instant
The timestamp of the last user's activity.final ResourceSpec
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.static Class
<? extends DescribeAppResponse.Builder> final String
The name of the space.final AppStatus
status()
The status.final String
The status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
appArn
The Amazon Resource Name (ARN) of the app.
- Returns:
- The Amazon Resource Name (ARN) of the app.
-
appType
The type of app.
If the service returns an enum value that is not available in the current SDK version,
appType
will returnAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappTypeAsString()
.- Returns:
- The type of app.
- See Also:
-
appTypeAsString
The type of app.
If the service returns an enum value that is not available in the current SDK version,
appType
will returnAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappTypeAsString()
.- Returns:
- The type of app.
- See Also:
-
appName
The name of the app.
- Returns:
- The name of the app.
-
domainId
The domain ID.
- Returns:
- The domain ID.
-
userProfileName
The user profile name.
- Returns:
- The user profile name.
-
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
The status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnAppStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status.
- See Also:
-
statusAsString
The status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnAppStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status.
- See Also:
-
lastHealthCheckTimestamp
The timestamp of the last health check.
- Returns:
- The timestamp of the last health check.
-
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 asLastHealthCheckTimestamp
.- 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 asLastHealthCheckTimestamp
.
-
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
The failure reason.
- Returns:
- The failure reason.
-
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
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 interfaceToCopyableBuilder<DescribeAppResponse.Builder,
DescribeAppResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-