java.lang.Object
- software.amazon.awssdk.services.comprehend.model.EventsDetectionJobProperties

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<EventsDetectionJobProperties.Builder,EventsDetectionJobProperties>

@Generated("software.amazon.awssdk:codegen")
public final class EventsDetectionJobProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EventsDetectionJobProperties.Builder,EventsDetectionJobProperties>

Provides information about an events detection job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface EventsDetectionJobProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EventsDetectionJobProperties.Builder`	`builder()`
`String`	`dataAccessRoleArn()`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`Instant`	`endTime()`	The time that the events detection job completed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTargetEventTypes()`	For responses, this returns true if the service returned a value for the TargetEventTypes property.
`InputDataConfig`	`inputDataConfig()`	The input data configuration that you supplied when you created the events detection job.
`String`	`jobArn()`	The Amazon Resource Name (ARN) of the events detection job.
`String`	`jobId()`	The identifier assigned to the events detection job.
`String`	`jobName()`	The name you assigned the events detection job.
`JobStatus`	`jobStatus()`	The current status of the events detection job.
`String`	`jobStatusAsString()`	The current status of the events detection job.
`LanguageCode`	`languageCode()`	The language code of the input documents.
`String`	`languageCodeAsString()`	The language code of the input documents.
`String`	`message()`	A description of the status of the events detection job.
`OutputDataConfig`	`outputDataConfig()`	The output data configuration that you supplied when you created the events detection job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EventsDetectionJobProperties.Builder>`	`serializableBuilderClass()`
`Instant`	`submitTime()`	The time that the events detection job was submitted for processing.
`List<String>`	`targetEventTypes()`	The types of events that are detected by the job.
`EventsDetectionJobProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - jobId
```
public final String jobId()
```
    The identifier assigned to the events detection job.
    
    Returns:
    
    The identifier assigned to the events detection job.
  - jobArn
```
public final String jobArn()
```
    The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
    
    Returns:
    
    The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
    
    arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
    
    The following is an example job ARN:
    
    arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
  - jobName
```
public final String jobName()
```
    The name you assigned the events detection job.
    
    Returns:
    
    The name you assigned the events detection job.
  - jobStatus
```
public final JobStatus jobStatus()
```
    The current status of the events detection job.
    
    If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().
    
    Returns:
    
    The current status of the events detection job.
    
    See Also:
    
    JobStatus
  - jobStatusAsString
```
public final String jobStatusAsString()
```
    The current status of the events detection job.
    
    If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().
    
    Returns:
    
    The current status of the events detection job.
    
    See Also:
    
    JobStatus
  - message
```
public final String message()
```
    A description of the status of the events detection job.
    
    Returns:
    
    A description of the status of the events detection job.
  - submitTime
```
public final Instant submitTime()
```
    The time that the events detection job was submitted for processing.
    
    Returns:
    
    The time that the events detection job was submitted for processing.
  - endTime
```
public final Instant endTime()
```
    The time that the events detection job completed.
    
    Returns:
    
    The time that the events detection job completed.
  - inputDataConfig
```
public final InputDataConfig inputDataConfig()
```
    The input data configuration that you supplied when you created the events detection job.
    
    Returns:
    
    The input data configuration that you supplied when you created the events detection job.
  - outputDataConfig
```
public final OutputDataConfig outputDataConfig()
```
    The output data configuration that you supplied when you created the events detection job.
    
    Returns:
    
    The output data configuration that you supplied when you created 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
  - dataAccessRoleArn
```
public final String dataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  - hasTargetEventTypes
```
public final boolean hasTargetEventTypes()
```
    For responses, this returns true if the service returned a value for the TargetEventTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - targetEventTypes
```
public final List<String> targetEventTypes()
```
    The types of events that are detected by the job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetEventTypes() method.
    
    Returns:
    
    The types of events that are detected by the job.
  - toBuilder
```
public EventsDetectionJobProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EventsDetectionJobProperties.Builder,EventsDetectionJobProperties>
  - builder
```
public static EventsDetectionJobProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EventsDetectionJobProperties.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class EventsDetectionJobProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

jobId

jobArn

jobName

jobStatus

jobStatusAsString

message

submitTime

endTime

inputDataConfig

outputDataConfig

languageCode

languageCodeAsString

dataAccessRoleArn

hasTargetEventTypes

targetEventTypes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields