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

Interface DescribeSpaceResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeSpaceResponse.Builder,DescribeSpaceResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeSpaceResponse.Builder,DescribeSpaceResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeSpaceResponse

public static interface DescribeSpaceResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeSpaceResponse.Builder,DescribeSpaceResponse>

Method Summary

Modifier and Type	Method	Description
DescribeSpaceResponse.Builder	creationTime(Instant creationTime)	The creation time.
DescribeSpaceResponse.Builder	domainId(String domainId)	The ID of the associated domain.
DescribeSpaceResponse.Builder	failureReason(String failureReason)	The failure reason.
DescribeSpaceResponse.Builder	homeEfsFileSystemUid(String homeEfsFileSystemUid)	The ID of the space's profile in the Amazon EFS volume.
DescribeSpaceResponse.Builder	lastModifiedTime(Instant lastModifiedTime)	The last modified time.
default DescribeSpaceResponse.Builder	ownershipSettings(Consumer<OwnershipSettings.Builder> ownershipSettings)	The collection of ownership settings for a space.
DescribeSpaceResponse.Builder	ownershipSettings(OwnershipSettings ownershipSettings)	The collection of ownership settings for a space.
DescribeSpaceResponse.Builder	spaceArn(String spaceArn)	The space's Amazon Resource Name (ARN).
DescribeSpaceResponse.Builder	spaceDisplayName(String spaceDisplayName)	The name of the space that appears in the Amazon SageMaker Studio UI.
DescribeSpaceResponse.Builder	spaceName(String spaceName)	The name of the space.
default DescribeSpaceResponse.Builder	spaceSettings(Consumer<SpaceSettings.Builder> spaceSettings)	A collection of space settings.
DescribeSpaceResponse.Builder	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.
DescribeSpaceResponse.Builder	spaceSharingSettings(SpaceSharingSettings spaceSharingSettings)	The collection of space sharing settings for a space.
DescribeSpaceResponse.Builder	status(String status)	The status.
DescribeSpaceResponse.Builder	status(SpaceStatus status)	The status.
DescribeSpaceResponse.Builder	url(String url)	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 Detail

domainId

DescribeSpaceResponse.Builder domainId(String 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

DescribeSpaceResponse.Builder spaceArn(String 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

DescribeSpaceResponse.Builder spaceName(String 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

DescribeSpaceResponse.Builder homeEfsFileSystemUid(String 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

DescribeSpaceResponse.Builder status(String status)

The status.

Parameters:

status - The status.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpaceStatus, SpaceStatus

status

DescribeSpaceResponse.Builder status(SpaceStatus status)

The status.

Parameters:

status - The status.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpaceStatus, SpaceStatus

lastModifiedTime

DescribeSpaceResponse.Builder lastModifiedTime(Instant 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

DescribeSpaceResponse.Builder creationTime(Instant 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

DescribeSpaceResponse.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.

spaceSettings

DescribeSpaceResponse.Builder spaceSettings(SpaceSettings 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

default DescribeSpaceResponse.Builder spaceSettings(Consumer<SpaceSettings.Builder> spaceSettings)

A collection of space settings.

This is a convenience method that creates an instance of the SpaceSettings.Builder avoiding the need to create one manually via SpaceSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spaceSettings(SpaceSettings).

Parameters:

spaceSettings - a consumer that will call methods on SpaceSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

spaceSettings(SpaceSettings)

ownershipSettings

DescribeSpaceResponse.Builder ownershipSettings(OwnershipSettings 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 the OwnershipSettings.Builder avoiding the need to create one manually via OwnershipSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ownershipSettings(OwnershipSettings).

Parameters:

ownershipSettings - a consumer that will call methods on OwnershipSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ownershipSettings(OwnershipSettings)

spaceSharingSettings

DescribeSpaceResponse.Builder spaceSharingSettings(SpaceSharingSettings 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 the SpaceSharingSettings.Builder avoiding the need to create one manually via SpaceSharingSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spaceSharingSettings(SpaceSharingSettings).

Parameters:

spaceSharingSettings - a consumer that will call methods on SpaceSharingSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

spaceSharingSettings(SpaceSharingSettings)

spaceDisplayName

DescribeSpaceResponse.Builder spaceDisplayName(String 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

DescribeSpaceResponse.Builder url(String 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.