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

Interface EventsDetectionJobProperties.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EventsDetectionJobProperties.Builder,EventsDetectionJobProperties>, SdkBuilder<EventsDetectionJobProperties.Builder,EventsDetectionJobProperties>, SdkPojo
Enclosing class:
EventsDetectionJobProperties
public static interface EventsDetectionJobProperties.Builder extends SdkPojo, CopyableBuilder<EventsDetectionJobProperties.Builder,EventsDetectionJobProperties>

  • Method Details

    • jobId

      EventsDetectionJobProperties.Builder jobId(String jobId)

      The identifier assigned to the events detection job.

      Parameters:
      jobId - The identifier assigned to the events detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobArn

      EventsDetectionJobProperties.Builder jobArn(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • jobName

      EventsDetectionJobProperties.Builder jobName(String jobName)

      The name you assigned the events detection job.

      Parameters:
      jobName - The name you assigned the events detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStatus

      EventsDetectionJobProperties.Builder jobStatus(String jobStatus)

      The current status of the events detection job.

      Parameters:
      jobStatus - The current status of the events detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobStatus

      EventsDetectionJobProperties.Builder jobStatus(JobStatus jobStatus)

      The current status of the events detection job.

      Parameters:
      jobStatus - The current status of the events detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • message

      EventsDetectionJobProperties.Builder message(String message)

      A description of the status of the events detection job.

      Parameters:
      message - A description of the status of the events detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • submitTime

      EventsDetectionJobProperties.Builder submitTime(Instant submitTime)

      The time that the events detection job was submitted for processing.

      Parameters:
      submitTime - The time that the events detection job was submitted for processing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      EventsDetectionJobProperties.Builder endTime(Instant endTime)

      The time that the events detection job completed.

      Parameters:
      endTime - The time that the events detection job completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      EventsDetectionJobProperties.Builder inputDataConfig(InputDataConfig inputDataConfig)

      The input data configuration that you supplied when you created the events detection job.

      Parameters:
      inputDataConfig - The input data configuration that you supplied when you created the events detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      default EventsDetectionJobProperties.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)

      The input data configuration that you supplied when you created the events detection job.

      This is a convenience method that creates an instance of the InputDataConfig.Builder avoiding the need to create one manually via InputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(InputDataConfig).

      Parameters:
      inputDataConfig - a consumer that will call methods on InputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputDataConfig

      EventsDetectionJobProperties.Builder outputDataConfig(OutputDataConfig outputDataConfig)

      The output data configuration that you supplied when you created the events detection job.

      Parameters:
      outputDataConfig - The output data configuration that you supplied when you created the events detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputDataConfig

      default EventsDetectionJobProperties.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)

      The output data configuration that you supplied when you created the events detection job.

      This is a convenience method that creates an instance of the OutputDataConfig.Builder avoiding the need to create one manually via OutputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(OutputDataConfig).

      Parameters:
      outputDataConfig - a consumer that will call methods on OutputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      EventsDetectionJobProperties.Builder languageCode(String languageCode)

      The language code of the input documents.

      Parameters:
      languageCode - The language code of the input documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      EventsDetectionJobProperties.Builder languageCode(LanguageCode languageCode)

      The language code of the input documents.

      Parameters:
      languageCode - The language code of the input documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataAccessRoleArn

      EventsDetectionJobProperties.Builder dataAccessRoleArn(String dataAccessRoleArn)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

      Parameters:
      dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetEventTypes

      EventsDetectionJobProperties.Builder targetEventTypes(Collection<String> targetEventTypes)

      The types of events that are detected by the job.

      Parameters:
      targetEventTypes - The types of events that are detected by the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetEventTypes

      EventsDetectionJobProperties.Builder targetEventTypes(String... targetEventTypes)

      The types of events that are detected by the job.

      Parameters:
      targetEventTypes - The types of events that are detected by the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.