Class BatchTransformInput

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

Input object for the batch transform job.

See Also:

  • Method Details

    • dataCapturedDestinationS3Uri

      public final String dataCapturedDestinationS3Uri()

      The Amazon S3 location being used to capture the data.

      Returns:
      The Amazon S3 location being used to capture the data.

    • datasetFormat

      public final MonitoringDatasetFormat datasetFormat()

      The dataset format for your batch transform job.

      Returns:
      The dataset format for your batch transform job.

    • localPath

      public final String localPath()

      Path to the filesystem where the batch transform data is available to the container.

      Returns:
      Path to the filesystem where the batch transform data is available to the container.

    • s3InputMode

      public final ProcessingS3InputMode s3InputMode()

      Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

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

      Returns:
      Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.
      See Also:

    • s3InputModeAsString

      public final String s3InputModeAsString()

      Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

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

      Returns:
      Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.
      See Also:

    • s3DataDistributionType

      public final ProcessingS3DataDistributionType s3DataDistributionType()

      Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

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

      Returns:
      Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
      See Also:

    • s3DataDistributionTypeAsString

      public final String s3DataDistributionTypeAsString()

      Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

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

      Returns:
      Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
      See Also:

    • featuresAttribute

      public final String featuresAttribute()

      The attributes of the input data that are the input features.

      Returns:
      The attributes of the input data that are the input features.

    • inferenceAttribute

      public final String inferenceAttribute()

      The attribute of the input data that represents the ground truth label.

      Returns:
      The attribute of the input data that represents the ground truth label.

    • probabilityAttribute

      public final String probabilityAttribute()

      In a classification problem, the attribute that represents the class probability.

      Returns:
      In a classification problem, the attribute that represents the class probability.

    • probabilityThresholdAttribute

      public final Double probabilityThresholdAttribute()

      The threshold for the class probability to be evaluated as a positive result.

      Returns:
      The threshold for the class probability to be evaluated as a positive result.

    • startTimeOffset

      public final String startTimeOffset()

      If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

      Returns:
      If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

    • endTimeOffset

      public final String endTimeOffset()

      If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

      Returns:
      If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

    • excludeFeaturesAttribute

      public final String excludeFeaturesAttribute()

      The attributes of the input data to exclude from the analysis.

      Returns:
      The attributes of the input data to exclude from the analysis.

    • toBuilder

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

    • builder

      public static BatchTransformInput.Builder builder()

    • serializableBuilderClass

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