/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Pinpoint { namespace Model { /** *

Specifies the configuration, dimension, and other settings for a segment. A * WriteSegmentRequest object can include a Dimensions object or a SegmentGroups * object, but not both.

See Also:

AWS * API Reference

*/ class AWS_PINPOINT_API WriteSegmentRequest { public: WriteSegmentRequest(); WriteSegmentRequest(Aws::Utils::Json::JsonView jsonValue); WriteSegmentRequest& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

The criteria that define the dimensions for the segment.

*/ inline const SegmentDimensions& GetDimensions() const{ return m_dimensions; } /** *

The criteria that define the dimensions for the segment.

*/ inline bool DimensionsHasBeenSet() const { return m_dimensionsHasBeenSet; } /** *

The criteria that define the dimensions for the segment.

*/ inline void SetDimensions(const SegmentDimensions& value) { m_dimensionsHasBeenSet = true; m_dimensions = value; } /** *

The criteria that define the dimensions for the segment.

*/ inline void SetDimensions(SegmentDimensions&& value) { m_dimensionsHasBeenSet = true; m_dimensions = std::move(value); } /** *

The criteria that define the dimensions for the segment.

*/ inline WriteSegmentRequest& WithDimensions(const SegmentDimensions& value) { SetDimensions(value); return *this;} /** *

The criteria that define the dimensions for the segment.

*/ inline WriteSegmentRequest& WithDimensions(SegmentDimensions&& value) { SetDimensions(std::move(value)); return *this;} /** *

The name of the segment.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the segment.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the segment.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the segment.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the segment.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the segment.

*/ inline WriteSegmentRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the segment.

*/ inline WriteSegmentRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the segment.

*/ inline WriteSegmentRequest& WithName(const char* value) { SetName(value); return *this;} /** *

The segment group to use and the dimensions to apply to the group's base * segments in order to build the segment. A segment group can consist of zero or * more base segments. Your request can include only one segment group.

*/ inline const SegmentGroupList& GetSegmentGroups() const{ return m_segmentGroups; } /** *

The segment group to use and the dimensions to apply to the group's base * segments in order to build the segment. A segment group can consist of zero or * more base segments. Your request can include only one segment group.

*/ inline bool SegmentGroupsHasBeenSet() const { return m_segmentGroupsHasBeenSet; } /** *

The segment group to use and the dimensions to apply to the group's base * segments in order to build the segment. A segment group can consist of zero or * more base segments. Your request can include only one segment group.

*/ inline void SetSegmentGroups(const SegmentGroupList& value) { m_segmentGroupsHasBeenSet = true; m_segmentGroups = value; } /** *

The segment group to use and the dimensions to apply to the group's base * segments in order to build the segment. A segment group can consist of zero or * more base segments. Your request can include only one segment group.

*/ inline void SetSegmentGroups(SegmentGroupList&& value) { m_segmentGroupsHasBeenSet = true; m_segmentGroups = std::move(value); } /** *

The segment group to use and the dimensions to apply to the group's base * segments in order to build the segment. A segment group can consist of zero or * more base segments. Your request can include only one segment group.

*/ inline WriteSegmentRequest& WithSegmentGroups(const SegmentGroupList& value) { SetSegmentGroups(value); return *this;} /** *

The segment group to use and the dimensions to apply to the group's base * segments in order to build the segment. A segment group can consist of zero or * more base segments. Your request can include only one segment group.

*/ inline WriteSegmentRequest& WithSegmentGroups(SegmentGroupList&& value) { SetSegmentGroups(std::move(value)); return *this;} /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

A string-to-string map of key-value pairs that defines the tags to associate * with the segment. Each tag consists of a required tag key and an associated tag * value.

*/ inline WriteSegmentRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } private: SegmentDimensions m_dimensions; bool m_dimensionsHasBeenSet; Aws::String m_name; bool m_nameHasBeenSet; SegmentGroupList m_segmentGroups; bool m_segmentGroupsHasBeenSet; Aws::Map m_tags; bool m_tagsHasBeenSet; }; } // namespace Model } // namespace Pinpoint } // namespace Aws