software.amazon.awssdk.services.comprehend.model

Class StartSentimentDetectionJobRequest

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.StartSentimentDetectionJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSentimentDetectionJobRequest.Builder,StartSentimentDetectionJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartSentimentDetectionJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartSentimentDetectionJobRequest.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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
InputDataConfig	inputDataConfig() Specifies the format and location of the input data for the job.
String	jobName() The identifier of the job.
LanguageCode	languageCode() The language of the input documents.
String	languageCodeAsString() The language of the input documents.
OutputDataConfig	outputDataConfig() Specifies where to send the output files.
List<SdkField<?>>	sdkFields()
static Class<? extends StartSentimentDetectionJobRequest.Builder>	serializableBuilderClass()
StartSentimentDetectionJobRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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 sentiment detection job.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

inputDataConfig

public 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 OutputDataConfig outputDataConfig()

Specifies where to send the output files.

Returns:

Specifies where to send the output files.

dataAccessRoleArn

public 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 String jobName()

The identifier of the job.

Returns:

The identifier of the job.

languageCode

public LanguageCode languageCode()

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

See Also:

LanguageCode

clientRequestToken

public String clientRequestToken()

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Returns:

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

volumeKmsKeyId

public 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 VpcConfig vpcConfig()

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment 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 sentiment detection job. For more information, see Amazon VPC.

toBuilder

public StartSentimentDetectionJobRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartSentimentDetectionJobRequest.Builder,StartSentimentDetectionJobRequest>

Specified by:

toBuilder in class ComprehendRequest

Returns:

a builder for type T

builder

public static StartSentimentDetectionJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.