Class SharingSettings

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.SharingSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SharingSettings.Builder,SharingSettings>
@Generated("software.amazon.awssdk:codegen") public final class SharingSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SharingSettings.Builder,SharingSettings>

Specifies options for sharing Amazon SageMaker AI Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.

See Also:

  • Method Details

    • notebookOutputOption

      public final NotebookOutputOption notebookOutputOption()

      Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

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

      Returns:
      Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
      See Also:

    • notebookOutputOptionAsString

      public final String notebookOutputOptionAsString()

      Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

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

      Returns:
      Whether to include the notebook cell output when sharing the notebook. The default is Disabled.
      See Also:

    • s3OutputPath

      public final String s3OutputPath()

      When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

      Returns:
      When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

    • s3KmsKeyId

      public final String s3KmsKeyId()

      When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

      Returns:
      When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

    • toBuilder

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

    • builder

      public static SharingSettings.Builder builder()

    • serializableBuilderClass

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