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

Class StartSentimentDetectionJobRequest

    • 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 IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

        Returns:
        The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

      • jobName

        public final String jobName()

        The identifier of the job.

        Returns:
        The identifier of the job.

      • languageCode

        public final LanguageCode languageCode()

        The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

        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 of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
        See Also:
        LanguageCode

      • languageCodeAsString

        public final String languageCodeAsString()

        The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

        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 of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.
        See Also:
        LanguageCode

      • clientRequestToken

        public final String clientRequestToken()

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

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

      • volumeKmsKeyId

        public final String volumeKmsKeyId()

        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

        • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

        • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

        Returns:
        ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

        • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

        • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • vpcConfig

        public final VpcConfig vpcConfig()

        Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

        Returns:
        Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final List<Tag> tags()

        Tags to associate with the sentiment 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.

        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 hasTags() method.

        Returns:
        Tags to associate with the sentiment 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.

      • 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