Class ContentRedaction

java.lang.Object
software.amazon.awssdk.services.transcribe.model.ContentRedaction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContentRedaction.Builder,ContentRedaction>
@Generated("software.amazon.awssdk:codegen") public final class ContentRedaction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContentRedaction.Builder,ContentRedaction>

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.

See Also:

  • Method Details

    • redactionType

      public final RedactionType redactionType()

      Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

      If the service returns an enum value that is not available in the current SDK version, redactionType will return RedactionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redactionTypeAsString().

      Returns:
      Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.
      See Also:

    • redactionTypeAsString

      public final String redactionTypeAsString()

      Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

      If the service returns an enum value that is not available in the current SDK version, redactionType will return RedactionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redactionTypeAsString().

      Returns:
      Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.
      See Also:

    • redactionOutput

      public final RedactionOutput redactionOutput()

      Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

      When you choose redacted Amazon Transcribe creates only a redacted transcript.

      When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

      If the service returns an enum value that is not available in the current SDK version, redactionOutput will return RedactionOutput.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redactionOutputAsString().

      Returns:
      Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

      When you choose redacted Amazon Transcribe creates only a redacted transcript.

      When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

      See Also:

    • redactionOutputAsString

      public final String redactionOutputAsString()

      Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

      When you choose redacted Amazon Transcribe creates only a redacted transcript.

      When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

      If the service returns an enum value that is not available in the current SDK version, redactionOutput will return RedactionOutput.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redactionOutputAsString().

      Returns:
      Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

      When you choose redacted Amazon Transcribe creates only a redacted transcript.

      When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

      See Also:

    • piiEntityTypes

      public final List<PiiEntityType> piiEntityTypes()

      Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

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

      Returns:
      Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

    • hasPiiEntityTypes

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

    • piiEntityTypesAsStrings

      public final List<String> piiEntityTypesAsStrings()

      Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

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

      Returns:
      Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.

    • toBuilder

      public ContentRedaction.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<ContentRedaction.Builder,ContentRedaction>
      Returns:
      a builder for type T

    • builder

      public static ContentRedaction.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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