StartSentimentDetectionJobRequest (AWS SDK for Java

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartSentimentDetectionJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<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()`

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 English ("en") or Spanish ("es"). 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 English ("en") or Spanish ("es"). All documents must be in the same language.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public String languageCodeAsString()
```
    The language of the input documents. You can specify English ("en") or Spanish ("es"). 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 English ("en") or Spanish ("es"). 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.
  - 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 Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    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.

Class StartSentimentDetectionJobRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

inputDataConfig

outputDataConfig

dataAccessRoleArn

jobName

languageCode

languageCodeAsString

clientRequestToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields