Package software.amazon.awssdk.services.pinpoint.model

Class CampaignHook

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.CampaignHook

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CampaignHook.Builder,CampaignHook>

@Generated("software.amazon.awssdk:codegen")
public final class CampaignHook
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CampaignHook.Builder,CampaignHook>

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CampaignHook.Builder

Method Summary

Modifier and Type	Method	Description
static CampaignHook.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	lambdaFunctionName()	The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
Mode	mode()	The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
String	modeAsString()	The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
List<SdkField<?>>	sdkFields()
static Class<? extends CampaignHook.Builder>	serializableBuilderClass()
CampaignHook.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	webUrl()	The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

lambdaFunctionName

public final String lambdaFunctionName()

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

Returns:

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

mode

public final Mode 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, mode will return Mode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

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 Also:

Mode

modeAsString

public final String modeAsString()

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, mode will return Mode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

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 Also:

Mode

webUrl

public final String webUrl()

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

Returns:

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

toBuilder

public CampaignHook.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CampaignHook.Builder,CampaignHook>

builder

public static CampaignHook.Builder builder()

serializableBuilderClass

public static Class<? extends CampaignHook.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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