This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-pinpoint/include/aws/pinpoint/model/CampaignHook.h

221 lines
9.0 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/pinpoint/Pinpoint_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/pinpoint/model/Mode.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Pinpoint
{
namespace Model
{
/**
* <p>Specifies settings for invoking an AWS Lambda function that customizes a
* segment for a campaign.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/CampaignHook">AWS
* API Reference</a></p>
*/
class AWS_PINPOINT_API CampaignHook
{
public:
CampaignHook();
CampaignHook(Aws::Utils::Json::JsonView jsonValue);
CampaignHook& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
* Pinpoint invokes to customize a segment for a campaign.</p>
*/
inline const Aws::String& GetLambdaFunctionName() const{ return m_lambdaFunctionName; }
/**
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
* Pinpoint invokes to customize a segment for a campaign.</p>
*/
inline bool LambdaFunctionNameHasBeenSet() const { return m_lambdaFunctionNameHasBeenSet; }
/**
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
* Pinpoint invokes to customize a segment for a campaign.</p>
*/
inline void SetLambdaFunctionName(const Aws::String& value) { m_lambdaFunctionNameHasBeenSet = true; m_lambdaFunctionName = value; }
/**
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
* Pinpoint invokes to customize a segment for a campaign.</p>
*/
inline void SetLambdaFunctionName(Aws::String&& value) { m_lambdaFunctionNameHasBeenSet = true; m_lambdaFunctionName = std::move(value); }
/**
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
* Pinpoint invokes to customize a segment for a campaign.</p>
*/
inline void SetLambdaFunctionName(const char* value) { m_lambdaFunctionNameHasBeenSet = true; m_lambdaFunctionName.assign(value); }
/**
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
* Pinpoint invokes to customize a segment for a campaign.</p>
*/
inline CampaignHook& WithLambdaFunctionName(const Aws::String& value) { SetLambdaFunctionName(value); return *this;}
/**
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
* Pinpoint invokes to customize a segment for a campaign.</p>
*/
inline CampaignHook& WithLambdaFunctionName(Aws::String&& value) { SetLambdaFunctionName(std::move(value)); return *this;}
/**
* <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
* Pinpoint invokes to customize a segment for a campaign.</p>
*/
inline CampaignHook& WithLambdaFunctionName(const char* value) { SetLambdaFunctionName(value); return *this;}
/**
* <p>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
* Possible values are:</p> <ul><li><p>FILTER - Invoke the function to customize
* the segment that's used by a campaign.</p></li> <li><p>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.</p></li></ul>
*/
inline const Mode& GetMode() const{ return m_mode; }
/**
* <p>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
* Possible values are:</p> <ul><li><p>FILTER - Invoke the function to customize
* the segment that's used by a campaign.</p></li> <li><p>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.</p></li></ul>
*/
inline bool ModeHasBeenSet() const { return m_modeHasBeenSet; }
/**
* <p>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
* Possible values are:</p> <ul><li><p>FILTER - Invoke the function to customize
* the segment that's used by a campaign.</p></li> <li><p>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.</p></li></ul>
*/
inline void SetMode(const Mode& value) { m_modeHasBeenSet = true; m_mode = value; }
/**
* <p>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
* Possible values are:</p> <ul><li><p>FILTER - Invoke the function to customize
* the segment that's used by a campaign.</p></li> <li><p>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.</p></li></ul>
*/
inline void SetMode(Mode&& value) { m_modeHasBeenSet = true; m_mode = std::move(value); }
/**
* <p>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
* Possible values are:</p> <ul><li><p>FILTER - Invoke the function to customize
* the segment that's used by a campaign.</p></li> <li><p>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.</p></li></ul>
*/
inline CampaignHook& WithMode(const Mode& value) { SetMode(value); return *this;}
/**
* <p>The mode that Amazon Pinpoint uses to invoke the AWS Lambda function.
* Possible values are:</p> <ul><li><p>FILTER - Invoke the function to customize
* the segment that's used by a campaign.</p></li> <li><p>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.</p></li></ul>
*/
inline CampaignHook& WithMode(Mode&& value) { SetMode(std::move(value)); return *this;}
/**
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over
* HTTPS.</p>
*/
inline const Aws::String& GetWebUrl() const{ return m_webUrl; }
/**
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over
* HTTPS.</p>
*/
inline bool WebUrlHasBeenSet() const { return m_webUrlHasBeenSet; }
/**
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over
* HTTPS.</p>
*/
inline void SetWebUrl(const Aws::String& value) { m_webUrlHasBeenSet = true; m_webUrl = value; }
/**
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over
* HTTPS.</p>
*/
inline void SetWebUrl(Aws::String&& value) { m_webUrlHasBeenSet = true; m_webUrl = std::move(value); }
/**
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over
* HTTPS.</p>
*/
inline void SetWebUrl(const char* value) { m_webUrlHasBeenSet = true; m_webUrl.assign(value); }
/**
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over
* HTTPS.</p>
*/
inline CampaignHook& WithWebUrl(const Aws::String& value) { SetWebUrl(value); return *this;}
/**
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over
* HTTPS.</p>
*/
inline CampaignHook& WithWebUrl(Aws::String&& value) { SetWebUrl(std::move(value)); return *this;}
/**
* <p>The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over
* HTTPS.</p>
*/
inline CampaignHook& WithWebUrl(const char* value) { SetWebUrl(value); return *this;}
private:
Aws::String m_lambdaFunctionName;
bool m_lambdaFunctionNameHasBeenSet;
Mode m_mode;
bool m_modeHasBeenSet;
Aws::String m_webUrl;
bool m_webUrlHasBeenSet;
};
} // namespace Model
} // namespace Pinpoint
} // namespace Aws