Interface AnalyticsSessionFilter.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<AnalyticsSessionFilter.Builder,AnalyticsSessionFilter>,SdkBuilder<AnalyticsSessionFilter.Builder,AnalyticsSessionFilter>,SdkPojo
- Enclosing class:
- AnalyticsSessionFilter
public static interface AnalyticsSessionFilter.Builder extends SdkPojo, CopyableBuilder<AnalyticsSessionFilter.Builder,AnalyticsSessionFilter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AnalyticsSessionFilter.Buildername(String name)The category by which to filter the sessions.AnalyticsSessionFilter.Buildername(AnalyticsSessionFilterName name)The category by which to filter the sessions.AnalyticsSessionFilter.Builderoperator(String operator)The operation by which to filter the category.AnalyticsSessionFilter.Builderoperator(AnalyticsFilterOperator operator)The operation by which to filter the category.AnalyticsSessionFilter.Buildervalues(String... values)An array containing the values of the category by which to apply the operator to filter the results.AnalyticsSessionFilter.Buildervalues(Collection<String> 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.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
name
AnalyticsSessionFilter.Builder name(String 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AnalyticsSessionFilterName,AnalyticsSessionFilterName
-
-
name
AnalyticsSessionFilter.Builder name(AnalyticsSessionFilterName 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AnalyticsSessionFilterName,AnalyticsSessionFilterName
-
-
operator
AnalyticsSessionFilter.Builder operator(String 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AnalyticsFilterOperator,AnalyticsFilterOperator
-
-
operator
AnalyticsSessionFilter.Builder operator(AnalyticsFilterOperator 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AnalyticsFilterOperator,AnalyticsFilterOperator
-
-
values
AnalyticsSessionFilter.Builder values(Collection<String> 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
EQorCO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename,operator, andvaluesfields areModality,EQ, and[Speech, Text], the operation filters for results where the modality was eitherSpeechorText.- Parameters:
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 isEQorCO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename,operator, andvaluesfields areModality,EQ, and[Speech, Text], the operation filters for results where the modality was eitherSpeechorText.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
values
AnalyticsSessionFilter.Builder values(String... 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
EQorCO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename,operator, andvaluesfields areModality,EQ, and[Speech, Text], the operation filters for results where the modality was eitherSpeechorText.- Parameters:
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 isEQorCO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename,operator, andvaluesfields areModality,EQ, and[Speech, Text], the operation filters for results where the modality was eitherSpeechorText.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-