Class DescribeSpaceResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeSpaceResponse.Builder,
DescribeSpaceResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The creation time.final String
domainId()
The ID of the associated domain.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 String
The ID of the space's profile in the Amazon EFS volume.final Instant
The last modified time.final OwnershipSettings
The collection of ownership settings for a space.static Class
<? extends DescribeSpaceResponse.Builder> final String
spaceArn()
The space's Amazon Resource Name (ARN).final String
The name of the space that appears in the Amazon SageMaker Studio UI.final String
The name of the space.final SpaceSettings
A collection of space settings.final SpaceSharingSettings
The collection of space sharing settings for a space.final SpaceStatus
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
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainId
The ID of the associated domain.
- Returns:
- The ID of the associated domain.
-
spaceArn
The space's Amazon Resource Name (ARN).
- Returns:
- The space's Amazon Resource Name (ARN).
-
spaceName
The name of the space.
- Returns:
- The name of the space.
-
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
The status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnSpaceStatus.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 returnSpaceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status.
- See Also:
-
lastModifiedTime
The last modified time.
- Returns:
- The last modified time.
-
creationTime
The creation time.
- Returns:
- The creation time.
-
failureReason
The failure reason.
- Returns:
- The failure reason.
-
spaceSettings
A collection of space settings.
- Returns:
- A collection of space settings.
-
ownershipSettings
The collection of ownership settings for a space.
- Returns:
- The collection of ownership settings for a space.
-
spaceSharingSettings
The collection of space sharing settings for a space.
- Returns:
- The collection of space sharing settings for a space.
-
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
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
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<DescribeSpaceResponse.Builder,
DescribeSpaceResponse> - 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
-