CustomMessageActivity (AWS Java SDK for Amazon Pinpoint 1.11.970 API)

java.lang.Object
- com.amazonaws.services.pinpoint.model.CustomMessageActivity

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CustomMessageActivity
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CustomMessageActivity()

Constructors
Constructor and Description
`CustomMessageActivity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CustomMessageActivity`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDeliveryUri()` The destination to send the campaign or treatment to.
`List<String>`	`getEndpointTypes()` The types of endpoints to send the custom message to.
`JourneyCustomMessage`	`getMessageConfig()` Specifies the message data included in a custom channel message that's sent to participants in a journey.
`String`	`getNextActivity()` The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
`String`	`getTemplateName()` The name of the custom message template to use for the message.
`String`	`getTemplateVersion()` The unique identifier for the version of the message template to use for the message.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setDeliveryUri(String deliveryUri)` The destination to send the campaign or treatment to.
`void`	`setEndpointTypes(Collection<String> endpointTypes)` The types of endpoints to send the custom message to.
`void`	`setMessageConfig(JourneyCustomMessage messageConfig)` Specifies the message data included in a custom channel message that's sent to participants in a journey.
`void`	`setNextActivity(String nextActivity)` The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
`void`	`setTemplateName(String templateName)` The name of the custom message template to use for the message.
`void`	`setTemplateVersion(String templateVersion)` The unique identifier for the version of the message template to use for the message.
`String`	`toString()` Returns a string representation of this object.
`CustomMessageActivity`	`withDeliveryUri(String deliveryUri)` The destination to send the campaign or treatment to.
`CustomMessageActivity`	`withEndpointTypes(Collection<String> endpointTypes)` The types of endpoints to send the custom message to.
`CustomMessageActivity`	`withEndpointTypes(EndpointTypesElement... endpointTypes)` The types of endpoints to send the custom message to.
`CustomMessageActivity`	`withEndpointTypes(String... endpointTypes)` The types of endpoints to send the custom message to.
`CustomMessageActivity`	`withMessageConfig(JourneyCustomMessage messageConfig)` Specifies the message data included in a custom channel message that's sent to participants in a journey.
`CustomMessageActivity`	`withNextActivity(String nextActivity)` The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
`CustomMessageActivity`	`withTemplateName(String templateName)` The name of the custom message template to use for the message.
`CustomMessageActivity`	`withTemplateVersion(String templateVersion)` The unique identifier for the version of the message template to use for the message.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CustomMessageActivity
```
public CustomMessageActivity()
```
- Method Detail
  - setDeliveryUri
```
public void setDeliveryUri(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.
    Parameters:
    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.
  - getDeliveryUri
```
public String getDeliveryUri()
```
    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.
  - withDeliveryUri
```
public CustomMessageActivity withDeliveryUri(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEndpointTypes
```
public List<String> getEndpointTypes()
```
    The types of endpoints to send the custom message 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.
    
    Returns:
    
    The types of endpoints to send the custom message 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.
    
    See Also:
    
    EndpointTypesElement
  - setEndpointTypes
```
public void setEndpointTypes(Collection<String> endpointTypes)
```
    The types of endpoints to send the custom message 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.
    
    Parameters:
    
    endpointTypes - The types of endpoints to send the custom message 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.
    
    See Also:
    
    EndpointTypesElement
  - withEndpointTypes
```
public CustomMessageActivity withEndpointTypes(String... endpointTypes)
```
    The types of endpoints to send the custom message 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setEndpointTypes(java.util.Collection) or withEndpointTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    endpointTypes - The types of endpoints to send the custom message 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointTypesElement
  - withEndpointTypes
```
public CustomMessageActivity withEndpointTypes(Collection<String> endpointTypes)
```
    The types of endpoints to send the custom message 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.
    
    Parameters:
    
    endpointTypes - The types of endpoints to send the custom message 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointTypesElement
  - withEndpointTypes
```
public CustomMessageActivity withEndpointTypes(EndpointTypesElement... endpointTypes)
```
    The types of endpoints to send the custom message 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.
    
    Parameters:
    
    endpointTypes - The types of endpoints to send the custom message 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointTypesElement
  - setMessageConfig
```
public void setMessageConfig(JourneyCustomMessage messageConfig)
```
    Specifies the message data included in a custom channel message that's sent to participants in a journey.
    
    Parameters:
    
    messageConfig - Specifies the message data included in a custom channel message that's sent to participants in a journey.
  - getMessageConfig
```
public JourneyCustomMessage getMessageConfig()
```
    Specifies the message data included in a custom channel message that's sent to participants in a journey.
    
    Returns:
    
    Specifies the message data included in a custom channel message that's sent to participants in a journey.
  - withMessageConfig
```
public CustomMessageActivity withMessageConfig(JourneyCustomMessage messageConfig)
```
    Specifies the message data included in a custom channel message that's sent to participants in a journey.
    
    Parameters:
    
    messageConfig - Specifies the message data included in a custom channel message that's sent to participants in a journey.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextActivity
```
public void setNextActivity(String nextActivity)
```
    The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
    
    Parameters:
    
    nextActivity - The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
  - getNextActivity
```
public String getNextActivity()
```
    The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
    
    Returns:
    
    The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
  - withNextActivity
```
public CustomMessageActivity withNextActivity(String nextActivity)
```
    The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
    
    Parameters:
    
    nextActivity - The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateName
```
public void setTemplateName(String templateName)
```
    The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
    
    Parameters:
    
    templateName - The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
  - getTemplateName
```
public String getTemplateName()
```
    The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
    
    Returns:
    
    The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
  - withTemplateName
```
public CustomMessageActivity withTemplateName(String templateName)
```
    The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
    
    Parameters:
    
    templateName - The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateVersion
```
public void setTemplateVersion(String templateVersion)
```
    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
    
    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
    
    Parameters:
    
    templateVersion - The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
    
    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
  - getTemplateVersion
```
public String getTemplateVersion()
```
    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
    
    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
    
    Returns:
    
    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
    
    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
  - withTemplateVersion
```
public CustomMessageActivity withTemplateVersion(String templateVersion)
```
    The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
    
    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
    
    Parameters:
    
    templateVersion - The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
    
    If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CustomMessageActivity clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class CustomMessageActivity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomMessageActivity

Method Detail

setDeliveryUri

getDeliveryUri

withDeliveryUri

getEndpointTypes

setEndpointTypes

withEndpointTypes

withEndpointTypes

withEndpointTypes

setMessageConfig

getMessageConfig

withMessageConfig

setNextActivity

getNextActivity

withNextActivity

setTemplateName

getTemplateName

withTemplateName

setTemplateVersion

getTemplateVersion

withTemplateVersion

toString

equals

hashCode

clone

marshall