BatchTransformInput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.BatchTransformInput

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchTransformInput
extends Object
implements Serializable, Cloneable, StructuredPojo

Input object for the batch transform job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchTransformInput()

Constructors
Constructor and Description
`BatchTransformInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchTransformInput`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataCapturedDestinationS3Uri()` The Amazon S3 location being used to capture the data.
`MonitoringDatasetFormat`	`getDatasetFormat()` The dataset format for your batch transform job.
`String`	`getEndTimeOffset()` If specified, monitoring jobs subtract this time from the end time.
`String`	`getExcludeFeaturesAttribute()` The attributes of the input data to exclude from the analysis.
`String`	`getFeaturesAttribute()` The attributes of the input data that are the input features.
`String`	`getInferenceAttribute()` The attribute of the input data that represents the ground truth label.
`String`	`getLocalPath()` Path to the filesystem where the batch transform data is available to the container.
`String`	`getProbabilityAttribute()` In a classification problem, the attribute that represents the class probability.
`Double`	`getProbabilityThresholdAttribute()` The threshold for the class probability to be evaluated as a positive result.
`String`	`getS3DataDistributionType()` Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
`String`	`getS3InputMode()` Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
`String`	`getStartTimeOffset()` If specified, monitoring jobs substract this time from the start time.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataCapturedDestinationS3Uri(String dataCapturedDestinationS3Uri)` The Amazon S3 location being used to capture the data.
`void`	`setDatasetFormat(MonitoringDatasetFormat datasetFormat)` The dataset format for your batch transform job.
`void`	`setEndTimeOffset(String endTimeOffset)` If specified, monitoring jobs subtract this time from the end time.
`void`	`setExcludeFeaturesAttribute(String excludeFeaturesAttribute)` The attributes of the input data to exclude from the analysis.
`void`	`setFeaturesAttribute(String featuresAttribute)` The attributes of the input data that are the input features.
`void`	`setInferenceAttribute(String inferenceAttribute)` The attribute of the input data that represents the ground truth label.
`void`	`setLocalPath(String localPath)` Path to the filesystem where the batch transform data is available to the container.
`void`	`setProbabilityAttribute(String probabilityAttribute)` In a classification problem, the attribute that represents the class probability.
`void`	`setProbabilityThresholdAttribute(Double probabilityThresholdAttribute)` The threshold for the class probability to be evaluated as a positive result.
`void`	`setS3DataDistributionType(String s3DataDistributionType)` Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
`void`	`setS3InputMode(String s3InputMode)` Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
`void`	`setStartTimeOffset(String startTimeOffset)` If specified, monitoring jobs substract this time from the start time.
`String`	`toString()` Returns a string representation of this object.
`BatchTransformInput`	`withDataCapturedDestinationS3Uri(String dataCapturedDestinationS3Uri)` The Amazon S3 location being used to capture the data.
`BatchTransformInput`	`withDatasetFormat(MonitoringDatasetFormat datasetFormat)` The dataset format for your batch transform job.
`BatchTransformInput`	`withEndTimeOffset(String endTimeOffset)` If specified, monitoring jobs subtract this time from the end time.
`BatchTransformInput`	`withExcludeFeaturesAttribute(String excludeFeaturesAttribute)` The attributes of the input data to exclude from the analysis.
`BatchTransformInput`	`withFeaturesAttribute(String featuresAttribute)` The attributes of the input data that are the input features.
`BatchTransformInput`	`withInferenceAttribute(String inferenceAttribute)` The attribute of the input data that represents the ground truth label.
`BatchTransformInput`	`withLocalPath(String localPath)` Path to the filesystem where the batch transform data is available to the container.
`BatchTransformInput`	`withProbabilityAttribute(String probabilityAttribute)` In a classification problem, the attribute that represents the class probability.
`BatchTransformInput`	`withProbabilityThresholdAttribute(Double probabilityThresholdAttribute)` The threshold for the class probability to be evaluated as a positive result.
`BatchTransformInput`	`withS3DataDistributionType(ProcessingS3DataDistributionType s3DataDistributionType)` Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
`BatchTransformInput`	`withS3DataDistributionType(String s3DataDistributionType)` Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
`BatchTransformInput`	`withS3InputMode(ProcessingS3InputMode s3InputMode)` Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
`BatchTransformInput`	`withS3InputMode(String s3InputMode)` Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
`BatchTransformInput`	`withStartTimeOffset(String startTimeOffset)` If specified, monitoring jobs substract this time from the start time.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchTransformInput
```
public BatchTransformInput()
```
- Method Detail
  - setDataCapturedDestinationS3Uri
```
public void setDataCapturedDestinationS3Uri(String dataCapturedDestinationS3Uri)
```
    The Amazon S3 location being used to capture the data.
    
    Parameters:
    
    dataCapturedDestinationS3Uri - The Amazon S3 location being used to capture the data.
  - getDataCapturedDestinationS3Uri
```
public String getDataCapturedDestinationS3Uri()
```
    The Amazon S3 location being used to capture the data.
    
    Returns:
    
    The Amazon S3 location being used to capture the data.
  - withDataCapturedDestinationS3Uri
```
public BatchTransformInput withDataCapturedDestinationS3Uri(String dataCapturedDestinationS3Uri)
```
    The Amazon S3 location being used to capture the data.
    
    Parameters:
    
    dataCapturedDestinationS3Uri - The Amazon S3 location being used to capture the data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetFormat
```
public void setDatasetFormat(MonitoringDatasetFormat datasetFormat)
```
    The dataset format for your batch transform job.
    
    Parameters:
    
    datasetFormat - The dataset format for your batch transform job.
  - getDatasetFormat
```
public MonitoringDatasetFormat getDatasetFormat()
```
    The dataset format for your batch transform job.
    
    Returns:
    
    The dataset format for your batch transform job.
  - withDatasetFormat
```
public BatchTransformInput withDatasetFormat(MonitoringDatasetFormat datasetFormat)
```
    The dataset format for your batch transform job.
    
    Parameters:
    
    datasetFormat - The dataset format for your batch transform job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocalPath
```
public void setLocalPath(String localPath)
```
    Path to the filesystem where the batch transform data is available to the container.
    
    Parameters:
    
    localPath - Path to the filesystem where the batch transform data is available to the container.
  - getLocalPath
```
public String getLocalPath()
```
    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.
  - withLocalPath
```
public BatchTransformInput withLocalPath(String localPath)
```
    Path to the filesystem where the batch transform data is available to the container.
    
    Parameters:
    
    localPath - Path to the filesystem where the batch transform data is available to the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3InputMode
```
public void setS3InputMode(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ProcessingS3InputMode
  - getS3InputMode
```
public String getS3InputMode()
```
    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.
    
    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:
    
    ProcessingS3InputMode
  - withS3InputMode
```
public BatchTransformInput withS3InputMode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProcessingS3InputMode
  - withS3InputMode
```
public BatchTransformInput withS3InputMode(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProcessingS3InputMode
  - setS3DataDistributionType
```
public void setS3DataDistributionType(String s3DataDistributionType)
```
    Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
    
    Parameters:
    
    s3DataDistributionType - Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
    
    See Also:
    
    ProcessingS3DataDistributionType
  - getS3DataDistributionType
```
public String getS3DataDistributionType()
```
    Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
    
    Returns:
    
    Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
    
    See Also:
    
    ProcessingS3DataDistributionType
  - withS3DataDistributionType
```
public BatchTransformInput withS3DataDistributionType(String s3DataDistributionType)
```
    Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
    
    Parameters:
    
    s3DataDistributionType - Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProcessingS3DataDistributionType
  - withS3DataDistributionType
```
public BatchTransformInput withS3DataDistributionType(ProcessingS3DataDistributionType s3DataDistributionType)
```
    Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
    
    Parameters:
    
    s3DataDistributionType - Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProcessingS3DataDistributionType
  - setFeaturesAttribute
```
public void setFeaturesAttribute(String featuresAttribute)
```
    The attributes of the input data that are the input features.
    
    Parameters:
    
    featuresAttribute - The attributes of the input data that are the input features.
  - getFeaturesAttribute
```
public String getFeaturesAttribute()
```
    The attributes of the input data that are the input features.
    
    Returns:
    
    The attributes of the input data that are the input features.
  - withFeaturesAttribute
```
public BatchTransformInput withFeaturesAttribute(String featuresAttribute)
```
    The attributes of the input data that are the input features.
    
    Parameters:
    
    featuresAttribute - The attributes of the input data that are the input features.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInferenceAttribute
```
public void setInferenceAttribute(String inferenceAttribute)
```
    The attribute of the input data that represents the ground truth label.
    
    Parameters:
    
    inferenceAttribute - The attribute of the input data that represents the ground truth label.
  - getInferenceAttribute
```
public String getInferenceAttribute()
```
    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.
  - withInferenceAttribute
```
public BatchTransformInput withInferenceAttribute(String inferenceAttribute)
```
    The attribute of the input data that represents the ground truth label.
    
    Parameters:
    
    inferenceAttribute - The attribute of the input data that represents the ground truth label.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProbabilityAttribute
```
public void setProbabilityAttribute(String probabilityAttribute)
```
    In a classification problem, the attribute that represents the class probability.
    
    Parameters:
    
    probabilityAttribute - In a classification problem, the attribute that represents the class probability.
  - getProbabilityAttribute
```
public String getProbabilityAttribute()
```
    In a classification problem, the attribute that represents the class probability.
    
    Returns:
    
    In a classification problem, the attribute that represents the class probability.
  - withProbabilityAttribute
```
public BatchTransformInput withProbabilityAttribute(String probabilityAttribute)
```
    In a classification problem, the attribute that represents the class probability.
    
    Parameters:
    
    probabilityAttribute - In a classification problem, the attribute that represents the class probability.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProbabilityThresholdAttribute
```
public void setProbabilityThresholdAttribute(Double probabilityThresholdAttribute)
```
    The threshold for the class probability to be evaluated as a positive result.
    
    Parameters:
    
    probabilityThresholdAttribute - The threshold for the class probability to be evaluated as a positive result.
  - getProbabilityThresholdAttribute
```
public Double getProbabilityThresholdAttribute()
```
    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.
  - withProbabilityThresholdAttribute
```
public BatchTransformInput withProbabilityThresholdAttribute(Double probabilityThresholdAttribute)
```
    The threshold for the class probability to be evaluated as a positive result.
    
    Parameters:
    
    probabilityThresholdAttribute - The threshold for the class probability to be evaluated as a positive result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTimeOffset
```
public void setStartTimeOffset(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.
    
    Parameters:
    
    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.
  - getStartTimeOffset
```
public String getStartTimeOffset()
```
    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.
  - withStartTimeOffset
```
public BatchTransformInput withStartTimeOffset(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTimeOffset
```
public void setEndTimeOffset(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.
    
    Parameters:
    
    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.
  - getEndTimeOffset
```
public String getEndTimeOffset()
```
    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.
  - withEndTimeOffset
```
public BatchTransformInput withEndTimeOffset(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExcludeFeaturesAttribute
```
public void setExcludeFeaturesAttribute(String excludeFeaturesAttribute)
```
    The attributes of the input data to exclude from the analysis.
    
    Parameters:
    
    excludeFeaturesAttribute - The attributes of the input data to exclude from the analysis.
  - getExcludeFeaturesAttribute
```
public String getExcludeFeaturesAttribute()
```
    The attributes of the input data to exclude from the analysis.
    
    Returns:
    
    The attributes of the input data to exclude from the analysis.
  - withExcludeFeaturesAttribute
```
public BatchTransformInput withExcludeFeaturesAttribute(String excludeFeaturesAttribute)
```
    The attributes of the input data to exclude from the analysis.
    
    Parameters:
    
    excludeFeaturesAttribute - The attributes of the input data to exclude from the analysis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BatchTransformInput clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class BatchTransformInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchTransformInput

Method Detail

setDataCapturedDestinationS3Uri

getDataCapturedDestinationS3Uri

withDataCapturedDestinationS3Uri

setDatasetFormat

getDatasetFormat

withDatasetFormat

setLocalPath

getLocalPath

withLocalPath

setS3InputMode

getS3InputMode

withS3InputMode

withS3InputMode

setS3DataDistributionType

getS3DataDistributionType

withS3DataDistributionType

withS3DataDistributionType

setFeaturesAttribute

getFeaturesAttribute

withFeaturesAttribute

setInferenceAttribute

getInferenceAttribute

withInferenceAttribute

setProbabilityAttribute

getProbabilityAttribute

withProbabilityAttribute

setProbabilityThresholdAttribute

getProbabilityThresholdAttribute

withProbabilityThresholdAttribute

setStartTimeOffset

getStartTimeOffset

withStartTimeOffset

setEndTimeOffset

getEndTimeOffset

withEndTimeOffset

setExcludeFeaturesAttribute

getExcludeFeaturesAttribute

withExcludeFeaturesAttribute

toString

equals

hashCode

clone

marshall