tez-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ss...@apache.org
Subject tez git commit: TEZ-2824. Add javadocs for Vertex.setConf and DAG.setConf. (sseth)
Date Fri, 11 Dec 2015 22:09:47 GMT
Repository: tez
Updated Branches:
  refs/heads/master 6f7591b8d -> b748ffe1e


TEZ-2824. Add javadocs for Vertex.setConf and DAG.setConf. (sseth)


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

Branch: refs/heads/master
Commit: b748ffe1e7839568e52d05a8bcd83d7dd3aeda29
Parents: 6f7591b
Author: Siddharth Seth <sseth@apache.org>
Authored: Fri Dec 11 14:09:30 2015 -0800
Committer: Siddharth Seth <sseth@apache.org>
Committed: Fri Dec 11 14:09:30 2015 -0800

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


http://git-wip-us.apache.org/repos/asf/tez/blob/b748ffe1/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index 675c2b3..f4cf73e 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -10,6 +10,7 @@ INCOMPATIBLE CHANGES
   TEZ-604. Revert temporary changes made in TEZ-603 to kill the provided tez session, if
running a MapReduce job.
 
 ALL CHANGES:
+  TEZ-2824. Add javadocs for Vertex.setConf and DAG.setConf.
   TEZ-2911. Null location Strings can cause problems with GroupedSplit serialization.
   TEZ-2990. Change test-patch.sh to run through all tests, despite failures in upstream modules
   TEZ-2798. NPE when executing TestMemoryWithEvents::testMemoryScatterGather.
@@ -284,6 +285,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/b748ffe1/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 310a795..902ff21 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
@@ -348,6 +348,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/b748ffe1/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 3f52a3d..bf3a59b 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
@@ -405,6 +405,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);


Mime
View raw message