software.amazon.awssdk.services.comprehend.model

Interface PiiEntity.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PiiEntity.Builder,PiiEntity>, SdkBuilder<PiiEntity.Builder,PiiEntity>, SdkPojo

Enclosing class:

PiiEntity

public static interface PiiEntity.Builder
extends SdkPojo, CopyableBuilder<PiiEntity.Builder,PiiEntity>

Method Summary

Modifier and Type	Method and Description
PiiEntity.Builder	beginOffset(Integer beginOffset) A character offset in the input text that shows where the PII entity begins (the first character is at position 0).
PiiEntity.Builder	endOffset(Integer endOffset) A character offset in the input text that shows where the PII entity ends.
PiiEntity.Builder	score(Float score) The level of confidence that Amazon Comprehend has in the accuracy of the detection.
PiiEntity.Builder	type(PiiEntityType type) The entity's type.
PiiEntity.Builder	type(String type) The entity's type.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

score

PiiEntity.Builder score(Float score)

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Parameters:

score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

PiiEntity.Builder type(String type)

The entity's type.

Parameters:

type - The entity's type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PiiEntityType, PiiEntityType

type

PiiEntity.Builder type(PiiEntityType type)

The entity's type.

Parameters:

type - The entity's type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PiiEntityType, PiiEntityType

beginOffset

PiiEntity.Builder beginOffset(Integer beginOffset)

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Parameters:

beginOffset - A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

Returns a reference to this object so that method calls can be chained together.

endOffset

PiiEntity.Builder endOffset(Integer endOffset)

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Parameters:

endOffset - A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

Returns a reference to this object so that method calls can be chained together.