Class RuleAction

java.lang.Object
software.amazon.awssdk.services.connect.model.RuleAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RuleAction.Builder,RuleAction>
@Generated("software.amazon.awssdk:codegen") public final class RuleAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RuleAction.Builder,RuleAction>

Information about the action to be performed when a rule is triggered.

See Also:

  • Method Details

    • actionType

      public final ActionType actionType()

      The type of action that creates a rule.

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

      Returns:
      The type of action that creates a rule.
      See Also:

    • actionTypeAsString

      public final String actionTypeAsString()

      The type of action that creates a rule.

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

      Returns:
      The type of action that creates a rule.
      See Also:

    • taskAction

      public final TaskActionDefinition taskAction()

      Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

      Returns:
      Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

    • eventBridgeAction

      public final EventBridgeActionDefinition eventBridgeAction()

      Information about the EventBridge action.

      Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

      Returns:
      Information about the EventBridge action.

      Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

    • assignContactCategoryAction

      public final AssignContactCategoryActionDefinition assignContactCategoryAction()

      Information about the contact category action.

      Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

      Returns:
      Information about the contact category action.

      Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

    • sendNotificationAction

      public final SendNotificationActionDefinition sendNotificationAction()

      Information about the send notification action.

      Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

      Returns:
      Information about the send notification action.

      Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate

    • createCaseAction

      public final CreateCaseActionDefinition createCaseAction()

      Information about the create case action.

      Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.

      Returns:
      Information about the create case action.

      Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.

    • updateCaseAction

      public final UpdateCaseActionDefinition updateCaseAction()

      Information about the update case action.

      Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.

      Returns:
      Information about the update case action.

      Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.

    • endAssociatedTasksAction

      public final EndAssociatedTasksActionDefinition endAssociatedTasksAction()

      Information about the end associated tasks action.

      Supported only for TriggerEventSource values: OnCaseUpdate.

      Returns:
      Information about the end associated tasks action.

      Supported only for TriggerEventSource values: OnCaseUpdate.

    • submitAutoEvaluationAction

      public final SubmitAutoEvaluationActionDefinition submitAutoEvaluationAction()

      Information about the submit automated evaluation action.

      Returns:
      Information about the submit automated evaluation action.

    • toBuilder

      public RuleAction.Builder 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 interface ToCopyableBuilder<RuleAction.Builder,RuleAction>
      Returns:
      a builder for type T

    • builder

      public static RuleAction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RuleAction.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.