Class CreateCallAnalyticsCategoryRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateCallAnalyticsCategoryRequest.Builder,
CreateCallAnalyticsCategoryRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique name, chosen by you, for your Call Analytics category.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasRules()
For responses, this returns true if the service returned a value for the Rules property.final InputType
Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.final String
Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.rules()
Rules define a Call Analytics category.static Class
<? extends CreateCallAnalyticsCategoryRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 liketest-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 liketest-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 theisEmpty()
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
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.
-
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 returnInputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputTypeAsString()
.- 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
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 returnInputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputTypeAsString()
.- 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
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 interfaceToCopyableBuilder<CreateCallAnalyticsCategoryRequest.Builder,
CreateCallAnalyticsCategoryRequest> - Specified by:
toBuilder
in classTranscribeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateCallAnalyticsCategoryRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-