CampaignHook (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CampaignHook
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CampaignHook()

Constructors
Constructor and Description
`CampaignHook()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CampaignHook`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getLambdaFunctionName()` The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
`String`	`getMode()` The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
`String`	`getWebUrl()` The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setLambdaFunctionName(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.
`void`	`setMode(String mode)` The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
`void`	`setWebUrl(String webUrl)` The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
`String`	`toString()` Returns a string representation of this object.
`CampaignHook`	`withLambdaFunctionName(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.
`CampaignHook`	`withMode(Mode mode)` The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
`CampaignHook`	`withMode(String mode)` The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
`CampaignHook`	`withWebUrl(String webUrl)` The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

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

- Constructor Detail
  - CampaignHook
```
public CampaignHook()
```
- Method Detail
  - setLambdaFunctionName
```
public void setLambdaFunctionName(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.
    
    Parameters:
    
    lambdaFunctionName - The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
  - getLambdaFunctionName
```
public String getLambdaFunctionName()
```
    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.
  - withLambdaFunctionName
```
public CampaignHook withLambdaFunctionName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMode
```
public void setMode(String 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.
    Parameters:
    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.
    See Also:
    
    Mode
  - getMode
```
public String getMode()
```
    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.
    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
  - withMode
```
public CampaignHook withMode(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Mode
  - withMode
```
public CampaignHook withMode(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Mode
  - setWebUrl
```
public void setWebUrl(String webUrl)
```
    The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
    
    Parameters:
    
    webUrl -
    The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
  - getWebUrl
```
public String getWebUrl()
```
    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.
  - withWebUrl
```
public CampaignHook withWebUrl(String webUrl)
```
    The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
    
    Parameters:
    
    webUrl -
    The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
    
    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 CampaignHook clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class CampaignHook

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CampaignHook

Method Detail

setLambdaFunctionName

getLambdaFunctionName

withLambdaFunctionName

setMode

getMode

withMode

withMode

setWebUrl

getWebUrl

withWebUrl

toString

equals

hashCode

clone

marshall