Class CategoryProperties
- java.lang.Object
-
- software.amazon.awssdk.services.transcribe.model.CategoryProperties
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CategoryProperties.Builder,CategoryProperties>
@Generated("software.amazon.awssdk:codegen") public final class CategoryProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CategoryProperties.Builder,CategoryProperties>
Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCategoryProperties.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CategoryProperties.Builderbuilder()StringcategoryName()The name of the Call Analytics category.InstantcreateTime()The date and time the specified Call Analytics category was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRules()For responses, this returns true if the service returned a value for the Rules property.InputTypeinputType()The input type associated with the specified category.StringinputTypeAsString()The input type associated with the specified category.InstantlastUpdateTime()The date and time the specified Call Analytics category was last updated.List<Rule>rules()The rules used to define a Call Analytics category.List<SdkField<?>>sdkFields()static Class<? extends CategoryProperties.Builder>serializableBuilderClass()CategoryProperties.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
categoryName
public final String categoryName()
The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account.
- Returns:
- The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account.
-
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
public final List<Rule> rules()
The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.
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:
- The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.
-
createTime
public final Instant createTime()
The date and time the specified Call Analytics category was created.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,2022-05-04T12:32:58.761000-07:00represents 12:32 PM UTC-7 on May 4, 2022.- Returns:
- The date and time the specified Call Analytics category was created.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,2022-05-04T12:32:58.761000-07:00represents 12:32 PM UTC-7 on May 4, 2022.
-
lastUpdateTime
public final Instant lastUpdateTime()
The date and time the specified Call Analytics category was last updated.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,2022-05-05T12:45:32.691000-07:00represents 12:45 PM UTC-7 on May 5, 2022.- Returns:
- The date and time the specified Call Analytics category was last updated.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,2022-05-05T12:45:32.691000-07:00represents 12:45 PM UTC-7 on May 5, 2022.
-
inputType
public final InputType inputType()
The input type associated with the specified category.
POST_CALLrefers to a category that is applied to batch transcriptions;REAL_TIMErefers to a category that is applied to streaming transcriptions.If the service returns an enum value that is not available in the current SDK version,
inputTypewill returnInputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominputTypeAsString().- Returns:
- The input type associated with the specified category.
POST_CALLrefers to a category that is applied to batch transcriptions;REAL_TIMErefers to a category that is applied to streaming transcriptions. - See Also:
InputType
-
inputTypeAsString
public final String inputTypeAsString()
The input type associated with the specified category.
POST_CALLrefers to a category that is applied to batch transcriptions;REAL_TIMErefers to a category that is applied to streaming transcriptions.If the service returns an enum value that is not available in the current SDK version,
inputTypewill returnInputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominputTypeAsString().- Returns:
- The input type associated with the specified category.
POST_CALLrefers to a category that is applied to batch transcriptions;REAL_TIMErefers to a category that is applied to streaming transcriptions. - See Also:
InputType
-
toBuilder
public CategoryProperties.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CategoryProperties.Builder,CategoryProperties>
-
builder
public static CategoryProperties.Builder builder()
-
serializableBuilderClass
public static Class<? extends CategoryProperties.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-