Interface DescribeSpaceResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeSpaceResponse.Builder,
,DescribeSpaceResponse> SageMakerResponse.Builder
,SdkBuilder<DescribeSpaceResponse.Builder,
,DescribeSpaceResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeSpaceResponse
-
Method Summary
Modifier and TypeMethodDescriptioncreationTime
(Instant creationTime) The creation time.The ID of the associated domain.failureReason
(String failureReason) The failure reason.homeEfsFileSystemUid
(String homeEfsFileSystemUid) The ID of the space's profile in the Amazon EFS volume.lastModifiedTime
(Instant lastModifiedTime) The last modified time.default DescribeSpaceResponse.Builder
ownershipSettings
(Consumer<OwnershipSettings.Builder> ownershipSettings) The collection of ownership settings for a space.ownershipSettings
(OwnershipSettings ownershipSettings) The collection of ownership settings for a space.The space's Amazon Resource Name (ARN).spaceDisplayName
(String spaceDisplayName) The name of the space that appears in the Amazon SageMaker Studio UI.The name of the space.default DescribeSpaceResponse.Builder
spaceSettings
(Consumer<SpaceSettings.Builder> spaceSettings) A collection of space settings.spaceSettings
(SpaceSettings spaceSettings) A collection of space settings.default DescribeSpaceResponse.Builder
spaceSharingSettings
(Consumer<SpaceSharingSettings.Builder> spaceSharingSettings) The collection of space sharing settings for a space.spaceSharingSettings
(SpaceSharingSettings spaceSharingSettings) The collection of space sharing settings for a space.The status.status
(SpaceStatus status) The status.Returns the URL of the space.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, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
domainId
The ID of the associated domain.
- Parameters:
domainId
- The ID of the associated domain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spaceArn
The space's Amazon Resource Name (ARN).
- Parameters:
spaceArn
- The space's Amazon Resource Name (ARN).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spaceName
The name of the space.
- Parameters:
spaceName
- The name of the space.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeEfsFileSystemUid
The ID of the space's profile in the Amazon EFS volume.
- Parameters:
homeEfsFileSystemUid
- The ID of the space's profile in the Amazon EFS volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status.
- Parameters:
status
- The status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status.
- Parameters:
status
- The status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lastModifiedTime
The last modified time.
- Parameters:
lastModifiedTime
- The last modified time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTime
The creation time.
- Parameters:
creationTime
- The creation time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureReason
The failure reason.
- Parameters:
failureReason
- The failure reason.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spaceSettings
A collection of space settings.
- Parameters:
spaceSettings
- A collection of space settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spaceSettings
A collection of space settings.
This is a convenience method that creates an instance of theSpaceSettings.Builder
avoiding the need to create one manually viaSpaceSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tospaceSettings(SpaceSettings)
.- Parameters:
spaceSettings
- a consumer that will call methods onSpaceSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ownershipSettings
The collection of ownership settings for a space.
- Parameters:
ownershipSettings
- The collection of ownership settings for a space.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ownershipSettings
default DescribeSpaceResponse.Builder ownershipSettings(Consumer<OwnershipSettings.Builder> ownershipSettings) The collection of ownership settings for a space.
This is a convenience method that creates an instance of theOwnershipSettings.Builder
avoiding the need to create one manually viaOwnershipSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toownershipSettings(OwnershipSettings)
.- Parameters:
ownershipSettings
- a consumer that will call methods onOwnershipSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
spaceSharingSettings
The collection of space sharing settings for a space.
- Parameters:
spaceSharingSettings
- The collection of space sharing settings for a space.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spaceSharingSettings
default DescribeSpaceResponse.Builder spaceSharingSettings(Consumer<SpaceSharingSettings.Builder> spaceSharingSettings) The collection of space sharing settings for a space.
This is a convenience method that creates an instance of theSpaceSharingSettings.Builder
avoiding the need to create one manually viaSpaceSharingSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tospaceSharingSettings(SpaceSharingSettings)
.- Parameters:
spaceSharingSettings
- a consumer that will call methods onSpaceSharingSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
spaceDisplayName
The name of the space that appears in the Amazon SageMaker Studio UI.
- Parameters:
spaceDisplayName
- The name of the space that appears in the Amazon SageMaker Studio UI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
url
Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.
The following application types are supported:
-
Studio Classic:
&redirect=JupyterServer
-
JupyterLab:
&redirect=JupyterLab
-
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:
&redirect=CodeEditor
- Parameters:
url
- Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.The following application types are supported:
-
Studio Classic:
&redirect=JupyterServer
-
JupyterLab:
&redirect=JupyterLab
-
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:
&redirect=CodeEditor
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-