Class StartPhiDetectionJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.comprehendmedical.model.ComprehendMedicalRequest
software.amazon.awssdk.services.comprehendmedical.model.StartPhiDetectionJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartPhiDetectionJobRequest.Builder,StartPhiDetectionJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartPhiDetectionJobRequest extends ComprehendMedicalRequest implements ToCopyableBuilder<StartPhiDetectionJobRequest.Builder,StartPhiDetectionJobRequest>

  • Method Details

    • 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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

      Returns:
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

    • jobName

      public final String jobName()

      The identifier of the job.

      Returns:
      The identifier of the job.

    • clientRequestToken

      public final String clientRequestToken()

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

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

    • kmsKey

      public final String kmsKey()

      An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

      Returns:
      An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

    • languageCode

      public final LanguageCode languageCode()

      The language of the input documents. 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. All documents must be in the same language.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language of the input documents. 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. All documents must be in the same language.
      See Also:

    • toBuilder

      public StartPhiDetectionJobRequest.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<StartPhiDetectionJobRequest.Builder,StartPhiDetectionJobRequest>
      Specified by:
      toBuilder in class ComprehendMedicalRequest
      Returns:
      a builder for type T

    • builder

      public static StartPhiDetectionJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartPhiDetectionJobRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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