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

Interface CustomMessageActivity.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CustomMessageActivity.Builder,CustomMessageActivity>, SdkBuilder<CustomMessageActivity.Builder,CustomMessageActivity>, SdkPojo
Enclosing class:
CustomMessageActivity
public static interface CustomMessageActivity.Builder extends SdkPojo, CopyableBuilder<CustomMessageActivity.Builder,CustomMessageActivity>

  • Method Details

    • deliveryUri

      CustomMessageActivity.Builder deliveryUri(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.

    • endpointTypesWithStrings

      CustomMessageActivity.Builder endpointTypesWithStrings(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.

    • endpointTypesWithStrings

      CustomMessageActivity.Builder endpointTypesWithStrings(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.

    • endpointTypes

      CustomMessageActivity.Builder endpointTypes(Collection<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.

    • endpointTypes

      CustomMessageActivity.Builder endpointTypes(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.

    • messageConfig

      CustomMessageActivity.Builder messageConfig(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.

    • messageConfig

      default CustomMessageActivity.Builder messageConfig(Consumer<JourneyCustomMessage.Builder> messageConfig)

      Specifies the message data included in a custom channel message that's sent to participants in a journey.

      This is a convenience method that creates an instance of the JourneyCustomMessage.Builder avoiding the need to create one manually via JourneyCustomMessage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messageConfig(JourneyCustomMessage).

      Parameters:
      messageConfig - a consumer that will call methods on JourneyCustomMessage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextActivity

      CustomMessageActivity.Builder nextActivity(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.

    • templateName

      CustomMessageActivity.Builder templateName(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.

    • templateVersion

      CustomMessageActivity.Builder templateVersion(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.