729 lines
34 KiB
C
729 lines
34 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/AWSMap.h>
|
|||
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|||
|
|
#include <aws/pinpoint/model/JourneyLimits.h>
|
|||
|
|
#include <aws/pinpoint/model/QuietTime.h>
|
|||
|
|
#include <aws/pinpoint/model/JourneySchedule.h>
|
|||
|
|
#include <aws/pinpoint/model/StartCondition.h>
|
|||
|
|
#include <aws/pinpoint/model/State.h>
|
|||
|
|
#include <aws/pinpoint/model/Activity.h>
|
|||
|
|
#include <utility>
|
|||
|
|
|
|||
|
|
namespace Aws
|
|||
|
|
{
|
|||
|
|
namespace Utils
|
|||
|
|
{
|
|||
|
|
namespace Json
|
|||
|
|
{
|
|||
|
|
class JsonValue;
|
|||
|
|
class JsonView;
|
|||
|
|
} // namespace Json
|
|||
|
|
} // namespace Utils
|
|||
|
|
namespace Pinpoint
|
|||
|
|
{
|
|||
|
|
namespace Model
|
|||
|
|
{
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Specifies the configuration and other settings for a journey.</p><p><h3>See
|
|||
|
|
* Also:</h3> <a
|
|||
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/WriteJourneyRequest">AWS
|
|||
|
|
* API Reference</a></p>
|
|||
|
|
*/
|
|||
|
|
class AWS_PINPOINT_API WriteJourneyRequest
|
|||
|
|
{
|
|||
|
|
public:
|
|||
|
|
WriteJourneyRequest();
|
|||
|
|
WriteJourneyRequest(Aws::Utils::Json::JsonView jsonValue);
|
|||
|
|
WriteJourneyRequest& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|||
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::Map<Aws::String, Activity>& GetActivities() const{ return m_activities; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool ActivitiesHasBeenSet() const { return m_activitiesHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetActivities(const Aws::Map<Aws::String, Activity>& value) { m_activitiesHasBeenSet = true; m_activities = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetActivities(Aws::Map<Aws::String, Activity>&& value) { m_activitiesHasBeenSet = true; m_activities = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithActivities(const Aws::Map<Aws::String, Activity>& value) { SetActivities(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithActivities(Aws::Map<Aws::String, Activity>&& value) { SetActivities(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& AddActivities(const Aws::String& key, const Activity& value) { m_activitiesHasBeenSet = true; m_activities.emplace(key, value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& AddActivities(Aws::String&& key, const Activity& value) { m_activitiesHasBeenSet = true; m_activities.emplace(std::move(key), value); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& AddActivities(const Aws::String& key, Activity&& value) { m_activitiesHasBeenSet = true; m_activities.emplace(key, std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& AddActivities(Aws::String&& key, Activity&& value) { m_activitiesHasBeenSet = true; m_activities.emplace(std::move(key), std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& AddActivities(const char* key, Activity&& value) { m_activitiesHasBeenSet = true; m_activities.emplace(key, std::move(value)); return *this; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A map that contains a set of Activity objects, one object for each activity
|
|||
|
|
* in the journey. For each Activity object, the key is the unique identifier
|
|||
|
|
* (string) for an activity and the value is the settings for the activity. An
|
|||
|
|
* activity identifier can contain a maximum of 100 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& AddActivities(const char* key, const Activity& value) { m_activitiesHasBeenSet = true; m_activities.emplace(key, value); return *this; }
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetCreationDate() const{ return m_creationDate; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetCreationDate(const Aws::String& value) { m_creationDateHasBeenSet = true; m_creationDate = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetCreationDate(Aws::String&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetCreationDate(const char* value) { m_creationDateHasBeenSet = true; m_creationDate.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithCreationDate(const Aws::String& value) { SetCreationDate(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithCreationDate(Aws::String&& value) { SetCreationDate(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was created.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithCreationDate(const char* value) { SetCreationDate(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was last modified.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetLastModifiedDate() const{ return m_lastModifiedDate; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was last modified.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool LastModifiedDateHasBeenSet() const { return m_lastModifiedDateHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was last modified.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetLastModifiedDate(const Aws::String& value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was last modified.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetLastModifiedDate(Aws::String&& value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was last modified.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetLastModifiedDate(const char* value) { m_lastModifiedDateHasBeenSet = true; m_lastModifiedDate.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was last modified.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithLastModifiedDate(const Aws::String& value) { SetLastModifiedDate(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was last modified.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithLastModifiedDate(Aws::String&& value) { SetLastModifiedDate(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The date, in ISO 8601 format, when the journey was last modified.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithLastModifiedDate(const char* value) { SetLastModifiedDate(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The messaging and entry limits for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline const JourneyLimits& GetLimits() const{ return m_limits; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The messaging and entry limits for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool LimitsHasBeenSet() const { return m_limitsHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The messaging and entry limits for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetLimits(const JourneyLimits& value) { m_limitsHasBeenSet = true; m_limits = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The messaging and entry limits for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetLimits(JourneyLimits&& value) { m_limitsHasBeenSet = true; m_limits = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The messaging and entry limits for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithLimits(const JourneyLimits& value) { SetLimits(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The messaging and entry limits for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithLimits(JourneyLimits&& value) { SetLimits(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Specifies whether the journey's scheduled start and end times use each
|
|||
|
|
* participant's local time. To base the schedule on each participant's local time,
|
|||
|
|
* set this value to true.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool GetLocalTime() const{ return m_localTime; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Specifies whether the journey's scheduled start and end times use each
|
|||
|
|
* participant's local time. To base the schedule on each participant's local time,
|
|||
|
|
* set this value to true.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool LocalTimeHasBeenSet() const { return m_localTimeHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Specifies whether the journey's scheduled start and end times use each
|
|||
|
|
* participant's local time. To base the schedule on each participant's local time,
|
|||
|
|
* set this value to true.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetLocalTime(bool value) { m_localTimeHasBeenSet = true; m_localTime = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>Specifies whether the journey's scheduled start and end times use each
|
|||
|
|
* participant's local time. To base the schedule on each participant's local time,
|
|||
|
|
* set this value to true.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithLocalTime(bool value) { SetLocalTime(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the journey. A journey name can contain a maximum of 150
|
|||
|
|
* characters. The characters can be alphanumeric characters or symbols, such as
|
|||
|
|
* underscores (_) or hyphens (-). A journey name can't contain any spaces.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetName() const{ return m_name; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the journey. A journey name can contain a maximum of 150
|
|||
|
|
* characters. The characters can be alphanumeric characters or symbols, such as
|
|||
|
|
* underscores (_) or hyphens (-). A journey name can't contain any spaces.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the journey. A journey name can contain a maximum of 150
|
|||
|
|
* characters. The characters can be alphanumeric characters or symbols, such as
|
|||
|
|
* underscores (_) or hyphens (-). A journey name can't contain any spaces.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the journey. A journey name can contain a maximum of 150
|
|||
|
|
* characters. The characters can be alphanumeric characters or symbols, such as
|
|||
|
|
* underscores (_) or hyphens (-). A journey name can't contain any spaces.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the journey. A journey name can contain a maximum of 150
|
|||
|
|
* characters. The characters can be alphanumeric characters or symbols, such as
|
|||
|
|
* underscores (_) or hyphens (-). A journey name can't contain any spaces.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the journey. A journey name can contain a maximum of 150
|
|||
|
|
* characters. The characters can be alphanumeric characters or symbols, such as
|
|||
|
|
* underscores (_) or hyphens (-). A journey name can't contain any spaces.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the journey. A journey name can contain a maximum of 150
|
|||
|
|
* characters. The characters can be alphanumeric characters or symbols, such as
|
|||
|
|
* underscores (_) or hyphens (-). A journey name can't contain any spaces.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the journey. A journey name can contain a maximum of 150
|
|||
|
|
* characters. The characters can be alphanumeric characters or symbols, such as
|
|||
|
|
* underscores (_) or hyphens (-). A journey name can't contain any spaces.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithName(const char* value) { SetName(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The quiet time settings for the journey. Quiet time is a specific time range
|
|||
|
|
* when a journey doesn't send messages to participants, if all the following
|
|||
|
|
* conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of
|
|||
|
|
* the endpoint for the participant is set to a valid value.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is later than or equal to the time
|
|||
|
|
* specified by the QuietTime.Start property for the journey.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is earlier than or equal to the time
|
|||
|
|
* specified by the QuietTime.End property for the journey.</p></li></ul> <p>If any
|
|||
|
|
* of the preceding conditions isn't met, the participant will receive messages
|
|||
|
|
* from the journey, even if quiet time is enabled.</p>
|
|||
|
|
*/
|
|||
|
|
inline const QuietTime& GetQuietTime() const{ return m_quietTime; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The quiet time settings for the journey. Quiet time is a specific time range
|
|||
|
|
* when a journey doesn't send messages to participants, if all the following
|
|||
|
|
* conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of
|
|||
|
|
* the endpoint for the participant is set to a valid value.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is later than or equal to the time
|
|||
|
|
* specified by the QuietTime.Start property for the journey.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is earlier than or equal to the time
|
|||
|
|
* specified by the QuietTime.End property for the journey.</p></li></ul> <p>If any
|
|||
|
|
* of the preceding conditions isn't met, the participant will receive messages
|
|||
|
|
* from the journey, even if quiet time is enabled.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool QuietTimeHasBeenSet() const { return m_quietTimeHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The quiet time settings for the journey. Quiet time is a specific time range
|
|||
|
|
* when a journey doesn't send messages to participants, if all the following
|
|||
|
|
* conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of
|
|||
|
|
* the endpoint for the participant is set to a valid value.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is later than or equal to the time
|
|||
|
|
* specified by the QuietTime.Start property for the journey.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is earlier than or equal to the time
|
|||
|
|
* specified by the QuietTime.End property for the journey.</p></li></ul> <p>If any
|
|||
|
|
* of the preceding conditions isn't met, the participant will receive messages
|
|||
|
|
* from the journey, even if quiet time is enabled.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetQuietTime(const QuietTime& value) { m_quietTimeHasBeenSet = true; m_quietTime = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The quiet time settings for the journey. Quiet time is a specific time range
|
|||
|
|
* when a journey doesn't send messages to participants, if all the following
|
|||
|
|
* conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of
|
|||
|
|
* the endpoint for the participant is set to a valid value.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is later than or equal to the time
|
|||
|
|
* specified by the QuietTime.Start property for the journey.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is earlier than or equal to the time
|
|||
|
|
* specified by the QuietTime.End property for the journey.</p></li></ul> <p>If any
|
|||
|
|
* of the preceding conditions isn't met, the participant will receive messages
|
|||
|
|
* from the journey, even if quiet time is enabled.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetQuietTime(QuietTime&& value) { m_quietTimeHasBeenSet = true; m_quietTime = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The quiet time settings for the journey. Quiet time is a specific time range
|
|||
|
|
* when a journey doesn't send messages to participants, if all the following
|
|||
|
|
* conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of
|
|||
|
|
* the endpoint for the participant is set to a valid value.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is later than or equal to the time
|
|||
|
|
* specified by the QuietTime.Start property for the journey.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is earlier than or equal to the time
|
|||
|
|
* specified by the QuietTime.End property for the journey.</p></li></ul> <p>If any
|
|||
|
|
* of the preceding conditions isn't met, the participant will receive messages
|
|||
|
|
* from the journey, even if quiet time is enabled.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithQuietTime(const QuietTime& value) { SetQuietTime(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The quiet time settings for the journey. Quiet time is a specific time range
|
|||
|
|
* when a journey doesn't send messages to participants, if all the following
|
|||
|
|
* conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of
|
|||
|
|
* the endpoint for the participant is set to a valid value.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is later than or equal to the time
|
|||
|
|
* specified by the QuietTime.Start property for the journey.</p></li> <li><p>The
|
|||
|
|
* current time in the participant's time zone is earlier than or equal to the time
|
|||
|
|
* specified by the QuietTime.End property for the journey.</p></li></ul> <p>If any
|
|||
|
|
* of the preceding conditions isn't met, the participant will receive messages
|
|||
|
|
* from the journey, even if quiet time is enabled.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithQuietTime(QuietTime&& value) { SetQuietTime(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The frequency with which Amazon Pinpoint evaluates segment and event data for
|
|||
|
|
* the journey, as a duration in ISO 8601 format.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetRefreshFrequency() const{ return m_refreshFrequency; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The frequency with which Amazon Pinpoint evaluates segment and event data for
|
|||
|
|
* the journey, as a duration in ISO 8601 format.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool RefreshFrequencyHasBeenSet() const { return m_refreshFrequencyHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The frequency with which Amazon Pinpoint evaluates segment and event data for
|
|||
|
|
* the journey, as a duration in ISO 8601 format.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetRefreshFrequency(const Aws::String& value) { m_refreshFrequencyHasBeenSet = true; m_refreshFrequency = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The frequency with which Amazon Pinpoint evaluates segment and event data for
|
|||
|
|
* the journey, as a duration in ISO 8601 format.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetRefreshFrequency(Aws::String&& value) { m_refreshFrequencyHasBeenSet = true; m_refreshFrequency = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The frequency with which Amazon Pinpoint evaluates segment and event data for
|
|||
|
|
* the journey, as a duration in ISO 8601 format.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetRefreshFrequency(const char* value) { m_refreshFrequencyHasBeenSet = true; m_refreshFrequency.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The frequency with which Amazon Pinpoint evaluates segment and event data for
|
|||
|
|
* the journey, as a duration in ISO 8601 format.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithRefreshFrequency(const Aws::String& value) { SetRefreshFrequency(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The frequency with which Amazon Pinpoint evaluates segment and event data for
|
|||
|
|
* the journey, as a duration in ISO 8601 format.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithRefreshFrequency(Aws::String&& value) { SetRefreshFrequency(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The frequency with which Amazon Pinpoint evaluates segment and event data for
|
|||
|
|
* the journey, as a duration in ISO 8601 format.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithRefreshFrequency(const char* value) { SetRefreshFrequency(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The schedule settings for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline const JourneySchedule& GetSchedule() const{ return m_schedule; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The schedule settings for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The schedule settings for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetSchedule(const JourneySchedule& value) { m_scheduleHasBeenSet = true; m_schedule = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The schedule settings for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetSchedule(JourneySchedule&& value) { m_scheduleHasBeenSet = true; m_schedule = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The schedule settings for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithSchedule(const JourneySchedule& value) { SetSchedule(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The schedule settings for the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithSchedule(JourneySchedule&& value) { SetSchedule(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The unique identifier for the first activity in the journey. The identifier
|
|||
|
|
* for this activity can contain a maximum of 128 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetStartActivity() const{ return m_startActivity; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The unique identifier for the first activity in the journey. The identifier
|
|||
|
|
* for this activity can contain a maximum of 128 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool StartActivityHasBeenSet() const { return m_startActivityHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The unique identifier for the first activity in the journey. The identifier
|
|||
|
|
* for this activity can contain a maximum of 128 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetStartActivity(const Aws::String& value) { m_startActivityHasBeenSet = true; m_startActivity = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The unique identifier for the first activity in the journey. The identifier
|
|||
|
|
* for this activity can contain a maximum of 128 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetStartActivity(Aws::String&& value) { m_startActivityHasBeenSet = true; m_startActivity = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The unique identifier for the first activity in the journey. The identifier
|
|||
|
|
* for this activity can contain a maximum of 128 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetStartActivity(const char* value) { m_startActivityHasBeenSet = true; m_startActivity.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The unique identifier for the first activity in the journey. The identifier
|
|||
|
|
* for this activity can contain a maximum of 128 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithStartActivity(const Aws::String& value) { SetStartActivity(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The unique identifier for the first activity in the journey. The identifier
|
|||
|
|
* for this activity can contain a maximum of 128 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithStartActivity(Aws::String&& value) { SetStartActivity(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The unique identifier for the first activity in the journey. The identifier
|
|||
|
|
* for this activity can contain a maximum of 128 characters. The characters must
|
|||
|
|
* be alphanumeric characters.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithStartActivity(const char* value) { SetStartActivity(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The segment that defines which users are participants in the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline const StartCondition& GetStartCondition() const{ return m_startCondition; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The segment that defines which users are participants in the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool StartConditionHasBeenSet() const { return m_startConditionHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The segment that defines which users are participants in the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetStartCondition(const StartCondition& value) { m_startConditionHasBeenSet = true; m_startCondition = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The segment that defines which users are participants in the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetStartCondition(StartCondition&& value) { m_startConditionHasBeenSet = true; m_startCondition = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The segment that defines which users are participants in the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithStartCondition(const StartCondition& value) { SetStartCondition(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The segment that defines which users are participants in the journey.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithStartCondition(StartCondition&& value) { SetStartCondition(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The status of the journey. Valid values are:</p> <ul><li><p>DRAFT - Saves the
|
|||
|
|
* journey and doesn't publish it.</p></li> <li><p>ACTIVE - Saves and publishes the
|
|||
|
|
* journey. Depending on the journey's schedule, the journey starts running
|
|||
|
|
* immediately or at the scheduled start time. If a journey's status is ACTIVE, you
|
|||
|
|
* can't add, change, or remove activities from it.</p></li></ul> <p>The CANCELLED,
|
|||
|
|
* COMPLETED, and CLOSED values are not supported in requests to create or update a
|
|||
|
|
* journey. To cancel a journey, use the <link
|
|||
|
|
* linkend="apps-application-id-journeys-journey-id-state">Journey State</link>
|
|||
|
|
* resource.</p>
|
|||
|
|
*/
|
|||
|
|
inline const State& GetState() const{ return m_state; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The status of the journey. Valid values are:</p> <ul><li><p>DRAFT - Saves the
|
|||
|
|
* journey and doesn't publish it.</p></li> <li><p>ACTIVE - Saves and publishes the
|
|||
|
|
* journey. Depending on the journey's schedule, the journey starts running
|
|||
|
|
* immediately or at the scheduled start time. If a journey's status is ACTIVE, you
|
|||
|
|
* can't add, change, or remove activities from it.</p></li></ul> <p>The CANCELLED,
|
|||
|
|
* COMPLETED, and CLOSED values are not supported in requests to create or update a
|
|||
|
|
* journey. To cancel a journey, use the <link
|
|||
|
|
* linkend="apps-application-id-journeys-journey-id-state">Journey State</link>
|
|||
|
|
* resource.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool StateHasBeenSet() const { return m_stateHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The status of the journey. Valid values are:</p> <ul><li><p>DRAFT - Saves the
|
|||
|
|
* journey and doesn't publish it.</p></li> <li><p>ACTIVE - Saves and publishes the
|
|||
|
|
* journey. Depending on the journey's schedule, the journey starts running
|
|||
|
|
* immediately or at the scheduled start time. If a journey's status is ACTIVE, you
|
|||
|
|
* can't add, change, or remove activities from it.</p></li></ul> <p>The CANCELLED,
|
|||
|
|
* COMPLETED, and CLOSED values are not supported in requests to create or update a
|
|||
|
|
* journey. To cancel a journey, use the <link
|
|||
|
|
* linkend="apps-application-id-journeys-journey-id-state">Journey State</link>
|
|||
|
|
* resource.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetState(const State& value) { m_stateHasBeenSet = true; m_state = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The status of the journey. Valid values are:</p> <ul><li><p>DRAFT - Saves the
|
|||
|
|
* journey and doesn't publish it.</p></li> <li><p>ACTIVE - Saves and publishes the
|
|||
|
|
* journey. Depending on the journey's schedule, the journey starts running
|
|||
|
|
* immediately or at the scheduled start time. If a journey's status is ACTIVE, you
|
|||
|
|
* can't add, change, or remove activities from it.</p></li></ul> <p>The CANCELLED,
|
|||
|
|
* COMPLETED, and CLOSED values are not supported in requests to create or update a
|
|||
|
|
* journey. To cancel a journey, use the <link
|
|||
|
|
* linkend="apps-application-id-journeys-journey-id-state">Journey State</link>
|
|||
|
|
* resource.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetState(State&& value) { m_stateHasBeenSet = true; m_state = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The status of the journey. Valid values are:</p> <ul><li><p>DRAFT - Saves the
|
|||
|
|
* journey and doesn't publish it.</p></li> <li><p>ACTIVE - Saves and publishes the
|
|||
|
|
* journey. Depending on the journey's schedule, the journey starts running
|
|||
|
|
* immediately or at the scheduled start time. If a journey's status is ACTIVE, you
|
|||
|
|
* can't add, change, or remove activities from it.</p></li></ul> <p>The CANCELLED,
|
|||
|
|
* COMPLETED, and CLOSED values are not supported in requests to create or update a
|
|||
|
|
* journey. To cancel a journey, use the <link
|
|||
|
|
* linkend="apps-application-id-journeys-journey-id-state">Journey State</link>
|
|||
|
|
* resource.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithState(const State& value) { SetState(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The status of the journey. Valid values are:</p> <ul><li><p>DRAFT - Saves the
|
|||
|
|
* journey and doesn't publish it.</p></li> <li><p>ACTIVE - Saves and publishes the
|
|||
|
|
* journey. Depending on the journey's schedule, the journey starts running
|
|||
|
|
* immediately or at the scheduled start time. If a journey's status is ACTIVE, you
|
|||
|
|
* can't add, change, or remove activities from it.</p></li></ul> <p>The CANCELLED,
|
|||
|
|
* COMPLETED, and CLOSED values are not supported in requests to create or update a
|
|||
|
|
* journey. To cancel a journey, use the <link
|
|||
|
|
* linkend="apps-application-id-journeys-journey-id-state">Journey State</link>
|
|||
|
|
* resource.</p>
|
|||
|
|
*/
|
|||
|
|
inline WriteJourneyRequest& WithState(State&& value) { SetState(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
|
|||
|
|
Aws::Map<Aws::String, Activity> m_activities;
|
|||
|
|
bool m_activitiesHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_creationDate;
|
|||
|
|
bool m_creationDateHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_lastModifiedDate;
|
|||
|
|
bool m_lastModifiedDateHasBeenSet;
|
|||
|
|
|
|||
|
|
JourneyLimits m_limits;
|
|||
|
|
bool m_limitsHasBeenSet;
|
|||
|
|
|
|||
|
|
bool m_localTime;
|
|||
|
|
bool m_localTimeHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_name;
|
|||
|
|
bool m_nameHasBeenSet;
|
|||
|
|
|
|||
|
|
QuietTime m_quietTime;
|
|||
|
|
bool m_quietTimeHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_refreshFrequency;
|
|||
|
|
bool m_refreshFrequencyHasBeenSet;
|
|||
|
|
|
|||
|
|
JourneySchedule m_schedule;
|
|||
|
|
bool m_scheduleHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_startActivity;
|
|||
|
|
bool m_startActivityHasBeenSet;
|
|||
|
|
|
|||
|
|
StartCondition m_startCondition;
|
|||
|
|
bool m_startConditionHasBeenSet;
|
|||
|
|
|
|||
|
|
State m_state;
|
|||
|
|
bool m_stateHasBeenSet;
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
} // namespace Model
|
|||
|
|
} // namespace Pinpoint
|
|||
|
|
} // namespace Aws
|