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 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));
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 RuleAction(BuilderImpl builder) {
this.actionType = builder.actionType;
this.taskAction = builder.taskAction;
this.eventBridgeAction = builder.eventBridgeAction;
this.assignContactCategoryAction = builder.assignContactCategoryAction;
this.sendNotificationAction = builder.sendNotificationAction;
}
/**
*
* 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.
*
*
* @return Information about the EventBridge action.
*/
public final EventBridgeActionDefinition eventBridgeAction() {
return eventBridgeAction;
}
/**
*
* Information about the contact category action.
*
*
* @return Information about the contact category action.
*/
public final AssignContactCategoryActionDefinition assignContactCategoryAction() {
return assignContactCategoryAction;
}
/**
*
* Information about the send notification action.
*
*
* @return Information about the send notification action.
*/
public final SendNotificationActionDefinition sendNotificationAction() {
return sendNotificationAction;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class 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());
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());
}
/**
* 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()).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()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RuleAction) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The type of action that creates a rule.
*
*
* @param actionType
* The type of action that creates a rule.
* @see ActionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionType
*/
Builder actionType(String actionType);
/**
*
* The type of action that creates a rule.
*
*
* @param actionType
* The type of action that creates a rule.
* @see ActionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionType
*/
Builder actionType(ActionType actionType);
/**
*
* Information about the task action. This field is required if TriggerEventSource is one of the
* following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
* OnSalesforceCaseCreate
*
*
* @param taskAction
* Information about the task action. This field is required if TriggerEventSource is one of
* the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
* OnSalesforceCaseCreate
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder taskAction(TaskActionDefinition taskAction);
/**
*
* Information about the task action. This field is required if TriggerEventSource is one of the
* following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
* OnSalesforceCaseCreate
*
* This is a convenience method that creates an instance of the {@link TaskActionDefinition.Builder} avoiding
* the need to create one manually via {@link TaskActionDefinition#builder()}.
*
*
* When the {@link Consumer} completes, {@link TaskActionDefinition.Builder#build()} is called immediately and
* its result is passed to {@link #taskAction(TaskActionDefinition)}.
*
* @param taskAction
* a consumer that will call methods on {@link TaskActionDefinition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #taskAction(TaskActionDefinition)
*/
default Builder taskAction(Consumer taskAction) {
return taskAction(TaskActionDefinition.builder().applyMutation(taskAction).build());
}
/**
*
* Information about the EventBridge action.
*
*
* @param eventBridgeAction
* Information about the EventBridge action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventBridgeAction(EventBridgeActionDefinition eventBridgeAction);
/**
*
* Information about the EventBridge action.
*
* This is a convenience method that creates an instance of the {@link EventBridgeActionDefinition.Builder}
* avoiding the need to create one manually via {@link EventBridgeActionDefinition#builder()}.
*
*
* When the {@link Consumer} completes, {@link EventBridgeActionDefinition.Builder#build()} is called
* immediately and its result is passed to {@link #eventBridgeAction(EventBridgeActionDefinition)}.
*
* @param eventBridgeAction
* a consumer that will call methods on {@link EventBridgeActionDefinition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #eventBridgeAction(EventBridgeActionDefinition)
*/
default Builder eventBridgeAction(Consumer eventBridgeAction) {
return eventBridgeAction(EventBridgeActionDefinition.builder().applyMutation(eventBridgeAction).build());
}
/**
*
* Information about the contact category action.
*
*
* @param assignContactCategoryAction
* Information about the contact category action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder assignContactCategoryAction(AssignContactCategoryActionDefinition assignContactCategoryAction);
/**
*
* Information about the contact category action.
*
* This is a convenience method that creates an instance of the
* {@link AssignContactCategoryActionDefinition.Builder} avoiding the need to create one manually via
* {@link AssignContactCategoryActionDefinition#builder()}.
*
*
* When the {@link Consumer} completes, {@link AssignContactCategoryActionDefinition.Builder#build()} is called
* immediately and its result is passed to
* {@link #assignContactCategoryAction(AssignContactCategoryActionDefinition)}.
*
* @param assignContactCategoryAction
* a consumer that will call methods on {@link AssignContactCategoryActionDefinition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #assignContactCategoryAction(AssignContactCategoryActionDefinition)
*/
default Builder assignContactCategoryAction(
Consumer assignContactCategoryAction) {
return assignContactCategoryAction(AssignContactCategoryActionDefinition.builder()
.applyMutation(assignContactCategoryAction).build());
}
/**
*
* Information about the send notification action.
*
*
* @param sendNotificationAction
* Information about the send notification action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sendNotificationAction(SendNotificationActionDefinition sendNotificationAction);
/**
*
* Information about the send notification action.
*
* This is a convenience method that creates an instance of the {@link SendNotificationActionDefinition.Builder}
* avoiding the need to create one manually via {@link SendNotificationActionDefinition#builder()}.
*
*
* When the {@link Consumer} completes, {@link SendNotificationActionDefinition.Builder#build()} is called
* immediately and its result is passed to {@link #sendNotificationAction(SendNotificationActionDefinition)}.
*
* @param sendNotificationAction
* a consumer that will call methods on {@link SendNotificationActionDefinition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #sendNotificationAction(SendNotificationActionDefinition)
*/
default Builder sendNotificationAction(Consumer sendNotificationAction) {
return sendNotificationAction(SendNotificationActionDefinition.builder().applyMutation(sendNotificationAction)
.build());
}
}
static final class BuilderImpl implements Builder {
private String actionType;
private TaskActionDefinition taskAction;
private EventBridgeActionDefinition eventBridgeAction;
private AssignContactCategoryActionDefinition assignContactCategoryAction;
private SendNotificationActionDefinition sendNotificationAction;
private BuilderImpl() {
}
private BuilderImpl(RuleAction model) {
actionType(model.actionType);
taskAction(model.taskAction);
eventBridgeAction(model.eventBridgeAction);
assignContactCategoryAction(model.assignContactCategoryAction);
sendNotificationAction(model.sendNotificationAction);
}
public final String getActionType() {
return actionType;
}
public final void setActionType(String actionType) {
this.actionType = actionType;
}
@Override
public final Builder actionType(String actionType) {
this.actionType = actionType;
return this;
}
@Override
public final Builder actionType(ActionType actionType) {
this.actionType(actionType == null ? null : actionType.toString());
return this;
}
public final TaskActionDefinition.Builder getTaskAction() {
return taskAction != null ? taskAction.toBuilder() : null;
}
public final void setTaskAction(TaskActionDefinition.BuilderImpl taskAction) {
this.taskAction = taskAction != null ? taskAction.build() : null;
}
@Override
public final Builder taskAction(TaskActionDefinition taskAction) {
this.taskAction = taskAction;
return this;
}
public final EventBridgeActionDefinition.Builder getEventBridgeAction() {
return eventBridgeAction != null ? eventBridgeAction.toBuilder() : null;
}
public final void setEventBridgeAction(EventBridgeActionDefinition.BuilderImpl eventBridgeAction) {
this.eventBridgeAction = eventBridgeAction != null ? eventBridgeAction.build() : null;
}
@Override
public final Builder eventBridgeAction(EventBridgeActionDefinition eventBridgeAction) {
this.eventBridgeAction = eventBridgeAction;
return this;
}
public final AssignContactCategoryActionDefinition.Builder getAssignContactCategoryAction() {
return assignContactCategoryAction != null ? assignContactCategoryAction.toBuilder() : null;
}
public final void setAssignContactCategoryAction(
AssignContactCategoryActionDefinition.BuilderImpl assignContactCategoryAction) {
this.assignContactCategoryAction = assignContactCategoryAction != null ? assignContactCategoryAction.build() : null;
}
@Override
public final Builder assignContactCategoryAction(AssignContactCategoryActionDefinition assignContactCategoryAction) {
this.assignContactCategoryAction = assignContactCategoryAction;
return this;
}
public final SendNotificationActionDefinition.Builder getSendNotificationAction() {
return sendNotificationAction != null ? sendNotificationAction.toBuilder() : null;
}
public final void setSendNotificationAction(SendNotificationActionDefinition.BuilderImpl sendNotificationAction) {
this.sendNotificationAction = sendNotificationAction != null ? sendNotificationAction.build() : null;
}
@Override
public final Builder sendNotificationAction(SendNotificationActionDefinition sendNotificationAction) {
this.sendNotificationAction = sendNotificationAction;
return this;
}
@Override
public RuleAction build() {
return new RuleAction(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}