software.amazon.awssdk.services.comprehend.model

Class StartEventsDetectionJobRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartEventsDetectionJobRequest.Builder,StartEventsDetectionJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartEventsDetectionJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartEventsDetectionJobRequest.Builder	builder()
String	clientRequestToken() An 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()
boolean	hasTargetEventTypes() Returns true if the TargetEventTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
InputDataConfig	inputDataConfig() Specifies the format and location of the input data for the job.
String	jobName() The identifier of the events detection job.
LanguageCode	languageCode() The language code of the input documents.
String	languageCodeAsString() The language code of the input documents.
OutputDataConfig	outputDataConfig() Specifies where to send the output files.
List<SdkField<?>>	sdkFields()
static Class<? extends StartEventsDetectionJobRequest.Builder>	serializableBuilderClass()
List<String>	targetEventTypes() The types of events to detect in the input documents.
StartEventsDetectionJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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.

Returns:

Specifies where to send the output files.

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.

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.

jobName

public final String jobName()

The identifier of the events detection job.

Returns:

The identifier of the events detection job.

languageCode

public final LanguageCode languageCode()

The language code of the input documents.

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 code of the input documents.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code of the input documents.

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 code of the input documents.

See Also:

LanguageCode

clientRequestToken

public final String clientRequestToken()

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

Returns:

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

hasTargetEventTypes

public final boolean hasTargetEventTypes()

Returns true if the TargetEventTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targetEventTypes

public final List<String> targetEventTypes()

The types of events to detect in the input documents.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTargetEventTypes() to see if a value was sent in this field.

Returns:

The types of events to detect in the input documents.

toBuilder

public StartEventsDetectionJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartEventsDetectionJobRequest.Builder,StartEventsDetectionJobRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static StartEventsDetectionJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartEventsDetectionJobRequest.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