Class AnalyticsSessionFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AnalyticsSessionFilter.Builder,
AnalyticsSessionFilter>
Contains fields describing a condition by which to filter the sessions. The expression may be understood as
name
operator
values
. For example:
-
LocaleId EQ en
– The locale is "en". -
Duration GT 200
– The duration is greater than 200 seconds.
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Values property.name()
The category by which to filter the sessions.final String
The category by which to filter the sessions.final AnalyticsFilterOperator
operator()
The operation by which to filter the category.final String
The operation by which to filter the category.static Class
<? extends AnalyticsSessionFilter.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.values()
An array containing the values of the category by which to apply the operator to filter the results.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The category by which to filter the sessions. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
Duration
– The duration of the session. -
conversationEndState
– The final state of the session. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentPath
– The order of intents taken in a session.
If the service returns an enum value that is not available in the current SDK version,
name
will returnAnalyticsSessionFilterName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The category by which to filter the sessions. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
Duration
– The duration of the session. -
conversationEndState
– The final state of the session. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentPath
– The order of intents taken in a session.
-
- See Also:
-
-
nameAsString
The category by which to filter the sessions. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
Duration
– The duration of the session. -
conversationEndState
– The final state of the session. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentPath
– The order of intents taken in a session.
If the service returns an enum value that is not available in the current SDK version,
name
will returnAnalyticsSessionFilterName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The category by which to filter the sessions. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
Duration
– The duration of the session. -
conversationEndState
– The final state of the session. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentPath
– The order of intents taken in a session.
-
- See Also:
-
-
operator
The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
If the service returns an enum value that is not available in the current SDK version,
operator
will returnAnalyticsFilterOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatorAsString()
.- Returns:
- The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
-
- See Also:
-
-
operatorAsString
The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
If the service returns an enum value that is not available in the current SDK version,
operator
will returnAnalyticsFilterOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatorAsString()
.- Returns:
- The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
-
- See Also:
-
-
hasValues
public final boolean hasValues()For responses, this returns true if the service returned a value for the Values 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. -
values
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.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
hasValues()
method.- Returns:
- An array containing the values of the category by which to apply the operator to filter the results. You
can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
-
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<AnalyticsSessionFilter.Builder,
AnalyticsSessionFilter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-