software.amazon.awssdk.services.lookoutequipment.model

Interface DescribeModelResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeModelResponse.Builder,DescribeModelResponse>, LookoutEquipmentResponse.Builder, SdkBuilder<DescribeModelResponse.Builder,DescribeModelResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeModelResponse

public static interface DescribeModelResponse.Builder
extends LookoutEquipmentResponse.Builder, SdkPojo, CopyableBuilder<DescribeModelResponse.Builder,DescribeModelResponse>

Method Summary

Modifier and Type	Method and Description
DescribeModelResponse.Builder	createdAt(Instant createdAt) Indicates the time and date at which the ML model was created.
default DescribeModelResponse.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.
DescribeModelResponse.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.
DescribeModelResponse.Builder	datasetArn(String datasetArn) The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
DescribeModelResponse.Builder	datasetName(String datasetName) The name of the dataset being used by the ML being described.
DescribeModelResponse.Builder	evaluationDataEndTime(Instant evaluationDataEndTime) Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
DescribeModelResponse.Builder	evaluationDataStartTime(Instant evaluationDataStartTime) Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.
DescribeModelResponse.Builder	failedReason(String failedReason) If the training of the ML model failed, this indicates the reason for that failure.
default DescribeModelResponse.Builder	labelsInputConfiguration(Consumer<LabelsInputConfiguration.Builder> labelsInputConfiguration) Specifies configuration information about the labels input, including its S3 location.
DescribeModelResponse.Builder	labelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration) Specifies configuration information about the labels input, including its S3 location.
DescribeModelResponse.Builder	lastUpdatedTime(Instant lastUpdatedTime) Indicates the last time the ML model was updated.
DescribeModelResponse.Builder	modelArn(String modelArn) The Amazon Resource Name (ARN) of the ML model being described.
DescribeModelResponse.Builder	modelMetrics(String modelMetrics) The Model Metrics show an aggregated summary of the model's performance within the evaluation time range.
DescribeModelResponse.Builder	modelName(String modelName) The name of the ML model being described.
DescribeModelResponse.Builder	offCondition(String offCondition) Indicates that the asset associated with this sensor has been shut off.
DescribeModelResponse.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.
DescribeModelResponse.Builder	schema(String schema) A JSON description of the data that is in each time series dataset, including names, column names, and data types.
DescribeModelResponse.Builder	serverSideKmsKeyId(String serverSideKmsKeyId) Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
DescribeModelResponse.Builder	status(ModelStatus status) Specifies the current status of the model being described.
DescribeModelResponse.Builder	status(String status) Specifies the current status of the model being described.
DescribeModelResponse.Builder	trainingDataEndTime(Instant trainingDataEndTime) Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
DescribeModelResponse.Builder	trainingDataStartTime(Instant trainingDataStartTime) Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
DescribeModelResponse.Builder	trainingExecutionEndTime(Instant trainingExecutionEndTime) Indicates the time at which the training of the ML model was completed.
DescribeModelResponse.Builder	trainingExecutionStartTime(Instant trainingExecutionStartTime) Indicates the time at which the training of the ML model began.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

DescribeModelResponse.Builder modelName(String modelName)

The name of the ML model being described.

Parameters:

modelName - The name of the ML model being described.

Returns:

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

modelArn

DescribeModelResponse.Builder modelArn(String modelArn)

The Amazon Resource Name (ARN) of the ML model being described.

Parameters:

modelArn - The Amazon Resource Name (ARN) of the ML model being described.

Returns:

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

datasetName

DescribeModelResponse.Builder datasetName(String datasetName)

The name of the dataset being used by the ML being described.

Parameters:

datasetName - The name of the dataset being used by the ML being described.

Returns:

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

datasetArn

DescribeModelResponse.Builder datasetArn(String datasetArn)

The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.

Parameters:

datasetArn - The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.

Returns:

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

schema

DescribeModelResponse.Builder schema(String schema)

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

Parameters:

schema - A JSON description of the data that is in each time series dataset, including names, column names, and data types.

Returns:

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

labelsInputConfiguration

DescribeModelResponse.Builder labelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration)

Specifies configuration information about the labels input, including its S3 location.

Parameters:

labelsInputConfiguration - Specifies configuration information about the labels input, including its S3 location.

Returns:

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

labelsInputConfiguration

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

Specifies configuration information about the labels input, including its S3 location.

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)

trainingDataStartTime

DescribeModelResponse.Builder trainingDataStartTime(Instant trainingDataStartTime)

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

Parameters:

trainingDataStartTime - Indicates the time reference in the dataset that was 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

DescribeModelResponse.Builder trainingDataEndTime(Instant trainingDataEndTime)

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

Parameters:

trainingDataEndTime - Indicates the time reference in the dataset that was 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

DescribeModelResponse.Builder evaluationDataStartTime(Instant evaluationDataStartTime)

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

Parameters:

evaluationDataStartTime - Indicates the time reference in the dataset that was 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

DescribeModelResponse.Builder evaluationDataEndTime(Instant evaluationDataEndTime)

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

Parameters:

evaluationDataEndTime - Indicates the time reference in the dataset that was 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

DescribeModelResponse.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

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

dataPreProcessingConfiguration

DescribeModelResponse.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 DescribeModelResponse.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)

status

DescribeModelResponse.Builder status(String status)

Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

Parameters:

status - Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

Returns:

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

See Also:

ModelStatus, ModelStatus

status

DescribeModelResponse.Builder status(ModelStatus status)

Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

Parameters:

status - Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

Returns:

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

See Also:

ModelStatus, ModelStatus

trainingExecutionStartTime

DescribeModelResponse.Builder trainingExecutionStartTime(Instant trainingExecutionStartTime)

Indicates the time at which the training of the ML model began.

Parameters:

trainingExecutionStartTime - Indicates the time at which the training of the ML model began.

Returns:

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

trainingExecutionEndTime

DescribeModelResponse.Builder trainingExecutionEndTime(Instant trainingExecutionEndTime)

Indicates the time at which the training of the ML model was completed.

Parameters:

trainingExecutionEndTime - Indicates the time at which the training of the ML model was completed.

Returns:

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

failedReason

DescribeModelResponse.Builder failedReason(String failedReason)

If the training of the ML model failed, this indicates the reason for that failure.

Parameters:

failedReason - If the training of the ML model failed, this indicates the reason for that failure.

Returns:

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

modelMetrics

DescribeModelResponse.Builder modelMetrics(String modelMetrics)

The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.

Parameters:

modelMetrics - The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.

Returns:

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

lastUpdatedTime

DescribeModelResponse.Builder lastUpdatedTime(Instant lastUpdatedTime)

Indicates the last time the ML model was updated. The type of update is not specified.

Parameters:

lastUpdatedTime - Indicates the last time the ML model was updated. The type of update is not specified.

Returns:

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

createdAt

DescribeModelResponse.Builder createdAt(Instant createdAt)

Indicates the time and date at which the ML model was created.

Parameters:

createdAt - Indicates the time and date at which the ML model was created.

Returns:

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

serverSideKmsKeyId

DescribeModelResponse.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.

offCondition

DescribeModelResponse.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.