software.amazon.awssdk.services.lookoutequipment.model

Interface CreateModelRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>, LookoutEquipmentRequest.Builder, SdkBuilder<CreateModelRequest.Builder,CreateModelRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateModelRequest

public static interface CreateModelRequest.Builder
extends LookoutEquipmentRequest.Builder, SdkPojo, CopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

Method Summary

Modifier and Type	Method and Description
CreateModelRequest.Builder	clientToken(String clientToken) A unique identifier for the request.
default CreateModelRequest.Builder	dataPreProcessingConfiguration(Consumer<DataPreProcessingConfiguration.Builder> dataPreProcessingConfiguration) The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment.
CreateModelRequest.Builder	dataPreProcessingConfiguration(DataPreProcessingConfiguration dataPreProcessingConfiguration) The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment.
CreateModelRequest.Builder	datasetName(String datasetName) The name of the dataset for the ML model being created.
default CreateModelRequest.Builder	datasetSchema(Consumer<DatasetSchema.Builder> datasetSchema) The data schema for the ML model being created.
CreateModelRequest.Builder	datasetSchema(DatasetSchema datasetSchema) The data schema for the ML model being created.
CreateModelRequest.Builder	evaluationDataEndTime(Instant evaluationDataEndTime) Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.
CreateModelRequest.Builder	evaluationDataStartTime(Instant evaluationDataStartTime) Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.
default CreateModelRequest.Builder	labelsInputConfiguration(Consumer<LabelsInputConfiguration.Builder> labelsInputConfiguration) The input configuration for the labels being used for the ML model that's being created.
CreateModelRequest.Builder	labelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration) The input configuration for the labels being used for the ML model that's being created.
CreateModelRequest.Builder	modelName(String modelName) The name for the ML model to be created.
CreateModelRequest.Builder	offCondition(String offCondition) Indicates that the asset associated with this sensor has been shut off.
CreateModelRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateModelRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateModelRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.
CreateModelRequest.Builder	serverSideKmsKeyId(String serverSideKmsKeyId) Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
CreateModelRequest.Builder	tags(Collection<Tag> tags) Any tags associated with the ML model being created.
CreateModelRequest.Builder	tags(Consumer<Tag.Builder>... tags) Any tags associated with the ML model being created.
CreateModelRequest.Builder	tags(Tag... tags) Any tags associated with the ML model being created.
CreateModelRequest.Builder	trainingDataEndTime(Instant trainingDataEndTime) Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.
CreateModelRequest.Builder	trainingDataStartTime(Instant trainingDataStartTime) Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.

Methods inherited from interface software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

modelName

CreateModelRequest.Builder modelName(String modelName)

The name for the ML model to be created.

Parameters:

modelName - The name for the ML model to be created.

Returns:

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

datasetName

CreateModelRequest.Builder datasetName(String datasetName)

The name of the dataset for the ML model being created.

Parameters:

datasetName - The name of the dataset for the ML model being created.

Returns:

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

datasetSchema

CreateModelRequest.Builder datasetSchema(DatasetSchema datasetSchema)

The data schema for the ML model being created.

Parameters:

datasetSchema - The data schema for the ML model being created.

Returns:

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

datasetSchema

default CreateModelRequest.Builder datasetSchema(Consumer<DatasetSchema.Builder> datasetSchema)

The data schema for the ML model being created.

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

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

Parameters:

datasetSchema - a consumer that will call methods on DatasetSchema.Builder

Returns:

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

See Also:

datasetSchema(DatasetSchema)

labelsInputConfiguration

CreateModelRequest.Builder labelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration)

The input configuration for the labels being used for the ML model that's being created.

Parameters:

labelsInputConfiguration - The input configuration for the labels being used for the ML model that's being created.

Returns:

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

labelsInputConfiguration

default CreateModelRequest.Builder labelsInputConfiguration(Consumer<LabelsInputConfiguration.Builder> labelsInputConfiguration)

The input configuration for the labels being used for the ML model that's being created.

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

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

Parameters:

labelsInputConfiguration - a consumer that will call methods on LabelsInputConfiguration.Builder

Returns:

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

See Also:

labelsInputConfiguration(LabelsInputConfiguration)

clientToken

CreateModelRequest.Builder clientToken(String clientToken)

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Parameters:

clientToken - A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Returns:

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

trainingDataStartTime

CreateModelRequest.Builder trainingDataStartTime(Instant trainingDataStartTime)

Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.

Parameters:

trainingDataStartTime - Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.

Returns:

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

trainingDataEndTime

CreateModelRequest.Builder trainingDataEndTime(Instant trainingDataEndTime)

Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.

Parameters:

trainingDataEndTime - Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.

Returns:

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

evaluationDataStartTime

CreateModelRequest.Builder evaluationDataStartTime(Instant evaluationDataStartTime)

Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.

Parameters:

evaluationDataStartTime - Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.

Returns:

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

evaluationDataEndTime

CreateModelRequest.Builder evaluationDataEndTime(Instant evaluationDataEndTime)

Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.

Parameters:

evaluationDataEndTime - Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.

Returns:

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

roleArn

CreateModelRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.

Parameters:

roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.

Returns:

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

dataPreProcessingConfiguration

CreateModelRequest.Builder dataPreProcessingConfiguration(DataPreProcessingConfiguration dataPreProcessingConfiguration)

The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

Parameters:

dataPreProcessingConfiguration - The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

Returns:

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

dataPreProcessingConfiguration

default CreateModelRequest.Builder dataPreProcessingConfiguration(Consumer<DataPreProcessingConfiguration.Builder> dataPreProcessingConfiguration)

The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

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

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

Parameters:

dataPreProcessingConfiguration - a consumer that will call methods on DataPreProcessingConfiguration.Builder

Returns:

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

See Also:

dataPreProcessingConfiguration(DataPreProcessingConfiguration)

serverSideKmsKeyId

CreateModelRequest.Builder serverSideKmsKeyId(String serverSideKmsKeyId)

Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

Parameters:

serverSideKmsKeyId - Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

Returns:

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

tags

CreateModelRequest.Builder tags(Collection<Tag> tags)

Any tags associated with the ML model being created.

Parameters:

tags - Any tags associated with the ML model being created.

Returns:

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

tags

CreateModelRequest.Builder tags(Tag... tags)

Any tags associated with the ML model being created.

Parameters:

tags - Any tags associated with the ML model being created.

Returns:

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

tags

CreateModelRequest.Builder tags(Consumer<Tag.Builder>... tags)

Any tags associated with the ML model being created.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

offCondition

CreateModelRequest.Builder offCondition(String offCondition)

Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

Parameters:

offCondition - Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

Returns:

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

overrideConfiguration

CreateModelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateModelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder