Class S3BucketTranscriptSource

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

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

See Also:

  • Method Details

    • s3BucketName

      public final String s3BucketName()

      The name of the bucket containing the transcript and the associated metadata.

      Returns:
      The name of the bucket containing the transcript and the associated metadata.

    • pathFormat

      public final PathFormat pathFormat()

      The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

      Returns:
      The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

    • transcriptFormat

      public final TranscriptFormat transcriptFormat()

      The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.

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

      Returns:
      The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
      See Also:

    • transcriptFormatAsString

      public final String transcriptFormatAsString()

      The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.

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

      Returns:
      The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
      See Also:

    • transcriptFilter

      public final TranscriptFilter transcriptFilter()

      The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.

      Returns:
      The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.

      Returns:
      The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.

    • toBuilder

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

    • builder

      public static S3BucketTranscriptSource.Builder builder()

    • serializableBuilderClass

      public static Class<? extends S3BucketTranscriptSource.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.