Class FileSystemDataSource

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

Specifies a file system data source for a channel.

See Also:

  • Method Details

    • fileSystemId

      public final String fileSystemId()

      The file system id.

      Returns:
      The file system id.

    • fileSystemAccessMode

      public final FileSystemAccessMode fileSystemAccessMode()

      The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

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

      Returns:
      The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
      See Also:

    • fileSystemAccessModeAsString

      public final String fileSystemAccessModeAsString()

      The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

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

      Returns:
      The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.
      See Also:

    • fileSystemType

      public final FileSystemType fileSystemType()

      The file system type.

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

      Returns:
      The file system type.
      See Also:

    • fileSystemTypeAsString

      public final String fileSystemTypeAsString()

      The file system type.

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

      Returns:
      The file system type.
      See Also:

    • directoryPath

      public final String directoryPath()

      The full path to the directory to associate with the channel.

      Returns:
      The full path to the directory to associate with the channel.

    • toBuilder

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

    • builder

      public static FileSystemDataSource.Builder builder()

    • serializableBuilderClass

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