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

Class CustomDeliveryConfiguration

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.CustomDeliveryConfiguration

All Implemented Interfaces:

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

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

Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomDeliveryConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static CustomDeliveryConfiguration.Builder	builder()
String	deliveryUri()	The destination to send the campaign or treatment to.
List<EndpointTypesElement>	endpointTypes()	The types of endpoints to send the campaign or treatment to.
List<String>	endpointTypesAsStrings()	The types of endpoints to send the campaign or treatment to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEndpointTypes()	For responses, this returns true if the service returned a value for the EndpointTypes property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CustomDeliveryConfiguration.Builder>	serializableBuilderClass()
CustomDeliveryConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

deliveryUri

public final String deliveryUri()

The destination to send the campaign or treatment to. This value can be one of the following:

• The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

• The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

Returns:

The destination to send the campaign or treatment to. This value can be one of the following:

• The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.

• The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

endpointTypes

public final List<EndpointTypesElement> endpointTypes()

The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

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 hasEndpointTypes() method.

Returns:

The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

hasEndpointTypes

public final boolean hasEndpointTypes()

For responses, this returns true if the service returned a value for the EndpointTypes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

endpointTypesAsStrings

public final List<String> endpointTypesAsStrings()

The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

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 hasEndpointTypes() method.

Returns:

The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

toBuilder

public CustomDeliveryConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomDeliveryConfiguration.Builder,CustomDeliveryConfiguration>

builder

public static CustomDeliveryConfiguration.Builder builder()

serializableBuilderClass

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