software.amazon.awssdk.services.connect.model.RuleAction Maven / Gradle / Ivy
Show all versions of connect Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.connect.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about the action to be performed when a rule is triggered.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RuleAction implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ACTION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ActionType").getter(getter(RuleAction::actionTypeAsString)).setter(setter(Builder::actionType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ActionType").build()).build();
private static final SdkField TASK_ACTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TaskAction")
.getter(getter(RuleAction::taskAction)).setter(setter(Builder::taskAction))
.constructor(TaskActionDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TaskAction").build()).build();
private static final SdkField EVENT_BRIDGE_ACTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("EventBridgeAction")
.getter(getter(RuleAction::eventBridgeAction)).setter(setter(Builder::eventBridgeAction))
.constructor(EventBridgeActionDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventBridgeAction").build()).build();
private static final SdkField ASSIGN_CONTACT_CATEGORY_ACTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("AssignContactCategoryAction")
.getter(getter(RuleAction::assignContactCategoryAction))
.setter(setter(Builder::assignContactCategoryAction))
.constructor(AssignContactCategoryActionDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AssignContactCategoryAction")
.build()).build();
private static final SdkField SEND_NOTIFICATION_ACTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SendNotificationAction")
.getter(getter(RuleAction::sendNotificationAction)).setter(setter(Builder::sendNotificationAction))
.constructor(SendNotificationActionDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SendNotificationAction").build())
.build();
private static final SdkField CREATE_CASE_ACTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("CreateCaseAction")
.getter(getter(RuleAction::createCaseAction)).setter(setter(Builder::createCaseAction))
.constructor(CreateCaseActionDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateCaseAction").build()).build();
private static final SdkField UPDATE_CASE_ACTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("UpdateCaseAction")
.getter(getter(RuleAction::updateCaseAction)).setter(setter(Builder::updateCaseAction))
.constructor(UpdateCaseActionDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpdateCaseAction").build()).build();
private static final SdkField END_ASSOCIATED_TASKS_ACTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("EndAssociatedTasksAction")
.getter(getter(RuleAction::endAssociatedTasksAction)).setter(setter(Builder::endAssociatedTasksAction))
.constructor(EndAssociatedTasksActionDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndAssociatedTasksAction").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACTION_TYPE_FIELD,
TASK_ACTION_FIELD, EVENT_BRIDGE_ACTION_FIELD, ASSIGN_CONTACT_CATEGORY_ACTION_FIELD, SEND_NOTIFICATION_ACTION_FIELD,
CREATE_CASE_ACTION_FIELD, UPDATE_CASE_ACTION_FIELD, END_ASSOCIATED_TASKS_ACTION_FIELD));
private static final long serialVersionUID = 1L;
private final String actionType;
private final TaskActionDefinition taskAction;
private final EventBridgeActionDefinition eventBridgeAction;
private final AssignContactCategoryActionDefinition assignContactCategoryAction;
private final SendNotificationActionDefinition sendNotificationAction;
private final CreateCaseActionDefinition createCaseAction;
private final UpdateCaseActionDefinition updateCaseAction;
private final EndAssociatedTasksActionDefinition endAssociatedTasksAction;
private RuleAction(BuilderImpl builder) {
this.actionType = builder.actionType;
this.taskAction = builder.taskAction;
this.eventBridgeAction = builder.eventBridgeAction;
this.assignContactCategoryAction = builder.assignContactCategoryAction;
this.sendNotificationAction = builder.sendNotificationAction;
this.createCaseAction = builder.createCaseAction;
this.updateCaseAction = builder.updateCaseAction;
this.endAssociatedTasksAction = builder.endAssociatedTasksAction;
}
/**
*
* The type of action that creates a rule.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #actionType} will
* return {@link ActionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #actionTypeAsString}.
*
*
* @return The type of action that creates a rule.
* @see ActionType
*/
public final ActionType actionType() {
return ActionType.fromValue(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, {@link #actionType} will
* return {@link ActionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #actionTypeAsString}.
*
*
* @return The type of action that creates a rule.
* @see ActionType
*/
public final String actionTypeAsString() {
return actionType;
}
/**
*
* Information about the task action. This field is required if TriggerEventSource
is one of the
* following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
|
* OnSalesforceCaseCreate
*
*
* @return Information about the task action. This field is required if TriggerEventSource
is one of
* the following values: OnZendeskTicketCreate
| OnZendeskTicketStatusUpdate
|
* OnSalesforceCaseCreate
*/
public final TaskActionDefinition taskAction() {
return taskAction;
}
/**
*
* Information about the EventBridge action.
*
*
* Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
|
* OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
|
* OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
|
* OnMetricDataUpdate
*
*
* @return Information about the EventBridge action.
*
* Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
|
* OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
|
* OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
|
* OnMetricDataUpdate
*/
public final EventBridgeActionDefinition eventBridgeAction() {
return eventBridgeAction;
}
/**
*
* Information about the contact category action.
*
*
* Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
|
* OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
|
* OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
|
* OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
*
*
* @return Information about the contact category action.
*
* Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
|
* OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
|
* OnPostChatAnalysisAvailable
| OnZendeskTicketCreate
|
* OnZendeskTicketStatusUpdate
| OnSalesforceCaseCreate
*/
public final AssignContactCategoryActionDefinition assignContactCategoryAction() {
return assignContactCategoryAction;
}
/**
*
* Information about the send notification action.
*
*
* Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
|
* OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
|
* OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
|
* OnMetricDataUpdate
*
*
* @return Information about the send notification action.
*
* Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
|
* OnRealTimeCallAnalysisAvailable
| OnRealTimeChatAnalysisAvailable
|
* OnPostChatAnalysisAvailable
| OnContactEvaluationSubmit
|
* OnMetricDataUpdate
*/
public final SendNotificationActionDefinition sendNotificationAction() {
return sendNotificationAction;
}
/**
*
* Information about the create case action.
*
*
* Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
|
* OnPostChatAnalysisAvailable
.
*
*
* @return Information about the create case action.
*
* Supported only for TriggerEventSource
values: OnPostCallAnalysisAvailable
|
* OnPostChatAnalysisAvailable
.
*/
public final CreateCaseActionDefinition createCaseAction() {
return createCaseAction;
}
/**
*
* Information about the update case action.
*
*
* Supported only for TriggerEventSource
values: OnCaseCreate
| OnCaseUpdate
.
*
*
* @return Information about the update case action.
*
* Supported only for TriggerEventSource
values: OnCaseCreate
|
* OnCaseUpdate
.
*/
public final UpdateCaseActionDefinition updateCaseAction() {
return updateCaseAction;
}
/**
*
* Information about the end associated tasks action.
*
*
* Supported only for TriggerEventSource
values: OnCaseUpdate
.
*
*
* @return Information about the end associated tasks action.
*
* Supported only for TriggerEventSource
values: OnCaseUpdate
.
*/
public final EndAssociatedTasksActionDefinition endAssociatedTasksAction() {
return endAssociatedTasksAction;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(actionTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(taskAction());
hashCode = 31 * hashCode + Objects.hashCode(eventBridgeAction());
hashCode = 31 * hashCode + Objects.hashCode(assignContactCategoryAction());
hashCode = 31 * hashCode + Objects.hashCode(sendNotificationAction());
hashCode = 31 * hashCode + Objects.hashCode(createCaseAction());
hashCode = 31 * hashCode + Objects.hashCode(updateCaseAction());
hashCode = 31 * hashCode + Objects.hashCode(endAssociatedTasksAction());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RuleAction)) {
return false;
}
RuleAction other = (RuleAction) obj;
return Objects.equals(actionTypeAsString(), other.actionTypeAsString())
&& Objects.equals(taskAction(), other.taskAction())
&& Objects.equals(eventBridgeAction(), other.eventBridgeAction())
&& Objects.equals(assignContactCategoryAction(), other.assignContactCategoryAction())
&& Objects.equals(sendNotificationAction(), other.sendNotificationAction())
&& Objects.equals(createCaseAction(), other.createCaseAction())
&& Objects.equals(updateCaseAction(), other.updateCaseAction())
&& Objects.equals(endAssociatedTasksAction(), other.endAssociatedTasksAction());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("RuleAction").add("ActionType", actionTypeAsString()).add("TaskAction", taskAction())
.add("EventBridgeAction", eventBridgeAction()).add("AssignContactCategoryAction", assignContactCategoryAction())
.add("SendNotificationAction", sendNotificationAction()).add("CreateCaseAction", createCaseAction())
.add("UpdateCaseAction", updateCaseAction()).add("EndAssociatedTasksAction", endAssociatedTasksAction()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ActionType":
return Optional.ofNullable(clazz.cast(actionTypeAsString()));
case "TaskAction":
return Optional.ofNullable(clazz.cast(taskAction()));
case "EventBridgeAction":
return Optional.ofNullable(clazz.cast(eventBridgeAction()));
case "AssignContactCategoryAction":
return Optional.ofNullable(clazz.cast(assignContactCategoryAction()));
case "SendNotificationAction":
return Optional.ofNullable(clazz.cast(sendNotificationAction()));
case "CreateCaseAction":
return Optional.ofNullable(clazz.cast(createCaseAction()));
case "UpdateCaseAction":
return Optional.ofNullable(clazz.cast(updateCaseAction()));
case "EndAssociatedTasksAction":
return Optional.ofNullable(clazz.cast(endAssociatedTasksAction()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function