software.amazon.awssdk.services.connect.model.UpdateRuleRequest 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.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateRuleRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField RULE_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("RuleId")
.getter(getter(UpdateRuleRequest::ruleId)).setter(setter(Builder::ruleId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("RuleId").build()).build();
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(UpdateRuleRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(UpdateRuleRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField FUNCTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Function").getter(getter(UpdateRuleRequest::function)).setter(setter(Builder::function))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Function").build()).build();
private static final SdkField> ACTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Actions")
.getter(getter(UpdateRuleRequest::actions))
.setter(setter(Builder::actions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Actions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RuleAction::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField PUBLISH_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PublishStatus").getter(getter(UpdateRuleRequest::publishStatusAsString))
.setter(setter(Builder::publishStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PublishStatus").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RULE_ID_FIELD,
INSTANCE_ID_FIELD, NAME_FIELD, FUNCTION_FIELD, ACTIONS_FIELD, PUBLISH_STATUS_FIELD));
private final String ruleId;
private final String instanceId;
private final String name;
private final String function;
private final List actions;
private final String publishStatus;
private UpdateRuleRequest(BuilderImpl builder) {
super(builder);
this.ruleId = builder.ruleId;
this.instanceId = builder.instanceId;
this.name = builder.name;
this.function = builder.function;
this.actions = builder.actions;
this.publishStatus = builder.publishStatus;
}
/**
*
* A unique identifier for the rule.
*
*
* @return A unique identifier for the rule.
*/
public final String ruleId() {
return ruleId;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The name of the rule. You can change the name only if TriggerEventSource is one of the following
* values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
* OnSalesforceCaseCreate
*
*
* @return The name of the rule. You can change the name only if TriggerEventSource is one of the
* following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
* OnSalesforceCaseCreate
*/
public final String name() {
return name;
}
/**
*
* The conditions of the rule.
*
*
* @return The conditions of the rule.
*/
public final String function() {
return function;
}
/**
* For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} 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.
*/
public final boolean hasActions() {
return actions != null && !(actions instanceof SdkAutoConstructList);
}
/**
*
* A list of actions to be run when the rule is triggered.
*
*
* 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 {@link #hasActions} method.
*
*
* @return A list of actions to be run when the rule is triggered.
*/
public final List actions() {
return actions;
}
/**
*
* The publish status of the rule.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #publishStatus}
* will return {@link RulePublishStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #publishStatusAsString}.
*
*
* @return The publish status of the rule.
* @see RulePublishStatus
*/
public final RulePublishStatus publishStatus() {
return RulePublishStatus.fromValue(publishStatus);
}
/**
*
* The publish status of the rule.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #publishStatus}
* will return {@link RulePublishStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #publishStatusAsString}.
*
*
* @return The publish status of the rule.
* @see RulePublishStatus
*/
public final String publishStatusAsString() {
return publishStatus;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(ruleId());
hashCode = 31 * hashCode + Objects.hashCode(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(function());
hashCode = 31 * hashCode + Objects.hashCode(hasActions() ? actions() : null);
hashCode = 31 * hashCode + Objects.hashCode(publishStatusAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateRuleRequest)) {
return false;
}
UpdateRuleRequest other = (UpdateRuleRequest) obj;
return Objects.equals(ruleId(), other.ruleId()) && Objects.equals(instanceId(), other.instanceId())
&& Objects.equals(name(), other.name()) && Objects.equals(function(), other.function())
&& hasActions() == other.hasActions() && Objects.equals(actions(), other.actions())
&& Objects.equals(publishStatusAsString(), other.publishStatusAsString());
}
/**
* 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("UpdateRuleRequest").add("RuleId", ruleId()).add("InstanceId", instanceId()).add("Name", name())
.add("Function", function()).add("Actions", hasActions() ? actions() : null)
.add("PublishStatus", publishStatusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RuleId":
return Optional.ofNullable(clazz.cast(ruleId()));
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Function":
return Optional.ofNullable(clazz.cast(function()));
case "Actions":
return Optional.ofNullable(clazz.cast(actions()));
case "PublishStatus":
return Optional.ofNullable(clazz.cast(publishStatusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateRuleRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A unique identifier for the rule.
*
*
* @param ruleId
* A unique identifier for the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleId(String ruleId);
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The name of the rule. You can change the name only if TriggerEventSource is one of the following
* values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
* OnSalesforceCaseCreate
*
*
* @param name
* The name of the rule. You can change the name only 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 name(String name);
/**
*
* The conditions of the rule.
*
*
* @param function
* The conditions of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder function(String function);
/**
*
* A list of actions to be run when the rule is triggered.
*
*
* @param actions
* A list of actions to be run when the rule is triggered.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(Collection actions);
/**
*
* A list of actions to be run when the rule is triggered.
*
*
* @param actions
* A list of actions to be run when the rule is triggered.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(RuleAction... actions);
/**
*
* A list of actions to be run when the rule is triggered.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.RuleAction.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.connect.model.RuleAction#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.RuleAction.Builder#build()} is called immediately and
* its result is passed to {@link #actions(List)}.
*
* @param actions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.RuleAction.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #actions(java.util.Collection)
*/
Builder actions(Consumer... actions);
/**
*
* The publish status of the rule.
*
*
* @param publishStatus
* The publish status of the rule.
* @see RulePublishStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see RulePublishStatus
*/
Builder publishStatus(String publishStatus);
/**
*
* The publish status of the rule.
*
*
* @param publishStatus
* The publish status of the rule.
* @see RulePublishStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see RulePublishStatus
*/
Builder publishStatus(RulePublishStatus publishStatus);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String ruleId;
private String instanceId;
private String name;
private String function;
private List actions = DefaultSdkAutoConstructList.getInstance();
private String publishStatus;
private BuilderImpl() {
}
private BuilderImpl(UpdateRuleRequest model) {
super(model);
ruleId(model.ruleId);
instanceId(model.instanceId);
name(model.name);
function(model.function);
actions(model.actions);
publishStatus(model.publishStatus);
}
public final String getRuleId() {
return ruleId;
}
public final void setRuleId(String ruleId) {
this.ruleId = ruleId;
}
@Override
public final Builder ruleId(String ruleId) {
this.ruleId = ruleId;
return this;
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getFunction() {
return function;
}
public final void setFunction(String function) {
this.function = function;
}
@Override
public final Builder function(String function) {
this.function = function;
return this;
}
public final List getActions() {
List result = RuleActionsCopier.copyToBuilder(this.actions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setActions(Collection actions) {
this.actions = RuleActionsCopier.copyFromBuilder(actions);
}
@Override
public final Builder actions(Collection actions) {
this.actions = RuleActionsCopier.copy(actions);
return this;
}
@Override
@SafeVarargs
public final Builder actions(RuleAction... actions) {
actions(Arrays.asList(actions));
return this;
}
@Override
@SafeVarargs
public final Builder actions(Consumer... actions) {
actions(Stream.of(actions).map(c -> RuleAction.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getPublishStatus() {
return publishStatus;
}
public final void setPublishStatus(String publishStatus) {
this.publishStatus = publishStatus;
}
@Override
public final Builder publishStatus(String publishStatus) {
this.publishStatus = publishStatus;
return this;
}
@Override
public final Builder publishStatus(RulePublishStatus publishStatus) {
this.publishStatus(publishStatus == null ? null : publishStatus.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateRuleRequest build() {
return new UpdateRuleRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}