AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
MetricEventBuilder.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_METRICEVENTBUILDER_H_
16 #define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_METRICEVENTBUILDER_H_
17 
18 #include <unordered_map>
19 
22 
23 namespace alexaClientSDK {
24 namespace avsCommon {
25 namespace utils {
26 namespace metrics {
27 
32 public:
37 
44  MetricEventBuilder& setActivityName(const std::string& activityName);
45 
53 
60  MetricEventBuilder& addDataPoint(const DataPoint& dataPoint);
61 
68  MetricEventBuilder& addDataPoints(const std::vector<DataPoint>& dataPoints);
69 
76  MetricEventBuilder& removeDataPoint(const DataPoint& dataPoint);
77 
85  MetricEventBuilder& removeDataPoint(const std::string& name, DataType dataType);
86 
93 
97  void clear();
98 
104  std::shared_ptr<MetricEvent> build();
105 
112  static std::string generateKey(const std::string& name, DataType dataType);
113 
114 private:
121  MetricEventBuilder& removeDataPoint(const std::string& key);
122 
123  // The activity name of the current metric event
124  std::string m_activityName;
125 
126  // The priority of the current metric event
127  Priority m_priority;
128 
129  // The dataPoints of the current metric event
130  std::unordered_map<std::string, DataPoint> m_dataPoints;
131 };
132 
133 } // namespace metrics
134 } // namespace utils
135 } // namespace avsCommon
136 } // namespace alexaClientSDK
137 
138 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_METRICEVENTBUILDER_H_
MetricEventBuilder()
Definition: MetricEventBuilder.cpp:34
void clear()
Definition: MetricEventBuilder.cpp:84
MetricEventBuilder & setPriority(Priority priority)
Definition: MetricEventBuilder.cpp:42
MetricEventBuilder & removeDataPoints()
Definition: MetricEventBuilder.cpp:79
MetricEventBuilder & setActivityName(const std::string &activityName)
Definition: MetricEventBuilder.cpp:37
MetricEventBuilder & removeDataPoint(const DataPoint &dataPoint)
Definition: MetricEventBuilder.cpp:71
MetricEventBuilder & addDataPoints(const std::vector< DataPoint > &dataPoints)
Definition: MetricEventBuilder.cpp:63
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
MetricEventBuilder & addDataPoint(const DataPoint &dataPoint)
Definition: MetricEventBuilder.cpp:47
static std::string generateKey(const std::string &name, DataType dataType)
Definition: MetricEventBuilder.cpp:104
std::shared_ptr< MetricEvent > build()
Definition: MetricEventBuilder.cpp:90
static const std::string key
The database key to be used by the protocol given the METADATA object.
Definition: SharedAVSSettingProtocolTest.cpp:58

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0