* Provide the location for output data from a custom classifier job. This field is mandatory if you are training a * native classifier model. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DocumentClassifierOutputDataConfig implements Serializable, Cloneable, StructuredPojo { /** *
* When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon
* S3 location where you want to write the confusion matrix and other output files. The URI must be in the same
* Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of
* this output file.
*
* When the custom classifier job is finished, the service creates the output file in a directory specific to the
* job. The S3Uri field contains the location of the output file, called output.tar.gz. It
* is a compressed archive that contains the confusion matrix.
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output * results from an analysis job. The KmsKeyId can be one of the following formats: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* KMS Key Alias: "alias/ExampleAlias"
*
* ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
*
* The Amazon S3 prefix for the data lake location of the flywheel statistics. *
*/ private String flywheelStatsS3Prefix; /** *
* When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon
* S3 location where you want to write the confusion matrix and other output files. The URI must be in the same
* Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of
* this output file.
*
* When the custom classifier job is finished, the service creates the output file in a directory specific to the
* job. The S3Uri field contains the location of the output file, called output.tar.gz. It
* is a compressed archive that contains the confusion matrix.
*
OutputDataConfig object while creating a custom classifier, you specify the
* Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in
* the same Region as the API endpoint that you are calling. The location is used as the prefix for the
* actual location of this output file.
*
* When the custom classifier job is finished, the service creates the output file in a directory specific to
* the job. The S3Uri field contains the location of the output file, called
* output.tar.gz. It is a compressed archive that contains the confusion matrix.
*/
public void setS3Uri(String s3Uri) {
this.s3Uri = s3Uri;
}
/**
*
* When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon
* S3 location where you want to write the confusion matrix and other output files. The URI must be in the same
* Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of
* this output file.
*
* When the custom classifier job is finished, the service creates the output file in a directory specific to the
* job. The S3Uri field contains the location of the output file, called output.tar.gz. It
* is a compressed archive that contains the confusion matrix.
*
OutputDataConfig object while creating a custom classifier, you specify the
* Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be
* in the same Region as the API endpoint that you are calling. The location is used as the prefix for the
* actual location of this output file.
*
* When the custom classifier job is finished, the service creates the output file in a directory specific
* to the job. The S3Uri field contains the location of the output file, called
* output.tar.gz. It is a compressed archive that contains the confusion matrix.
*/
public String getS3Uri() {
return this.s3Uri;
}
/**
*
* When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon
* S3 location where you want to write the confusion matrix and other output files. The URI must be in the same
* Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of
* this output file.
*
* When the custom classifier job is finished, the service creates the output file in a directory specific to the
* job. The S3Uri field contains the location of the output file, called output.tar.gz. It
* is a compressed archive that contains the confusion matrix.
*
OutputDataConfig object while creating a custom classifier, you specify the
* Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in
* the same Region as the API endpoint that you are calling. The location is used as the prefix for the
* actual location of this output file.
*
* When the custom classifier job is finished, the service creates the output file in a directory specific to
* the job. The S3Uri field contains the location of the output file, called
* output.tar.gz. It is a compressed archive that contains the confusion matrix.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentClassifierOutputDataConfig withS3Uri(String s3Uri) {
setS3Uri(s3Uri);
return this;
}
/**
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output * results from an analysis job. The KmsKeyId can be one of the following formats: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* KMS Key Alias: "alias/ExampleAlias"
*
* ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* KMS Key Alias: "alias/ExampleAlias"
*
* ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output * results from an analysis job. The KmsKeyId can be one of the following formats: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* KMS Key Alias: "alias/ExampleAlias"
*
* ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* KMS Key Alias: "alias/ExampleAlias"
*
* ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output * results from an analysis job. The KmsKeyId can be one of the following formats: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* KMS Key Alias: "alias/ExampleAlias"
*
* ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* KMS Key Alias: "alias/ExampleAlias"
*
* ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
*
* The Amazon S3 prefix for the data lake location of the flywheel statistics. *
* * @param flywheelStatsS3Prefix * The Amazon S3 prefix for the data lake location of the flywheel statistics. */ public void setFlywheelStatsS3Prefix(String flywheelStatsS3Prefix) { this.flywheelStatsS3Prefix = flywheelStatsS3Prefix; } /** ** The Amazon S3 prefix for the data lake location of the flywheel statistics. *
* * @return The Amazon S3 prefix for the data lake location of the flywheel statistics. */ public String getFlywheelStatsS3Prefix() { return this.flywheelStatsS3Prefix; } /** ** The Amazon S3 prefix for the data lake location of the flywheel statistics. *
* * @param flywheelStatsS3Prefix * The Amazon S3 prefix for the data lake location of the flywheel statistics. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierOutputDataConfig withFlywheelStatsS3Prefix(String flywheelStatsS3Prefix) { setFlywheelStatsS3Prefix(flywheelStatsS3Prefix); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getS3Uri() != null) sb.append("S3Uri: ").append(getS3Uri()).append(","); if (getKmsKeyId() != null) sb.append("KmsKeyId: ").append(getKmsKeyId()).append(","); if (getFlywheelStatsS3Prefix() != null) sb.append("FlywheelStatsS3Prefix: ").append(getFlywheelStatsS3Prefix()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DocumentClassifierOutputDataConfig == false) return false; DocumentClassifierOutputDataConfig other = (DocumentClassifierOutputDataConfig) obj; if (other.getS3Uri() == null ^ this.getS3Uri() == null) return false; if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false) return false; if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null) return false; if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false) return false; if (other.getFlywheelStatsS3Prefix() == null ^ this.getFlywheelStatsS3Prefix() == null) return false; if (other.getFlywheelStatsS3Prefix() != null && other.getFlywheelStatsS3Prefix().equals(this.getFlywheelStatsS3Prefix()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getS3Uri() == null) ? 0 : getS3Uri().hashCode()); hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode()); hashCode = prime * hashCode + ((getFlywheelStatsS3Prefix() == null) ? 0 : getFlywheelStatsS3Prefix().hashCode()); return hashCode; } @Override public DocumentClassifierOutputDataConfig clone() { try { return (DocumentClassifierOutputDataConfig) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.comprehend.model.transform.DocumentClassifierOutputDataConfigMarshaller.getInstance().marshall(this, protocolMarshaller); } }