trunk/general/src/site/site/twiki/restapi/ExtensionDefinition.twiki

---++  GET api/extension/definition/:extension­name
   * <a href="#Description">Description</a>
   * <a href="#Parameters">Parameters</a>
   * <a href="#Results">Results</a>
   * <a href="#Examples">Examples</a>

---++ Description
Get definition of the extension.

---++ Parameters
   * :extension­name Name of the extension.

---++ Results
Outputs a JSON document describing the extension invocation parameters.

---++ Examples
---+++ Rest Call
<verbatim>
GET http://localhost:15000/api/extension/definition/hdfs­mirroring
</verbatim>
---+++ Result
<verbatim>
{
    "shortDescription": "This extension implements replicating arbitrary directories on HDFS from one Hadoop cluster to another Hadoop cluster. This piggy backs on replication solution in Falcon which uses the DistCp tool.",
    "properties":[
        {
            "propertyName":"jobName",
            "required":true,
            "description":"Unique job name",
            "example":"hdfs-monthly-sales-dr"
        },
        {
            "propertyName":"jobClusterName",
            "required":true,
            "description":"Cluster where job should run",
            "example":"backupCluster"
        },
        {
            "propertyName":"jobValidityStart",
            "required":true,
            "description":"Job validity start time",
            "example":"2016-03-03T00:00Z"
        },
        {
            "propertyName":"jobValidityEnd",
            "required":true,
            "description":"Job validity end time",
            "example":"2018-03-13T00:00Z"
        },
        {
            "propertyName":"jobFrequency",
            "required":true,
            "description":"job frequency. Valid frequency types are minutes, hours, days, months",
            "example":"months(1)"
        },
        {
            "propertyName":"jobTimezone",
            "required":false,
            "description":"Time zone for the job",
            "example":"GMT"
        },
        {
            "propertyName":"jobTags",
            "required":false,
            "description":"list of comma separated tags. Key Value Pairs, separated by comma",
            "example":"consumer=consumer@xyz.com, owner=producer@xyz.com, _department_type=forecasting"
        },
        {
            "propertyName":"jobRetryPolicy",
            "required":false,
            "description":"Job retry policy",
            "example":"periodic"
        },
        {
            "propertyName":"jobRetryDelay",
            "required":false,
            "description":"Job retry delay",
            "example":"minutes(30)"
        },
        {
            "propertyName":"jobRetryAttempts",
            "required":false,
            "description":"Job retry attempts",
            "example":"3"
        },
        {
            "propertyName":"jobRetryOnTimeout",
            "required":false,
            "description":"Job retry on timeout",
            "example":"true"
        },
        {
            "propertyName":"jobAclOwner",
            "required":false,
            "description":"ACL owner",
            "example":"ambari-qa"
        },
        {
            "propertyName":"jobAclGroup",
            "required":false,
            "description":"ACL group",
            "example":"users"
        },
        {
            "propertyName":"jobAclPermission",
            "required":false,
            "description":"ACL permission",
            "example":"0x755"
        },
        {
            "propertyName":"sourceDir",
            "required":true,
            "description":"Multiple hdfs comma separated source directories",
            "example":"/user/ambari-qa/primaryCluster/dr/input1, /user/ambari-qa/primaryCluster/dr/input2"
        },
        {
            "propertyName":"sourceCluster",
            "required":true,
            "description":"Source cluster for hdfs mirroring",
            "example":"primaryCluster"
        },
        {
            "propertyName":"targetDir",
            "required":true,
            "description":"Target hdfs directory",
            "example":"/user/ambari-qa/backupCluster/dr"
        },
        {
            "propertyName":"targetCluster",
            "required":true,
            "description":"Target cluster for hdfs mirroring",
            "example":"backupCluster"
        },
        {
            "propertyName":"distcpMaxMaps",
            "required":false,
            "description":"Maximum number of mappers for DistCP",
            "example":"1"
        },
        {
            "propertyName":"distcpMapBandwidth",
            "required":false,
            "description":"Bandwidth in MB for each mapper in DistCP",
            "example":"100"
        },
        {
            "propertyName":"jobNotificationType",
            "required":false,
            "description":"Email Notification for Falcon instance completion",
            "example":"email"
        },
        {
            "propertyName":"jobNotificationReceivers",
            "required":false,
            "description":"Comma separated email Id's",
            "example":"user1@gmail.com, user2@gmail.com"
        }
    ]
}
</verbatim>