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

Class DescribeSpaceResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSpaceResponse.Builder,DescribeSpaceResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeSpaceResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeSpaceResponse.Builder,DescribeSpaceResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSpaceResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeSpaceResponse.Builder	builder()
Instant	creationTime()	The creation time.
String	domainId()	The ID of the associated domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	The failure reason.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	homeEfsFileSystemUid()	The ID of the space's profile in the Amazon EFS volume.
Instant	lastModifiedTime()	The last modified time.
OwnershipSettings	ownershipSettings()	The collection of ownership settings for a space.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSpaceResponse.Builder>	serializableBuilderClass()
String	spaceArn()	The space's Amazon Resource Name (ARN).
String	spaceDisplayName()	The name of the space that appears in the Amazon SageMaker Studio UI.
String	spaceName()	The name of the space.
SpaceSettings	spaceSettings()	A collection of space settings.
SpaceSharingSettings	spaceSharingSettings()	The collection of space sharing settings for a space.
SpaceStatus	status()	The status.
String	statusAsString()	The status.
DescribeSpaceResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	url()	Returns the URL of the space.

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

domainId

public final String domainId()

The ID of the associated domain.

Returns:

The ID of the associated domain.

spaceArn

public final String spaceArn()

The space's Amazon Resource Name (ARN).

Returns:

The space's Amazon Resource Name (ARN).

spaceName

public final String spaceName()

The name of the space.

Returns:

The name of the space.

homeEfsFileSystemUid

public final String homeEfsFileSystemUid()

The ID of the space's profile in the Amazon EFS volume.

Returns:

The ID of the space's profile in the Amazon EFS volume.

status

public final SpaceStatus status()

The status.

If the service returns an enum value that is not available in the current SDK version, status will return SpaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status.

See Also:

SpaceStatus

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 SpaceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status.

See Also:

SpaceStatus

lastModifiedTime

public final Instant lastModifiedTime()

The last modified time.

Returns:

The last modified time.

creationTime

public final Instant creationTime()

The creation time.

Returns:

The creation time.

failureReason

public final String failureReason()

The failure reason.

Returns:

The failure reason.

spaceSettings

public final SpaceSettings spaceSettings()

A collection of space settings.

Returns:

A collection of space settings.

ownershipSettings

public final OwnershipSettings ownershipSettings()

The collection of ownership settings for a space.

Returns:

The collection of ownership settings for a space.

spaceSharingSettings

public final SpaceSharingSettings spaceSharingSettings()

The collection of space sharing settings for a space.

Returns:

The collection of space sharing settings for a space.

spaceDisplayName

public final String spaceDisplayName()

The name of the space that appears in the Amazon SageMaker Studio UI.

Returns:

The name of the space that appears in the Amazon SageMaker Studio UI.

url

public final 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

Returns:

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

toBuilder

public DescribeSpaceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSpaceResponse.Builder,DescribeSpaceResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeSpaceResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSpaceResponse.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