You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by zj...@apache.org on 2015/06/03 01:47:44 UTC
[12/50] [abbrv] hadoop git commit: YARN-3723. Need to clearly
document primaryFilter and otherInfo value type. Contributed by Zhijie Shen
YARN-3723. Need to clearly document primaryFilter and otherInfo value
type. Contributed by Zhijie Shen
Project: http://git-wip-us.apache.org/repos/asf/hadoop/repo
Commit: http://git-wip-us.apache.org/repos/asf/hadoop/commit/de39fedb
Tree: http://git-wip-us.apache.org/repos/asf/hadoop/tree/de39fedb
Diff: http://git-wip-us.apache.org/repos/asf/hadoop/diff/de39fedb
Branch: refs/heads/YARN-2928
Commit: de39fedb5ca44b62aaef7400747e2a1abc312f41
Parents: ac3000a
Author: Xuan <xg...@apache.org>
Authored: Thu May 28 10:19:36 2015 -0700
Committer: Zhijie Shen <zj...@apache.org>
Committed: Tue Jun 2 16:12:54 2015 -0700
----------------------------------------------------------------------
hadoop-yarn-project/CHANGES.txt | 3 +++
.../src/site/markdown/TimelineServer.md | 20 ++++++++++++++++----
2 files changed, 19 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/hadoop/blob/de39fedb/hadoop-yarn-project/CHANGES.txt
----------------------------------------------------------------------
diff --git a/hadoop-yarn-project/CHANGES.txt b/hadoop-yarn-project/CHANGES.txt
index 5326f2d..1dd4ee3 100644
--- a/hadoop-yarn-project/CHANGES.txt
+++ b/hadoop-yarn-project/CHANGES.txt
@@ -566,6 +566,9 @@ Release 2.7.1 - UNRELEASED
YARN-3539. Updated timeline server documentation and marked REST APIs evolving.
(Steve Loughran via zjshen)
+ YARN-3723. Need to clearly document primaryFilter and otherInfo value type.
+ (Zhijie Shen via xgong)
+
OPTIMIZATIONS
BUG FIXES
http://git-wip-us.apache.org/repos/asf/hadoop/blob/de39fedb/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/TimelineServer.md
----------------------------------------------------------------------
diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/TimelineServer.md b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/TimelineServer.md
index 5a18fb2..90f9512 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/TimelineServer.md
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/TimelineServer.md
@@ -648,11 +648,20 @@ Use the following URI to obtain all the entity objects of a given
the set of fields contains `LAST_EVENT_ONLY` and not `EVENTS`, the most recent
event for each entity is retrieved. If null, retrieves all fields.
+Note that the value of the key/value pair for `primaryFilter` and
+`secondaryFilters` parameters can be of different data types, and matching is
+data type sensitive. Users need to format the value properly. For example, `123`
+and `"123"` means an integer and a string respectively. If the entity has a
+string `"123"` for `primaryFilter`, but the parameter is set to the integer
+`123`, the entity will not be matched. Similarly, `true` means a boolean while
+`"true"` means a string. In general, the value will be casted as a certain Java
+type in consistent with `jackson` library parsing a JSON clip.
+
### Elements of the `entities` (Timeline Entity List) Object
When you make a request for the list of timeline entities, the information
will be returned as a collection of container objects. See also
-{{Timeline Entity}} for syntax of the timeline entity object.
+`Timeline Entity` for syntax of the timeline entity object.
| Item | Data Type | Description|
|:---- |:---- |:---- |
@@ -751,7 +760,9 @@ Use the following URI to obtain the entity object identified by the
### Elements of the `entity` (Timeline Entity) Object:
-See also {{Timeline Event List}} for syntax of the timeline event object.
+See also `Timeline Event List` for syntax of the timeline event object. Note
+that `value` of `primaryfilters` and `otherinfo` is an Object instead of a
+String.
| Item | Data Type | Description|
@@ -841,7 +852,8 @@ will be returned as a collection of event objects.
|:---- |:---- |:---- |
| `events` | array of timeline event objects(JSON) | The collection of timeline event objects |
-Below is the elements of a single event object.
+Below is the elements of a single event object. Note that `value` of
+`eventinfo` and `otherinfo` is an Object instead of a String.
| Item | Data Type | Description|
@@ -1547,7 +1559,7 @@ None
### Elements of the `containers` (Container List) Object
When you make a request for the list of containers, the information will be
-returned as a collection of container objects. See also {{Container}} for
+returned as a collection of container objects. See also `Container` for
syntax of the container object.
| Item | Data Type | Description |