software.amazon.awssdk.services.sagemaker.model

Interface BatchTransformInput.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BatchTransformInput.Builder,BatchTransformInput>, SdkBuilder<BatchTransformInput.Builder,BatchTransformInput>, SdkPojo

Enclosing class:

BatchTransformInput

public static interface BatchTransformInput.Builder
extends SdkPojo, CopyableBuilder<BatchTransformInput.Builder,BatchTransformInput>

Method Summary

Modifier and Type	Method and Description
BatchTransformInput.Builder	dataCapturedDestinationS3Uri(String dataCapturedDestinationS3Uri) The Amazon S3 location being used to capture the data.
default BatchTransformInput.Builder	datasetFormat(Consumer<MonitoringDatasetFormat.Builder> datasetFormat) The dataset format for your batch transform job.
BatchTransformInput.Builder	datasetFormat(MonitoringDatasetFormat datasetFormat) The dataset format for your batch transform job.
BatchTransformInput.Builder	endTimeOffset(String endTimeOffset) If specified, monitoring jobs subtract this time from the end time.
BatchTransformInput.Builder	excludeFeaturesAttribute(String excludeFeaturesAttribute) The attributes of the input data to exclude from the analysis.
BatchTransformInput.Builder	featuresAttribute(String featuresAttribute) The attributes of the input data that are the input features.
BatchTransformInput.Builder	inferenceAttribute(String inferenceAttribute) The attribute of the input data that represents the ground truth label.
BatchTransformInput.Builder	localPath(String localPath) Path to the filesystem where the batch transform data is available to the container.
BatchTransformInput.Builder	probabilityAttribute(String probabilityAttribute) In a classification problem, the attribute that represents the class probability.
BatchTransformInput.Builder	probabilityThresholdAttribute(Double probabilityThresholdAttribute) The threshold for the class probability to be evaluated as a positive result.
BatchTransformInput.Builder	s3DataDistributionType(ProcessingS3DataDistributionType s3DataDistributionType) Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
BatchTransformInput.Builder	s3DataDistributionType(String s3DataDistributionType) Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
BatchTransformInput.Builder	s3InputMode(ProcessingS3InputMode s3InputMode) Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.
BatchTransformInput.Builder	s3InputMode(String s3InputMode) Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.
BatchTransformInput.Builder	startTimeOffset(String startTimeOffset) If specified, monitoring jobs substract this time from the start time.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

dataCapturedDestinationS3Uri

BatchTransformInput.Builder dataCapturedDestinationS3Uri(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.

datasetFormat

BatchTransformInput.Builder datasetFormat(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.

datasetFormat

default BatchTransformInput.Builder datasetFormat(Consumer<MonitoringDatasetFormat.Builder> datasetFormat)

The dataset format for your batch transform job.

This is a convenience method that creates an instance of the MonitoringDatasetFormat.Builder avoiding the need to create one manually via MonitoringDatasetFormat.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to datasetFormat(MonitoringDatasetFormat).

Parameters:

datasetFormat - a consumer that will call methods on MonitoringDatasetFormat.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

datasetFormat(MonitoringDatasetFormat)

localPath

BatchTransformInput.Builder localPath(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.

s3InputMode

BatchTransformInput.Builder s3InputMode(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, ProcessingS3InputMode

s3InputMode

BatchTransformInput.Builder s3InputMode(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, ProcessingS3InputMode

s3DataDistributionType

BatchTransformInput.Builder s3DataDistributionType(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, ProcessingS3DataDistributionType

s3DataDistributionType

BatchTransformInput.Builder s3DataDistributionType(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, ProcessingS3DataDistributionType

featuresAttribute

BatchTransformInput.Builder featuresAttribute(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.

inferenceAttribute

BatchTransformInput.Builder inferenceAttribute(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.

probabilityAttribute

BatchTransformInput.Builder probabilityAttribute(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.

probabilityThresholdAttribute

BatchTransformInput.Builder probabilityThresholdAttribute(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.

startTimeOffset

BatchTransformInput.Builder startTimeOffset(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.

endTimeOffset

BatchTransformInput.Builder endTimeOffset(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.

excludeFeaturesAttribute

BatchTransformInput.Builder excludeFeaturesAttribute(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.