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:

  • Method Details

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CampaignHook.Builder,CampaignHook>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.