/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.comprehend.model; import java.io.Serializable; /** *
* The configuration properties of a flywheel iteration. *
*/ public class FlywheelIterationProperties implements Serializable { /** * *
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel
* /[a-zA-Z0-9](-*[a-zA-Z0-9])*
*/
private String flywheelArn;
/**
*
* Constraints:
* Length: - 63
* Pattern: [0-9]{8}T[0-9]{6}Z
*/
private String flywheelIterationId;
/**
*
* The creation start time of the flywheel iteration. *
*/ private java.util.Date creationTime; /** ** The completion time of this flywheel iteration. *
*/ private java.util.Date endTime; /** ** The status of the flywheel iteration. *
*
* Constraints:
* Allowed Values: TRAINING, EVALUATING, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*/
private String status;
/**
*
* A description of the status of the flywheel iteration. *
*/ private String message; /** ** The ARN of the evaluated model associated with this flywheel iteration. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
* -classifier
* |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
* Z0-9](-*[a-zA-Z0-9])*)?
*/
private String evaluatedModelArn;
/**
*
* The evaluation metrics associated with the evaluated model. *
*/ private FlywheelModelEvaluationMetrics evaluatedModelMetrics; /** ** The ARN of the trained model associated with this flywheel iteration. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
* -classifier
* |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
* Z0-9](-*[a-zA-Z0-9])*)?
*/
private String trainedModelArn;
/**
*
* The metrics associated with the trained model. *
*/ private FlywheelModelEvaluationMetrics trainedModelMetrics; /** * *
* Constraints:
* Length: - 1024
* Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
*/
private String evaluationManifestS3Prefix;
/**
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel
* /[a-zA-Z0-9](-*[a-zA-Z0-9])*
*
* @return
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel
* /[a-zA-Z0-9](-*[a-zA-Z0-9])*
*
* @param flywheelArn
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel
* /[a-zA-Z0-9](-*[a-zA-Z0-9])*
*
* @param flywheelArn
* Constraints:
* Length: - 63
* Pattern: [0-9]{8}T[0-9]{6}Z
*
* @return
* Constraints:
* Length: - 63
* Pattern: [0-9]{8}T[0-9]{6}Z
*
* @param flywheelIterationId
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 63
* Pattern: [0-9]{8}T[0-9]{6}Z
*
* @param flywheelIterationId
* The creation start time of the flywheel iteration. *
* * @return* The creation start time of the flywheel iteration. *
*/ public java.util.Date getCreationTime() { return creationTime; } /** ** The creation start time of the flywheel iteration. *
* * @param creationTime* The creation start time of the flywheel iteration. *
*/ public void setCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; } /** ** The creation start time of the flywheel iteration. *
** Returns a reference to this object so that method calls can be chained * together. * * @param creationTime
* The creation start time of the flywheel iteration. *
* @return A reference to this updated object so that method calls can be * chained together. */ public FlywheelIterationProperties withCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; return this; } /** ** The completion time of this flywheel iteration. *
* * @return* The completion time of this flywheel iteration. *
*/ public java.util.Date getEndTime() { return endTime; } /** ** The completion time of this flywheel iteration. *
* * @param endTime* The completion time of this flywheel iteration. *
*/ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The completion time of this flywheel iteration. *
** Returns a reference to this object so that method calls can be chained * together. * * @param endTime
* The completion time of this flywheel iteration. *
* @return A reference to this updated object so that method calls can be * chained together. */ public FlywheelIterationProperties withEndTime(java.util.Date endTime) { this.endTime = endTime; return this; } /** ** The status of the flywheel iteration. *
*
* Constraints:
* Allowed Values: TRAINING, EVALUATING, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @return
* The status of the flywheel iteration. *
* @see FlywheelIterationStatus */ public String getStatus() { return status; } /** ** The status of the flywheel iteration. *
*
* Constraints:
* Allowed Values: TRAINING, EVALUATING, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param status
* The status of the flywheel iteration. *
* @see FlywheelIterationStatus */ public void setStatus(String status) { this.status = status; } /** ** The status of the flywheel iteration. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: TRAINING, EVALUATING, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param status
* The status of the flywheel iteration. *
* @return A reference to this updated object so that method calls can be * chained together. * @see FlywheelIterationStatus */ public FlywheelIterationProperties withStatus(String status) { this.status = status; return this; } /** ** The status of the flywheel iteration. *
*
* Constraints:
* Allowed Values: TRAINING, EVALUATING, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param status
* The status of the flywheel iteration. *
* @see FlywheelIterationStatus */ public void setStatus(FlywheelIterationStatus status) { this.status = status.toString(); } /** ** The status of the flywheel iteration. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: TRAINING, EVALUATING, COMPLETED, FAILED,
* STOP_REQUESTED, STOPPED
*
* @param status
* The status of the flywheel iteration. *
* @return A reference to this updated object so that method calls can be * chained together. * @see FlywheelIterationStatus */ public FlywheelIterationProperties withStatus(FlywheelIterationStatus status) { this.status = status.toString(); return this; } /** ** A description of the status of the flywheel iteration. *
* * @return* A description of the status of the flywheel iteration. *
*/ public String getMessage() { return message; } /** ** A description of the status of the flywheel iteration. *
* * @param message* A description of the status of the flywheel iteration. *
*/ public void setMessage(String message) { this.message = message; } /** ** A description of the status of the flywheel iteration. *
** Returns a reference to this object so that method calls can be chained * together. * * @param message
* A description of the status of the flywheel iteration. *
* @return A reference to this updated object so that method calls can be * chained together. */ public FlywheelIterationProperties withMessage(String message) { this.message = message; return this; } /** ** The ARN of the evaluated model associated with this flywheel iteration. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
* -classifier
* |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
* Z0-9](-*[a-zA-Z0-9])*)?
*
* @return
* The ARN of the evaluated model associated with this flywheel * iteration. *
*/ public String getEvaluatedModelArn() { return evaluatedModelArn; } /** ** The ARN of the evaluated model associated with this flywheel iteration. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
* -classifier
* |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
* Z0-9](-*[a-zA-Z0-9])*)?
*
* @param evaluatedModelArn
* The ARN of the evaluated model associated with this flywheel * iteration. *
*/ public void setEvaluatedModelArn(String evaluatedModelArn) { this.evaluatedModelArn = evaluatedModelArn; } /** ** The ARN of the evaluated model associated with this flywheel iteration. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
* -classifier
* |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
* Z0-9](-*[a-zA-Z0-9])*)?
*
* @param evaluatedModelArn
* The ARN of the evaluated model associated with this flywheel * iteration. *
* @return A reference to this updated object so that method calls can be * chained together. */ public FlywheelIterationProperties withEvaluatedModelArn(String evaluatedModelArn) { this.evaluatedModelArn = evaluatedModelArn; return this; } /** ** The evaluation metrics associated with the evaluated model. *
* * @return* The evaluation metrics associated with the evaluated model. *
*/ public FlywheelModelEvaluationMetrics getEvaluatedModelMetrics() { return evaluatedModelMetrics; } /** ** The evaluation metrics associated with the evaluated model. *
* * @param evaluatedModelMetrics* The evaluation metrics associated with the evaluated model. *
*/ public void setEvaluatedModelMetrics(FlywheelModelEvaluationMetrics evaluatedModelMetrics) { this.evaluatedModelMetrics = evaluatedModelMetrics; } /** ** The evaluation metrics associated with the evaluated model. *
** Returns a reference to this object so that method calls can be chained * together. * * @param evaluatedModelMetrics
* The evaluation metrics associated with the evaluated model. *
* @return A reference to this updated object so that method calls can be * chained together. */ public FlywheelIterationProperties withEvaluatedModelMetrics( FlywheelModelEvaluationMetrics evaluatedModelMetrics) { this.evaluatedModelMetrics = evaluatedModelMetrics; return this; } /** ** The ARN of the trained model associated with this flywheel iteration. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
* -classifier
* |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
* Z0-9](-*[a-zA-Z0-9])*)?
*
* @return
* The ARN of the trained model associated with this flywheel * iteration. *
*/ public String getTrainedModelArn() { return trainedModelArn; } /** ** The ARN of the trained model associated with this flywheel iteration. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
* -classifier
* |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
* Z0-9](-*[a-zA-Z0-9])*)?
*
* @param trainedModelArn
* The ARN of the trained model associated with this flywheel * iteration. *
*/ public void setTrainedModelArn(String trainedModelArn) { this.trainedModelArn = trainedModelArn; } /** ** The ARN of the trained model associated with this flywheel iteration. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
* -classifier
* |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
* Z0-9](-*[a-zA-Z0-9])*)?
*
* @param trainedModelArn
* The ARN of the trained model associated with this flywheel * iteration. *
* @return A reference to this updated object so that method calls can be * chained together. */ public FlywheelIterationProperties withTrainedModelArn(String trainedModelArn) { this.trainedModelArn = trainedModelArn; return this; } /** ** The metrics associated with the trained model. *
* * @return* The metrics associated with the trained model. *
*/ public FlywheelModelEvaluationMetrics getTrainedModelMetrics() { return trainedModelMetrics; } /** ** The metrics associated with the trained model. *
* * @param trainedModelMetrics* The metrics associated with the trained model. *
*/ public void setTrainedModelMetrics(FlywheelModelEvaluationMetrics trainedModelMetrics) { this.trainedModelMetrics = trainedModelMetrics; } /** ** The metrics associated with the trained model. *
** Returns a reference to this object so that method calls can be chained * together. * * @param trainedModelMetrics
* The metrics associated with the trained model. *
* @return A reference to this updated object so that method calls can be * chained together. */ public FlywheelIterationProperties withTrainedModelMetrics( FlywheelModelEvaluationMetrics trainedModelMetrics) { this.trainedModelMetrics = trainedModelMetrics; return this; } /** * *
* Constraints:
* Length: - 1024
* Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
*
* @return
* Constraints:
* Length: - 1024
* Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
*
* @param evaluationManifestS3Prefix
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 1024
* Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
*
* @param evaluationManifestS3Prefix