com.amazonaws.services.comprehend.model.OutputDataConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-comprehend Show documentation
/*
* Copyright 2018-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;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides configuration parameters for the output of inference jobs.
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class OutputDataConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3
* location where you want to write the output data. 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 the output file.
*
*
* When the topic detection job is finished, the service creates an 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 ouput of the operation.
*
*
* For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is
* the same as the input file, with .out appended at the end.
*
*/
private String s3Uri;
/**
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output
* results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for
* uploading data to S3.
*
*
* 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"
*
*
*
*/
private String kmsKeyId;
/**
*
* When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3
* location where you want to write the output data. 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 the output file.
*
*
* When the topic detection job is finished, the service creates an 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 ouput of the operation.
*
*
* For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is
* the same as the input file, with .out appended at the end.
*
*
* @param s3Uri
* When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon
* S3 location where you want to write the output data. 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 the output
* file.
*
* When the topic detection job is finished, the service creates an 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 ouput of the operation.
*
*
* For a PII entity detection job, the output file is plain text, not a compressed archive. The output file
* name is the same as the input file, with .out appended at the end.
*/
public void setS3Uri(String s3Uri) {
this.s3Uri = s3Uri;
}
/**
*
* When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3
* location where you want to write the output data. 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 the output file.
*
*
* When the topic detection job is finished, the service creates an 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 ouput of the operation.
*
*
* For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is
* the same as the input file, with .out appended at the end.
*
*
* @return When you use the OutputDataConfig object with asynchronous operations, you specify the
* Amazon S3 location where you want to write the output data. 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 the output
* file.
*
* When the topic detection job is finished, the service creates an 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 ouput of the operation.
*
*
* For a PII entity detection job, the output file is plain text, not a compressed archive. The output file
* name is the same as the input file, with .out appended at the end.
*/
public String getS3Uri() {
return this.s3Uri;
}
/**
*
* When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3
* location where you want to write the output data. 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 the output file.
*
*
* When the topic detection job is finished, the service creates an 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 ouput of the operation.
*
*
* For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is
* the same as the input file, with .out appended at the end.
*
*
* @param s3Uri
* When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon
* S3 location where you want to write the output data. 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 the output
* file.
*
* When the topic detection job is finished, the service creates an 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 ouput of the operation.
*
*
* For a PII entity detection job, the output file is plain text, not a compressed archive. The output file
* name is the same as the input file, with .out appended at the end.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OutputDataConfig 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. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for
* uploading data to S3.
*
*
* 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"
*
*
*
*
* @param kmsKeyId
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the
* output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an
* asymmetric key for uploading data to S3.
*
* 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"
*
*
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
/**
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output
* results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for
* uploading data to S3.
*
*
* 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"
*
*
*
*
* @return ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
* the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an
* asymmetric key for uploading data to S3.
*
* 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"
*
*
*/
public String getKmsKeyId() {
return this.kmsKeyId;
}
/**
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output
* results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for
* uploading data to S3.
*
*
* 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"
*
*
*
*
* @param kmsKeyId
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the
* output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an
* asymmetric key for uploading data to S3.
*
* 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"
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OutputDataConfig withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof OutputDataConfig == false)
return false;
OutputDataConfig other = (OutputDataConfig) 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;
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());
return hashCode;
}
@Override
public OutputDataConfig clone() {
try {
return (OutputDataConfig) 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.OutputDataConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}