Doc Update for 0.11.5 (#290)

CHANGELOG.md

@@ -1,4 +1,4 @@
-## Unreleased
+## [0.11.5] - 2021-06-24
 
 ### Added
 * Added events ingestion to report meeting events to Amazon Chime backend.

docs/amazon-chime-sdk/alltypes/index.html

@@ -138,6 +138,18 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl/-d
 <h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController</a></h5>
 </tr>
 <tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-default-event-reporter/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.DefaultEventReporter</a></h5>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-default-event-sender/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.DefaultEventSender</a></h5>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-default-meeting-event-buffer/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.DefaultMeetingEventBuffer</a></h5>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-default-meeting-event-reporter-factory/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.DefaultMeetingEventReporterFactory</a></h5>
+</tr>
+<tr>
 <h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-default-meeting-session/index.html">com.amazonaws.services.chime.sdk.meetings.session.DefaultMeetingSession</a></h5>
 </tr>
 <tr>
@@ -228,8 +240,52 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-attri
 <p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-attributes.html">EventAttributes</a> describes meeting event.</p>
 </tr>
 <tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-buffer/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.EventBuffer</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-buffer/index.html">EventBuffer</a> defines a buffer which will consume the <a href="#">SDKEvent</a> internally.</p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-client-configuration/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.EventClientConfiguration</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-client-configuration/index.html">EventClientConfiguration</a> defines core properties needed for every event client configuration.</p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-client-type/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.EventClientType</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-client-type/index.html">EventClientType</a> defines the type of event client configuration that will be
+sent to the server.</p>
+</tr>
+<tr>
 <h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-name/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.EventName</a></h5>
-<p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-name/index.html">EventName</a> represent some major event that could help builders to analyze the data.</p>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-name/index.html">EventName</a> represent sdk event that could help builders to analyze the data.</p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter/index.html">EventReporter</a> is class that process meeting event that is created in <a href="#">EventAnalyticsController</a>.</p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter-factory/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporterFactory</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter-factory/index.html">EventReporterFactory</a> facilitates creating <a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter/index.html">EventReporter</a></p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-sender/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.EventSender</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-sender/index.html">EventSender</a> is responsible for sending <a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-record/index.html">IngestionRecord</a>.</p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-configuration/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.IngestionConfiguration</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-configuration/index.html">IngestionConfiguration</a> defines the configuration that can customize <a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-default-event-reporter/index.html">DefaultEventReporter</a>.</p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-event/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.IngestionEvent</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-event/index.html">IngestionEvent</a> defines the event format ingestion server will accept</p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-metadata.html">com.amazonaws.services.chime.sdk.meetings.ingestion.IngestionMetadata</a></h5>
+<p>A record that contains batch of <a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-event/index.html">IngestionEvent</a> to send.
+This contains metadata that is shared among events.</p>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-payload.html">com.amazonaws.services.chime.sdk.meetings.ingestion.IngestionPayload</a></h5>
+</tr>
+<tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-ingestion-record/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.IngestionRecord</a></h5>
 </tr>
 <tr>
 <h5><a href="../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html">com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger</a></h5>
@@ -253,6 +309,11 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-media-placeme
 <h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-meeting/index.html">com.amazonaws.services.chime.sdk.meetings.session.Meeting</a></h5>
 </tr>
 <tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-meeting-event-client-configuration/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.MeetingEventClientConfiguration</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-meeting-event-client-configuration/index.html">MeetingEventClientConfiguration</a> defines one type of <a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-client-configuration/index.html">EventClientConfiguration</a>
+that is needed for <a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-default-event-reporter/index.html">DefaultEventReporter</a></p>
+</tr>
+<tr>
 <h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-meeting-history-event/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.MeetingHistoryEvent</a></h5>
 </tr>
 <tr>
@@ -304,6 +365,10 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.utils/-modality-type/i
 <h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/kotlin.collections.-mutable-map/index.html">kotlin.collections.MutableMap</a></h5>
 </tr>
 <tr>
+<h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-noop-event-reporter-factory/index.html">com.amazonaws.services.chime.sdk.meetings.ingestion.NoopEventReporterFactory</a></h5>
+<p><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-noop-event-reporter-factory/index.html">NoopEventReporterFactory</a> returns null <a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter/index.html">EventReporter</a></p>
+</tr>
+<tr>
 <h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.metric.ObservableMetric</a></h5>
 <p><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/index.html">ObservableMetric</a> represents filtered metrics that are intended to propagate to the
 top level observers. All metrics are measured over the past second.</p>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/-init-.html

@@ -8,7 +8,7 @@
 <a href="../../index.html">amazon-chime-sdk</a>&nbsp;/&nbsp;<a href="../index.html">com.amazonaws.services.chime.sdk.meetings.analytics</a>&nbsp;/&nbsp;<a href="index.html">DefaultEventAnalyticsController</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
 <br/>
 <h1>&lt;init&gt;</h1>
-<a name="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$&lt;init&gt;(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)"></a>
-<code><span class="identifier">DefaultEventAnalyticsController</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/logger">logger</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html"><span class="identifier">Logger</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/meetingSessionConfiguration">meetingSessionConfiguration</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.session/-meeting-session-configuration/index.html"><span class="identifier">MeetingSessionConfiguration</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/meetingStatsCollector">meetingStatsCollector</span><span class="symbol">:</span>&nbsp;<a href="../-meeting-stats-collector/index.html"><span class="identifier">MeetingStatsCollector</span></a><span class="symbol">)</span></code>
+<a name="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$&lt;init&gt;(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)"></a>
+<code><span class="identifier">DefaultEventAnalyticsController</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)/logger">logger</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html"><span class="identifier">Logger</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)/meetingSessionConfiguration">meetingSessionConfiguration</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.session/-meeting-session-configuration/index.html"><span class="identifier">MeetingSessionConfiguration</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)/meetingStatsCollector">meetingStatsCollector</span><span class="symbol">:</span>&nbsp;<a href="../-meeting-stats-collector/index.html"><span class="identifier">MeetingStatsCollector</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)/eventReporter">eventReporter</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter/index.html"><span class="identifier">EventReporter</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code>
 </BODY>
 </HTML>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/index.html

@@ -17,7 +17,7 @@ <h3>Constructors</h3>
 <h4><a href="-init-.html">&lt;init&gt;</a></h4>
 </td>
 <td>
-<code><span class="identifier">DefaultEventAnalyticsController</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/logger">logger</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html"><span class="identifier">Logger</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/meetingSessionConfiguration">meetingSessionConfiguration</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.session/-meeting-session-configuration/index.html"><span class="identifier">MeetingSessionConfiguration</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/meetingStatsCollector">meetingStatsCollector</span><span class="symbol">:</span>&nbsp;<a href="../-meeting-stats-collector/index.html"><span class="identifier">MeetingStatsCollector</span></a><span class="symbol">)</span></code></td>
+<code><span class="identifier">DefaultEventAnalyticsController</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)/logger">logger</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html"><span class="identifier">Logger</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)/meetingSessionConfiguration">meetingSessionConfiguration</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.session/-meeting-session-configuration/index.html"><span class="identifier">MeetingSessionConfiguration</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)/meetingStatsCollector">meetingStatsCollector</span><span class="symbol">:</span>&nbsp;<a href="../-meeting-stats-collector/index.html"><span class="identifier">MeetingStatsCollector</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector, com.amazonaws.services.chime.sdk.meetings.ingestion.EventReporter)/eventReporter">eventReporter</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.ingestion/-event-reporter/index.html"><span class="identifier">EventReporter</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code></td>
 </tr>
 </tbody>
 </table>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/-event-name/index.html

@@ -9,7 +9,7 @@
 <br/>
 <h1>EventName</h1>
 <code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">EventName</span></code>
-<p><a href="./index.html">EventName</a> represent some major event that could help builders to analyze the data.</p>
+<p><a href="./index.html">EventName</a> represent sdk event that could help builders to analyze the data.</p>
 <h3>Enum Values</h3>
 <table>
 <tbody>

docs/amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.analytics/index.html

@@ -71,7 +71,7 @@ <h4><a href="-event-attributes.html">EventAttributes</a></h4>
 <h4><a href="-event-name/index.html">EventName</a></h4>
 </td>
 <td>
-<p><a href="-event-name/index.html">EventName</a> represent some major event that could help builders to analyze the data.</p>
+<p><a href="-event-name/index.html">EventName</a> represent sdk event that could help builders to analyze the data.</p>
 <code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">EventName</span></code></td>
 </tr>
 <tr>