software.amazon.awssdk.services.comprehend.model

Class StartTopicsDetectionJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.comprehend.model.ComprehendRequest

software.amazon.awssdk.services.comprehend.model.StartTopicsDetectionJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartTopicsDetectionJobRequest.Builder,StartTopicsDetectionJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartTopicsDetectionJobRequest
extends ComprehendRequest
implements ToCopyableBuilder<StartTopicsDetectionJobRequest.Builder,StartTopicsDetectionJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartTopicsDetectionJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartTopicsDetectionJobRequest.Builder	builder()
String	clientRequestToken() A unique identifier for the request.
String	dataAccessRoleArn() The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputDataConfig	inputDataConfig() Specifies the format and location of the input data for the job.
String	jobName() The identifier of the job.
Integer	numberOfTopics() The number of topics to detect.
OutputDataConfig	outputDataConfig() Specifies where to send the output files.
List<SdkField<?>>	sdkFields()
static Class<? extends StartTopicsDetectionJobRequest.Builder>	serializableBuilderClass()
StartTopicsDetectionJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	volumeKmsKeyId() ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
VpcConfig	vpcConfig() Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

inputDataConfig

public final InputDataConfig inputDataConfig()

Specifies the format and location of the input data for the job.

Returns:

Specifies the format and location of the input data for the job.

outputDataConfig

public final OutputDataConfig outputDataConfig()

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Returns:

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

dataAccessRoleArn

public final String dataAccessRoleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.

Returns:

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role- permissions.

jobName

public final String jobName()

The identifier of the job.

Returns:

The identifier of the job.

numberOfTopics

public final Integer numberOfTopics()

The number of topics to detect.

Returns:

The number of topics to detect.

clientRequestToken

public final String clientRequestToken()

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Returns:

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

volumeKmsKeyId

public final String volumeKmsKeyId()

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Returns:

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

vpcConfig

public final VpcConfig vpcConfig()

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

Returns:

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

toBuilder

public StartTopicsDetectionJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartTopicsDetectionJobRequest.Builder,StartTopicsDetectionJobRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static StartTopicsDetectionJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartTopicsDetectionJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo