Repository: tez
Updated Branches:
  refs/heads/branch-0.7 4febd2441 -> 37074a92e


TEZ-2824. Add javadocs for Vertex.setConf and DAG.setConf. (sseth)
(cherry picked from commit b748ffe1e7839568e52d05a8bcd83d7dd3aeda29)

Conflicts:
        CHANGES.txt


Project: http://git-wip-us.apache.org/repos/asf/tez/repo
Commit: http://git-wip-us.apache.org/repos/asf/tez/commit/37074a92
Tree: http://git-wip-us.apache.org/repos/asf/tez/tree/37074a92
Diff: http://git-wip-us.apache.org/repos/asf/tez/diff/37074a92

Branch: refs/heads/branch-0.7
Commit: 37074a92eda4c61c50582ecb97f83a2781c42ecd
Parents: 4febd24
Author: Siddharth Seth <[email protected]>
Authored: Fri Dec 11 14:09:30 2015 -0800
Committer: Siddharth Seth <[email protected]>
Committed: Fri Dec 11 14:11:00 2015 -0800

----------------------------------------------------------------------
 CHANGES.txt                                     |  1 +
 .../main/java/org/apache/tez/dag/api/DAG.java   | 20 ++++++++++++++++++++
 .../java/org/apache/tez/dag/api/Vertex.java     | 20 ++++++++++++++++++++
 3 files changed, 41 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tez/blob/37074a92/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index 33523c2..9d705ec 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -8,6 +8,7 @@ INCOMPATIBLE CHANGES
   TEZ-2949. Allow duplicate dag names within session for Tez.
 
 ALL CHANGES
+  TEZ-2824. Add javadocs for Vertex.setConf and DAG.setConf.
   TEZ-2963. RecoveryService#handleSummaryEvent exception with HDFS transparent 
encryption + kerberos authentication.
   TEZ-2966. Tez does not honor mapreduce.task.timeout
   TEZ-2346. TEZ-UI: Lazy load other info / counter data

http://git-wip-us.apache.org/repos/asf/tez/blob/37074a92/tez-api/src/main/java/org/apache/tez/dag/api/DAG.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/DAG.java 
b/tez-api/src/main/java/org/apache/tez/dag/api/DAG.java
index 71ea05d..cb16839 100644
--- a/tez-api/src/main/java/org/apache/tez/dag/api/DAG.java
+++ b/tez-api/src/main/java/org/apache/tez/dag/api/DAG.java
@@ -346,6 +346,26 @@ public class DAG {
     return this.name;
   }
 
+  /**
+   * This is currently used to setup additional configuration parameters which 
will be available
+   * in the DAG configuration used in the AppMaster. This API would be used 
for properties which
+   * are used by the Tez framework while executing the DAG. As an example, the 
number of attempts
+   * for a task.</p>
+   *
+   * A DAG inherits it's base properties from the ApplicationMaster within 
which it's running. This
+   * method allows for these properties to be overridden.
+   *
+   * Currently, properties which are used by the task runtime, such as the 
task to AM
+   * heartbeat interval, cannot be changed using this method. </p>
+   *
+   * Note: This API does not add any configuration to runtime components such 
as InputInitializers,
+   * OutputCommitters, Inputs and Outputs.
+   *
+   * @param property the property name
+   * @param value the value for the property
+   * @return the current DAG being constructed
+   */
+  @InterfaceStability.Unstable
   public DAG setConf(String property, String value) {
     TezConfiguration.validateProperty(property, Scope.DAG);
     dagConf.put(property, value);

http://git-wip-us.apache.org/repos/asf/tez/blob/37074a92/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java 
b/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java
index 0ed4bd8..628b2b0 100644
--- a/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java
+++ b/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java
@@ -404,6 +404,26 @@ public class Vertex {
          return taskLaunchCmdOpts;
   }
 
+  /**
+   * This is currently used to setup additional configuration parameters which 
will be available
+   * in the Vertex specific configuration used in the AppMaster. This API 
would be used for properties which
+   * are used by the Tez framework while executing this vertex as part of a 
larger DAG.
+   * As an example, the number of attempts for a task. </p>
+   *
+   * A vertex inherits it's Configuration from the DAG, and can override 
properties for this Vertex only
+   * using this method </p>
+   *
+   * Currently, properties which are used by the task runtime, such as the 
task to AM
+   * heartbeat interval, cannot be changed using this method. </p>
+   *
+   * Note: This API does not add any configuration to runtime components such 
as InputInitializers,
+   * OutputCommitters, Inputs and Outputs.
+   *
+   * @param property the property name
+   * @param value the value for the property
+   * @return the current DAG being constructed
+   */
+  @InterfaceStability.Unstable
   public Vertex setConf(String property, String value) {
     TezConfiguration.validateProperty(property, Scope.VERTEX);
     this.vertexConf.put(property, value);

Reply via email to