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:

  • Method Details

    • 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:

    • 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:

    • spaceStorageSettings

      public final SpaceStorageSettings spaceStorageSettings()

      The storage settings for a space.

      Returns:
      The storage settings for a space.

    • spaceManagedResources

      public final FeatureStatus spaceManagedResources()

      If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:

      • The user profile that possesses the space.

      • The app that the space contains.

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

      Returns:
      If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:

      • The user profile that possesses the space.

      • The app that the space contains.

      See Also:

    • spaceManagedResourcesAsString

      public final String spaceManagedResourcesAsString()

      If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:

      • The user profile that possesses the space.

      • The app that the space contains.

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

      Returns:
      If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:

      • The user profile that possesses the space.

      • The app that the space contains.

      See Also:

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

    • remoteAccess

      public final FeatureStatus remoteAccess()

      A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

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

      Returns:
      A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.
      See Also:

    • remoteAccessAsString

      public final String remoteAccessAsString()

      A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.

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

      Returns:
      A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.
      See Also:

    • toBuilder

      public SpaceSettings.Builder 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 interface ToCopyableBuilder<SpaceSettings.Builder,SpaceSettings>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.