Package software.amazon.awssdk.services.comprehend.model

Class EventsDetectionJobProperties

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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<EventsDetectionJobProperties.Builder,EventsDetectionJobProperties>
      Returns:
      a builder for type T

    • 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)
      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 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.