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

Class ProcessingS3Output

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

Configuration for uploading output data to Amazon S3 from the processing container.

See Also:

  • Method Details

    • s3Uri

      public final String s3Uri()

      A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

      Returns:
      A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

    • localPath

      public final String localPath()

      The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.

      Returns:
      The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.

    • s3UploadMode

      public final ProcessingS3UploadMode s3UploadMode()

      Whether to upload the results of the processing job continuously or after the job completes.

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

      Returns:
      Whether to upload the results of the processing job continuously or after the job completes.
      See Also:

    • s3UploadModeAsString

      public final String s3UploadModeAsString()

      Whether to upload the results of the processing job continuously or after the job completes.

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

      Returns:
      Whether to upload the results of the processing job continuously or after the job completes.
      See Also:

    • toBuilder

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

    • builder

      public static ProcessingS3Output.Builder builder()

    • serializableBuilderClass

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