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

Class SpaceSettings

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.SpaceSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SpaceSettings.Builder,SpaceSettings>

@Generated("software.amazon.awssdk:codegen")
public final class SpaceSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SpaceSettings.Builder,SpaceSettings>

A collection of space settings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpaceSettings.Builder

Method Summary

Modifier and Type	Method	Description
AppType	appType()	The type of app created within the space.
String	appTypeAsString()	The type of app created within the space.
static SpaceSettings.Builder	builder()
SpaceCodeEditorAppSettings	codeEditorAppSettings()	The Code Editor application settings.
List<CustomFileSystem>	customFileSystems()	A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCustomFileSystems()	For responses, this returns true if the service returned a value for the CustomFileSystems property.
int	hashCode()
SpaceJupyterLabAppSettings	jupyterLabAppSettings()	The settings for the JupyterLab application.
JupyterServerAppSettings	jupyterServerAppSettings()	Returns the value of the JupyterServerAppSettings property for this object.
KernelGatewayAppSettings	kernelGatewayAppSettings()	Returns the value of the KernelGatewayAppSettings property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SpaceSettings.Builder>	serializableBuilderClass()
SpaceStorageSettings	spaceStorageSettings()	The storage settings for a space.
SpaceSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

jupyterServerAppSettings

public final JupyterServerAppSettings jupyterServerAppSettings()

Returns the value of the JupyterServerAppSettings property for this object.

Returns:

The value of the JupyterServerAppSettings property for this object.

kernelGatewayAppSettings

public final KernelGatewayAppSettings kernelGatewayAppSettings()

Returns the value of the KernelGatewayAppSettings property for this object.

Returns:

The value of the KernelGatewayAppSettings property for this object.

codeEditorAppSettings

public final SpaceCodeEditorAppSettings codeEditorAppSettings()

The Code Editor application settings.

Returns:

The Code Editor application settings.

jupyterLabAppSettings

public final SpaceJupyterLabAppSettings jupyterLabAppSettings()

The settings for the JupyterLab application.

Returns:

The settings for the JupyterLab application.

appType

public final AppType appType()

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

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

Returns:

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

See Also:

AppType

appTypeAsString

public final String appTypeAsString()

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

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

Returns:

The type of app created within the space.

If using the UpdateSpace API, you can't change the app type of your space by specifying a different value for this field.

See Also:

AppType

spaceStorageSettings

public final SpaceStorageSettings spaceStorageSettings()

The storage settings for a space.

Returns:

The storage settings for a space.

hasCustomFileSystems

public final boolean hasCustomFileSystems()

For responses, this returns true if the service returned a value for the CustomFileSystems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

customFileSystems

public final List<CustomFileSystem> customFileSystems()

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomFileSystems() method.

Returns:

A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.

toBuilder

public SpaceSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SpaceSettings.Builder,SpaceSettings>

builder

public static SpaceSettings.Builder builder()

serializableBuilderClass

public static Class<? extends SpaceSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo