Skip to content
This repository has been archived by the owner on Apr 4, 2021. It is now read-only.

Commit

Permalink
Incorporated review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
sandeepSamudrala committed Jan 23, 2017
1 parent 410f6a7 commit 5d9c151
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 43 deletions.
4 changes: 2 additions & 2 deletions docs/src/site/twiki/falconcli/ExtensionList.twiki
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Usage:
$FALCON_HOME/bin/falcon extension -list -extensionName <<extension-name>>

Optional Args : -doAs <<user-name>>
-sortOrder <<sortOrder>> -offset <<offset-number>> -numResults <<number-of-results>> -fields <<field1,field2>>
-sortOrder <<sortOrder>>

<a href="../restapi/ExtensionList.html">Parameters and examples described here.</a>

Example:
$FALCON_HOME/bin/falcon extension -list -extensionName hdfs-mirroring -offset 0 -numResults 10
$FALCON_HOME/bin/falcon extension -list -extensionName hdfs-mirroring
45 changes: 4 additions & 41 deletions docs/src/site/twiki/restapi/ExtensionList.twiki
Original file line number Diff line number Diff line change
Expand Up @@ -10,61 +10,24 @@ List jobs generated from an extension.
---++ Parameters
* :extension-name Name of the extension.
* sortOrder <optional> Sort order by job name. Valid options: "asc" (default) and "desc".
* offset <optional> Show results from the offset. Default is 0.
* numResults <optional> Number of results to show per request. Default is 10.
* fields <optional> Output fields separated by commas. Valid options: STATUS, TAGS, PIPELINES, CLUSTERS.
* doAs <optional> Impersonate the user.

---++ Results
Total number of results and a list of jobs generated from the extension, followed by the associated entities.
Total number of results and a list of jobs implementing the given extension.

---++ Examples
---+++ Rest Call
<verbatim>
GET http://localhost:15000/api/extensions/list/billCollection?fields=status,clusters,tags
GET http://localhost:15000/api/extensions/list/billCollection
</verbatim>
---+++ Result
<verbatim>
{
"numJobs":"2",
"jobs":{
"job": [
{
"jobName": "daily-health-bill",
"jobEntities: {
"totalResults": "2",
"entity": [
{
"type":"FEED",
"name":"SampleUSHealthBill",
"status":"SUBMITTED”,
"tags":{"tag":["related=ushealthcare","department=billingDepartment","_falcon_extension_name=billCoollection","_falcon_extension_job=daily-health-bill"]},
"clusters": {"cluster":["SampleCluster1","primaryCluster”]}
},
{
"type":"PROCESS”,
"name":"SampleBillPay”,
"status":"RUNNING”,
"tags":{"tag":["related=healthcare","department=billingDepartment","_falcon_extension_name=billCoollection","_falcon_extension_job=daily-health-bill"]},
"clusters":{"cluster":"primaryCluster”}
}
]
}
},
{
"jobName": "fsa-bill",
"jobEntities": {
"totalResults": "1",
"entity":
{
"type":"PROCESS”,
"name":"FSAPay”,
"status":"RUNNING”,
"tags”:{"tag":["related=healthcare","department=billingDepartment","_falcon_extension_name=billCollection","_falcon_extension_job=fsa-bill"]},
"clusters":{"cluster":"primaryCluster”}
}
}
}
{"daily-health-bill"},
{"fsa-bill"}
]
}
}
Expand Down

0 comments on commit 5d9c151

Please sign in to comment.