software.amazon.awssdk.services.machinelearning.model

Class CreateBatchPredictionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.machinelearning.model.MachineLearningRequest

software.amazon.awssdk.services.machinelearning.model.CreateBatchPredictionRequest

All Implemented Interfaces:

ToCopyableBuilder<CreateBatchPredictionRequest.Builder,CreateBatchPredictionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class CreateBatchPredictionRequest
extends MachineLearningRequest
implements ToCopyableBuilder<CreateBatchPredictionRequest.Builder,CreateBatchPredictionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBatchPredictionRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	batchPredictionDataSourceId() The ID of the DataSource that points to the group of observations to predict.
String	batchPredictionId() A user-supplied ID that uniquely identifies the BatchPrediction.
String	batchPredictionName() A user-supplied name or description of the BatchPrediction.
static CreateBatchPredictionRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	mlModelId() The ID of the MLModel that will generate predictions for the group of observations.
String	outputUri() The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results.
static Class<? extends CreateBatchPredictionRequest.Builder>	serializableBuilderClass()
CreateBatchPredictionRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

batchPredictionId

public String batchPredictionId()

A user-supplied ID that uniquely identifies the BatchPrediction.

Returns:

A user-supplied ID that uniquely identifies the BatchPrediction.

batchPredictionName

public String batchPredictionName()

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

Returns:

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

mlModelId

public String mlModelId()

The ID of the MLModel that will generate predictions for the group of observations.

Returns:

The ID of the MLModel that will generate predictions for the group of observations.

batchPredictionDataSourceId

public String batchPredictionDataSourceId()

The ID of the DataSource that points to the group of observations to predict.

Returns:

The ID of the DataSource that points to the group of observations to predict.

outputUri

public String outputUri()

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

Returns:

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

toBuilder

public CreateBatchPredictionRequest.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<CreateBatchPredictionRequest.Builder,CreateBatchPredictionRequest>

Specified by:

toBuilder in class MachineLearningRequest

Returns:

a builder for type T

builder

public static CreateBatchPredictionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBatchPredictionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value