Package software.amazon.awssdk.services.comprehendmedical.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartPhiDetectionJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartPhiDetectionJobRequest.Builder	builder()
String	clientRequestToken()	A unique identifier for the request.
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputDataConfig	inputDataConfig()	Specifies the format and location of the input data for the job.
String	jobName()	The identifier of the job.
String	kmsKey()	An AWS Key Management Service key to encrypt your output files.
LanguageCode	languageCode()	The language of the input documents.
String	languageCodeAsString()	The language of the input documents.
OutputDataConfig	outputDataConfig()	Specifies where to send the output files.
List<SdkField<?>>	sdkFields()
static Class<? extends StartPhiDetectionJobRequest.Builder>	serializableBuilderClass()
StartPhiDetectionJobRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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

LanguageCode

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:

LanguageCode

toBuilder

public StartPhiDetectionJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartPhiDetectionJobRequest.Builder,StartPhiDetectionJobRequest>

Specified by:

toBuilder in class ComprehendMedicalRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo