Package software.amazon.awssdk.services.transcribe.model

Class CreateCallAnalyticsCategoryRequest

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

  • Method Details

    • categoryName

      public final String categoryName()

      A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test-category.

      Category names are case sensitive.

      Returns:
      A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test-category.

      Category names are case sensitive.

    • hasRules

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

    • rules

      public final List<Rule> rules()

      Rules define a Call Analytics category. When creating a new category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.

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

      Returns:
      Rules define a Call Analytics category. When creating a new category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics category at the time you start this new job.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

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

      Returns:
      Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics category at the time you start this new job.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

    • inputType

      public final InputType inputType()

      Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.

      Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions.

      Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions.

      If you do not include InputType, your category is created as a post-call category by default.

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

      Returns:
      Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.

      Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions.

      Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions.

      If you do not include InputType, your category is created as a post-call category by default.

      See Also:

    • inputTypeAsString

      public final String inputTypeAsString()

      Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.

      Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions.

      Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions.

      If you do not include InputType, your category is created as a post-call category by default.

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

      Returns:
      Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.

      Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot be applied to streaming (real-time) transcriptions.

      Specifying REAL_TIME assigns your category to streaming transcriptions; categories with this input type cannot be applied to post-call transcriptions.

      If you do not include InputType, your category is created as a post-call category by default.

      See Also:

    • toBuilder

      public CreateCallAnalyticsCategoryRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateCallAnalyticsCategoryRequest.Builder,CreateCallAnalyticsCategoryRequest>
      Specified by:
      toBuilder in class TranscribeRequest

    • builder

      public static CreateCallAnalyticsCategoryRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo