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

Interface StartEventsDetectionJobRequest.Builder

    • Method Detail

      • inputDataConfig

        StartEventsDetectionJobRequest.Builder inputDataConfig​(InputDataConfig inputDataConfig)

        Specifies the format and location of the input data for the job.

        Parameters:
        inputDataConfig - Specifies the format and location of the input data for the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputDataConfig

        StartEventsDetectionJobRequest.Builder outputDataConfig​(OutputDataConfig outputDataConfig)

        Specifies where to send the output files.

        Parameters:
        outputDataConfig - Specifies where to send the output files.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataAccessRoleArn

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

      • jobName

        StartEventsDetectionJobRequest.Builder jobName​(String jobName)

        The identifier of the events detection job.

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

      • clientRequestToken

        StartEventsDetectionJobRequest.Builder clientRequestToken​(String clientRequestToken)

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

        Parameters:
        clientRequestToken - An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetEventTypes

        StartEventsDetectionJobRequest.Builder targetEventTypes​(Collection<String> targetEventTypes)

        The types of events to detect in the input documents.

        Parameters:
        targetEventTypes - The types of events to detect in the input documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetEventTypes

        StartEventsDetectionJobRequest.Builder targetEventTypes​(String... targetEventTypes)

        The types of events to detect in the input documents.

        Parameters:
        targetEventTypes - The types of events to detect in the input documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartEventsDetectionJobRequest.Builder tags​(Collection<Tag> tags)

        Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

        Parameters:
        tags - Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartEventsDetectionJobRequest.Builder tags​(Tag... tags)

        Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

        Parameters:
        tags - Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartEventsDetectionJobRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)