OutputDataConfig (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.comprehend.model.OutputDataConfig

All Implemented Interfaces:

java.io.Serializable
```
public class OutputDataConfig
extends java.lang.Object
implements java.io.Serializable
```
Provides configuration parameters for the output of topic detection jobs.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

OutputDataConfig()

Constructors
Constructor and Description
`OutputDataConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getKmsKeyId()` ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
`java.lang.String`	`getS3Uri()` When you use the `OutputDataConfig` object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
`int`	`hashCode()`
`void`	`setKmsKeyId(java.lang.String kmsKeyId)` ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
`void`	`setS3Uri(java.lang.String s3Uri)` When you use the `OutputDataConfig` object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`OutputDataConfig`	`withKmsKeyId(java.lang.String kmsKeyId)` ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
`OutputDataConfig`	`withS3Uri(java.lang.String s3Uri)` When you use the `OutputDataConfig` object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OutputDataConfig
```
public OutputDataConfig()
```
- Method Detail
  - getS3Uri
```
public java.lang.String getS3Uri()
```
    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.
    
    Constraints:
    Length: - 1024
    Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
    
    Returns:
    
    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.
  - setS3Uri
```
public void setS3Uri(java.lang.String 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.
    
    Constraints:
    Length: - 1024
    Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
    
    Parameters:
    
    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.
  - withS3Uri
```
public OutputDataConfig withS3Uri(java.lang.String 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.
    
    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](/.*)?
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKmsKeyId
```
public java.lang.String getKmsKeyId()
```
    ID for the AWS 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"
    Constraints:
    Length: - 2048
    Returns:
    ID for the AWS 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"
  - setKmsKeyId
```
public void setKmsKeyId(java.lang.String kmsKeyId)
```
    ID for the AWS 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"
    Constraints:
    Length: - 2048
    Parameters:
    kmsKeyId -
    ID for the AWS 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"
  - withKmsKeyId
```
public OutputDataConfig withKmsKeyId(java.lang.String kmsKeyId)
```
    ID for the AWS 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"
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 2048
    Parameters:
    kmsKeyId -
    ID for the AWS 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"
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class OutputDataConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OutputDataConfig

Method Detail

getS3Uri

setS3Uri

withS3Uri

getKmsKeyId

setKmsKeyId

withKmsKeyId

toString

hashCode

equals