Class EndpointInput
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.EndpointInput
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EndpointInput.Builder,EndpointInput>
@Generated("software.amazon.awssdk:codegen") public final class EndpointInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EndpointInput.Builder,EndpointInput>
Input object for the endpoint
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
EndpointInput.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EndpointInput.Builder
builder()
String
endpointName()
An endpoint in customer's account which has enabledDataCaptureConfig
enabled.String
endTimeOffset()
If specified, monitoring jobs substract this time from the end time.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
excludeFeaturesAttribute()
The attributes of the input data to exclude from the analysis.String
featuresAttribute()
The attributes of the input data that are the input features.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
inferenceAttribute()
The attribute of the input data that represents the ground truth label.String
localPath()
Path to the filesystem where the endpoint data is available to the container.String
probabilityAttribute()
In a classification problem, the attribute that represents the class probability.Double
probabilityThresholdAttribute()
The threshold for the class probability to be evaluated as a positive result.ProcessingS3DataDistributionType
s3DataDistributionType()
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.String
s3DataDistributionTypeAsString()
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key.ProcessingS3InputMode
s3InputMode()
Whether thePipe
orFile
is used as the input mode for transferring data for the monitoring job.String
s3InputModeAsString()
Whether thePipe
orFile
is used as the input mode for transferring data for the monitoring job.List<SdkField<?>>
sdkFields()
static Class<? extends EndpointInput.Builder>
serializableBuilderClass()
String
startTimeOffset()
If specified, monitoring jobs substract this time from the start time.EndpointInput.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
endpointName
public final String endpointName()
An endpoint in customer's account which has enabled
DataCaptureConfig
enabled.- Returns:
- An endpoint in customer's account which has enabled
DataCaptureConfig
enabled.
-
localPath
public final String localPath()
Path to the filesystem where the endpoint data is available to the container.
- Returns:
- Path to the filesystem where the endpoint data is available to the container.
-
s3InputMode
public final ProcessingS3InputMode s3InputMode()
Whether the
Pipe
orFile
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 toFile
.If the service returns an enum value that is not available in the current SDK version,
s3InputMode
will returnProcessingS3InputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3InputModeAsString()
.- Returns:
- Whether the
Pipe
orFile
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 toFile
. - See Also:
ProcessingS3InputMode
-
s3InputModeAsString
public final String s3InputModeAsString()
Whether the
Pipe
orFile
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 toFile
.If the service returns an enum value that is not available in the current SDK version,
s3InputMode
will returnProcessingS3InputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3InputModeAsString()
.- Returns:
- Whether the
Pipe
orFile
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 toFile
. - See Also:
ProcessingS3InputMode
-
s3DataDistributionType
public final ProcessingS3DataDistributionType s3DataDistributionType()
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to
FullyReplicated
If the service returns an enum value that is not available in the current SDK version,
s3DataDistributionType
will returnProcessingS3DataDistributionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3DataDistributionTypeAsString()
.- Returns:
- Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults
to
FullyReplicated
- See Also:
ProcessingS3DataDistributionType
-
s3DataDistributionTypeAsString
public final String s3DataDistributionTypeAsString()
Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to
FullyReplicated
If the service returns an enum value that is not available in the current SDK version,
s3DataDistributionType
will returnProcessingS3DataDistributionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3DataDistributionTypeAsString()
.- Returns:
- Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults
to
FullyReplicated
- See Also:
ProcessingS3DataDistributionType
-
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 substract 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 substract 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 EndpointInput.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<EndpointInput.Builder,EndpointInput>
-
builder
public static EndpointInput.Builder builder()
-
serializableBuilderClass
public static Class<? extends EndpointInput.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-