software.amazon.awssdk.services.pinpoint.model.CampaignHook Maven / Gradle / Ivy
Show all versions of pinpoint 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.pinpoint.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.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;
/**
*
* Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CampaignHook implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField LAMBDA_FUNCTION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LambdaFunctionName").getter(getter(CampaignHook::lambdaFunctionName))
.setter(setter(Builder::lambdaFunctionName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LambdaFunctionName").build())
.build();
private static final SdkField MODE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Mode")
.getter(getter(CampaignHook::modeAsString)).setter(setter(Builder::mode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Mode").build()).build();
private static final SdkField WEB_URL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("WebUrl")
.getter(getter(CampaignHook::webUrl)).setter(setter(Builder::webUrl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WebUrl").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LAMBDA_FUNCTION_NAME_FIELD,
MODE_FIELD, WEB_URL_FIELD));
private static final long serialVersionUID = 1L;
private final String lambdaFunctionName;
private final String mode;
private final String webUrl;
private CampaignHook(BuilderImpl builder) {
this.lambdaFunctionName = builder.lambdaFunctionName;
this.mode = builder.mode;
this.webUrl = builder.webUrl;
}
/**
*
* The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a
* segment for a campaign.
*
*
* @return The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to
* customize a segment for a campaign.
*/
public final String lambdaFunctionName() {
return lambdaFunctionName;
}
/**
*
* The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
*
*
* -
*
* FILTER - Invoke the function to customize the segment that's used by a campaign.
*
*
* -
*
* DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This
* functionality is not supported anymore. To send a campaign through a custom channel, use the
* CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link Mode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
*
* -
*
* FILTER - Invoke the function to customize the segment that's used by a campaign.
*
*
* -
*
* DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel.
* This functionality is not supported anymore. To send a campaign through a custom channel, use the
* CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*
*
* @see Mode
*/
public final Mode mode() {
return Mode.fromValue(mode);
}
/**
*
* The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
*
*
* -
*
* FILTER - Invoke the function to customize the segment that's used by a campaign.
*
*
* -
*
* DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This
* functionality is not supported anymore. To send a campaign through a custom channel, use the
* CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link Mode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
*
* -
*
* FILTER - Invoke the function to customize the segment that's used by a campaign.
*
*
* -
*
* DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel.
* This functionality is not supported anymore. To send a campaign through a custom channel, use the
* CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*
*
* @see Mode
*/
public final String modeAsString() {
return mode;
}
/**
*
* The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
*
*
* @return
* The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
*
*/
public final String webUrl() {
return webUrl;
}
@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(lambdaFunctionName());
hashCode = 31 * hashCode + Objects.hashCode(modeAsString());
hashCode = 31 * hashCode + Objects.hashCode(webUrl());
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 CampaignHook)) {
return false;
}
CampaignHook other = (CampaignHook) obj;
return Objects.equals(lambdaFunctionName(), other.lambdaFunctionName())
&& Objects.equals(modeAsString(), other.modeAsString()) && Objects.equals(webUrl(), other.webUrl());
}
/**
* 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("CampaignHook").add("LambdaFunctionName", lambdaFunctionName()).add("Mode", modeAsString())
.add("WebUrl", webUrl()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "LambdaFunctionName":
return Optional.ofNullable(clazz.cast(lambdaFunctionName()));
case "Mode":
return Optional.ofNullable(clazz.cast(modeAsString()));
case "WebUrl":
return Optional.ofNullable(clazz.cast(webUrl()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CampaignHook) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a
* segment for a campaign.
*
*
* @param lambdaFunctionName
* The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to
* customize a segment for a campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lambdaFunctionName(String lambdaFunctionName);
/**
*
* The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
*
*
* -
*
* FILTER - Invoke the function to customize the segment that's used by a campaign.
*
*
* -
*
* DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This
* functionality is not supported anymore. To send a campaign through a custom channel, use the
* CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*
*
*
*
* @param mode
* The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
*
* -
*
* FILTER - Invoke the function to customize the segment that's used by a campaign.
*
*
* -
*
* DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel.
* This functionality is not supported anymore. To send a campaign through a custom channel, use the
* CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*
*
* @see Mode
* @return Returns a reference to this object so that method calls can be chained together.
* @see Mode
*/
Builder mode(String mode);
/**
*
* The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
*
*
* -
*
* FILTER - Invoke the function to customize the segment that's used by a campaign.
*
*
* -
*
* DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This
* functionality is not supported anymore. To send a campaign through a custom channel, use the
* CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*
*
*
*
* @param mode
* The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:
*
* -
*
* FILTER - Invoke the function to customize the segment that's used by a campaign.
*
*
* -
*
* DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel.
* This functionality is not supported anymore. To send a campaign through a custom channel, use the
* CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*
*
* @see Mode
* @return Returns a reference to this object so that method calls can be chained together.
* @see Mode
*/
Builder mode(Mode mode);
/**
*
* The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
*
*
* @param webUrl
*
* The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder webUrl(String webUrl);
}
static final class BuilderImpl implements Builder {
private String lambdaFunctionName;
private String mode;
private String webUrl;
private BuilderImpl() {
}
private BuilderImpl(CampaignHook model) {
lambdaFunctionName(model.lambdaFunctionName);
mode(model.mode);
webUrl(model.webUrl);
}
public final String getLambdaFunctionName() {
return lambdaFunctionName;
}
public final void setLambdaFunctionName(String lambdaFunctionName) {
this.lambdaFunctionName = lambdaFunctionName;
}
@Override
public final Builder lambdaFunctionName(String lambdaFunctionName) {
this.lambdaFunctionName = lambdaFunctionName;
return this;
}
public final String getMode() {
return mode;
}
public final void setMode(String mode) {
this.mode = mode;
}
@Override
public final Builder mode(String mode) {
this.mode = mode;
return this;
}
@Override
public final Builder mode(Mode mode) {
this.mode(mode == null ? null : mode.toString());
return this;
}
public final String getWebUrl() {
return webUrl;
}
public final void setWebUrl(String webUrl) {
this.webUrl = webUrl;
}
@Override
public final Builder webUrl(String webUrl) {
this.webUrl = webUrl;
return this;
}
@Override
public CampaignHook build() {
return new CampaignHook(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}