Interface DescribeAppResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribeAppResponse.Builder,DescribeAppResponse>,SageMakerResponse.Builder,SdkBuilder<DescribeAppResponse.Builder,DescribeAppResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribeAppResponse
public static interface DescribeAppResponse.Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeAppResponse.Builder,DescribeAppResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribeAppResponse.BuilderappArn(String appArn)The Amazon Resource Name (ARN) of the app.DescribeAppResponse.BuilderappName(String appName)The name of the app.DescribeAppResponse.BuilderappType(String appType)The type of app.DescribeAppResponse.BuilderappType(AppType appType)The type of app.DescribeAppResponse.BuilderbuiltInLifecycleConfigArn(String builtInLifecycleConfigArn)The lifecycle configuration that runs before the default lifecycle configurationDescribeAppResponse.BuildercreationTime(Instant creationTime)The creation time of the application.DescribeAppResponse.BuilderdomainId(String domainId)The domain ID.DescribeAppResponse.BuilderfailureReason(String failureReason)The failure reason.DescribeAppResponse.BuilderlastHealthCheckTimestamp(Instant lastHealthCheckTimestamp)The timestamp of the last health check.DescribeAppResponse.BuilderlastUserActivityTimestamp(Instant lastUserActivityTimestamp)The timestamp of the last user's activity.default DescribeAppResponse.BuilderresourceSpec(Consumer<ResourceSpec.Builder> resourceSpec)The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.DescribeAppResponse.BuilderresourceSpec(ResourceSpec resourceSpec)The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.DescribeAppResponse.BuilderspaceName(String spaceName)The name of the space.DescribeAppResponse.Builderstatus(String status)The status.DescribeAppResponse.Builderstatus(AppStatus status)The status.DescribeAppResponse.BuilderuserProfileName(String userProfileName)The user profile name.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
appArn
DescribeAppResponse.Builder appArn(String appArn)
The Amazon Resource Name (ARN) of the app.
- Parameters:
appArn- The Amazon Resource Name (ARN) of the app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
appType
DescribeAppResponse.Builder appType(String appType)
The type of app.
-
appType
DescribeAppResponse.Builder appType(AppType appType)
The type of app.
-
appName
DescribeAppResponse.Builder appName(String appName)
The name of the app.
- Parameters:
appName- The name of the app.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainId
DescribeAppResponse.Builder domainId(String domainId)
The domain ID.
- Parameters:
domainId- The domain ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userProfileName
DescribeAppResponse.Builder userProfileName(String userProfileName)
The user profile name.
- Parameters:
userProfileName- The user profile name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spaceName
DescribeAppResponse.Builder spaceName(String spaceName)
The name of the space. If this value is not set, then
UserProfileNamemust be set.- Parameters:
spaceName- The name of the space. If this value is not set, thenUserProfileNamemust be set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
DescribeAppResponse.Builder status(String status)
The status.
-
status
DescribeAppResponse.Builder status(AppStatus status)
The status.
-
lastHealthCheckTimestamp
DescribeAppResponse.Builder lastHealthCheckTimestamp(Instant lastHealthCheckTimestamp)
The timestamp of the last health check.
- Parameters:
lastHealthCheckTimestamp- The timestamp of the last health check.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUserActivityTimestamp
DescribeAppResponse.Builder lastUserActivityTimestamp(Instant lastUserActivityTimestamp)
The timestamp of the last user's activity.
LastUserActivityTimestampis also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value asLastHealthCheckTimestamp.- Parameters:
lastUserActivityTimestamp- The timestamp of the last user's activity.LastUserActivityTimestampis also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value asLastHealthCheckTimestamp.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTime
DescribeAppResponse.Builder creationTime(Instant creationTime)
The creation time of the application.
After an application has been shut down for 24 hours, SageMaker AI 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.
- Parameters:
creationTime- The creation time of the application.After an application has been shut down for 24 hours, SageMaker AI 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:
- Returns a reference to this object so that method calls can be chained together.
-
failureReason
DescribeAppResponse.Builder failureReason(String failureReason)
The failure reason.
- Parameters:
failureReason- The failure reason.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceSpec
DescribeAppResponse.Builder resourceSpec(ResourceSpec resourceSpec)
The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.
- Parameters:
resourceSpec- The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceSpec
default DescribeAppResponse.Builder resourceSpec(Consumer<ResourceSpec.Builder> resourceSpec)
The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.
This is a convenience method that creates an instance of theResourceSpec.Builderavoiding the need to create one manually viaResourceSpec.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toresourceSpec(ResourceSpec).- Parameters:
resourceSpec- a consumer that will call methods onResourceSpec.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
resourceSpec(ResourceSpec)
-
builtInLifecycleConfigArn
DescribeAppResponse.Builder builtInLifecycleConfigArn(String builtInLifecycleConfigArn)
The lifecycle configuration that runs before the default lifecycle configuration
- Parameters:
builtInLifecycleConfigArn- The lifecycle configuration that runs before the default lifecycle configuration- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-