Change comments based on updated swagger spec (#23)

Author: xingwu1

README.md

@@ -7,7 +7,7 @@ This README is based on the latest released version Azure Batch SDK (3.1.0). If
 The Azure Batch Libraries for Java is a higher-level, object-oriented API for interacting with the Azure Batch service.
 
 
-> **3.1.0** is a release that supports all features of Azure Batch service with API version "2018-03-01.6.1". We will be adding support for more new features and tweaking the API associated with Azure Batch service newer release.
+> **3.2.0** is a release that supports all features of Azure Batch service with API version "2018-03-01.6.1". We will be adding support for more new features and tweaking the API associated with Azure Batch service newer release.
 
 **Azure Batch Authentication**
 
@@ -112,7 +112,8 @@ If you would like to become an active contributor to this project please follow
 
 | Version           | SHA1                                                                                      | Remarks                                               |
 |-------------------|-------------------------------------------------------------------------------------------|-------------------------------------------------------|
-| 3.1.0             | [3.1.0](https://github.com/Azure/azure-batch-sdk-for-java/tree/master)                          | Tagged release for 3.1.0 version of Azure Batch libraries |
+| 3.2.0             | [3.2.0](https://github.com/Azure/azure-batch-sdk-for-java/tree/master)                          | Tagged release for 3.2.0 version of Azure Batch libraries |
+| 3.1.0             | [3.1.0](https://github.com/Azure/azure-batch-sdk-for-java/releases/tag/v3.1.0)                          | Tagged release for 3.1.0 version of Azure Batch libraries |
 | 3.0.0             | [3.0.0](https://github.com/Azure/azure-batch-sdk-for-java/releases/tag/v3.0.0)                          | Tagged release for 3.0.0 version of Azure Batch libraries |
 | 2.1.0             | [2.1.0](https://github.com/Azure/azure-batch-sdk-for-java/releases/tag/v2.1.0)                          | Tagged release for 2.1.0 version of Azure Batch libraries |
 | 2.0.0             | [2.0.0](https://github.com/Azure/azure-batch-sdk-for-java/releases/tag/v2.0.0)                          | Tagged release for 2.0.0 version of Azure Batch libraries |

changelog.md

@@ -1,5 +1,10 @@
 # Azure Batch SDK for Java release notes
 
+## Changes in 3.2.0
+### Features
+ - Update comments for some classes and properties.
+ - Added the `leavingPool` property to `NodeCounts` class.
+
 ## Changes in 3.1.0
 ### Features
  - Added the ability to query pool node counts by state, via the new `listPoolNodeCounts` method on `PoolOperations`.

src/main/java/com/microsoft/azure/batch/protocol/Jobs.java

@@ -65,7 +65,7 @@
 public interface Jobs {
     /**
      * Gets lifetime summary statistics for all of the jobs in the specified account.
-     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @throws IllegalArgumentException thrown if parameters fail the validation
      * @throws BatchErrorException thrown if the request is rejected by server
@@ -76,7 +76,7 @@ public interface Jobs {
 
     /**
      * Gets lifetime summary statistics for all of the jobs in the specified account.
-     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param serviceCallback the async ServiceCallback to handle successful and failed responses.
      * @throws IllegalArgumentException thrown if parameters fail the validation
@@ -86,7 +86,7 @@ public interface Jobs {
 
     /**
      * Gets lifetime summary statistics for all of the jobs in the specified account.
-     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @throws IllegalArgumentException thrown if parameters fail the validation
      * @return the observable to the JobStatistics object
@@ -95,15 +95,15 @@ public interface Jobs {
 
     /**
      * Gets lifetime summary statistics for all of the jobs in the specified account.
-     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @throws IllegalArgumentException thrown if parameters fail the validation
      * @return the observable to the JobStatistics object
      */
     Observable<ServiceResponseWithHeaders<JobStatistics, JobGetAllLifetimeStatisticsHeaders>> getAllLifetimeStatisticsWithServiceResponseAsync();
     /**
      * Gets lifetime summary statistics for all of the jobs in the specified account.
-     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param jobGetAllLifetimeStatisticsOptions Additional parameters for the operation
      * @throws IllegalArgumentException thrown if parameters fail the validation
@@ -115,7 +115,7 @@ public interface Jobs {
 
     /**
      * Gets lifetime summary statistics for all of the jobs in the specified account.
-     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param jobGetAllLifetimeStatisticsOptions Additional parameters for the operation
      * @param serviceCallback the async ServiceCallback to handle successful and failed responses.
@@ -126,7 +126,7 @@ public interface Jobs {
 
     /**
      * Gets lifetime summary statistics for all of the jobs in the specified account.
-     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param jobGetAllLifetimeStatisticsOptions Additional parameters for the operation
      * @throws IllegalArgumentException thrown if parameters fail the validation
@@ -136,7 +136,7 @@ public interface Jobs {
 
     /**
      * Gets lifetime summary statistics for all of the jobs in the specified account.
-     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param jobGetAllLifetimeStatisticsOptions Additional parameters for the operation
      * @throws IllegalArgumentException thrown if parameters fail the validation

src/main/java/com/microsoft/azure/batch/protocol/Pools.java

@@ -153,7 +153,7 @@ public interface Pools {
 
     /**
      * Gets lifetime summary statistics for all of the pools in the specified account.
-     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @throws IllegalArgumentException thrown if parameters fail the validation
      * @throws BatchErrorException thrown if the request is rejected by server
@@ -164,7 +164,7 @@ public interface Pools {
 
     /**
      * Gets lifetime summary statistics for all of the pools in the specified account.
-     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param serviceCallback the async ServiceCallback to handle successful and failed responses.
      * @throws IllegalArgumentException thrown if parameters fail the validation
@@ -174,7 +174,7 @@ public interface Pools {
 
     /**
      * Gets lifetime summary statistics for all of the pools in the specified account.
-     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @throws IllegalArgumentException thrown if parameters fail the validation
      * @return the observable to the PoolStatistics object
@@ -183,15 +183,15 @@ public interface Pools {
 
     /**
      * Gets lifetime summary statistics for all of the pools in the specified account.
-     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @throws IllegalArgumentException thrown if parameters fail the validation
      * @return the observable to the PoolStatistics object
      */
     Observable<ServiceResponseWithHeaders<PoolStatistics, PoolGetAllLifetimeStatisticsHeaders>> getAllLifetimeStatisticsWithServiceResponseAsync();
     /**
      * Gets lifetime summary statistics for all of the pools in the specified account.
-     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param poolGetAllLifetimeStatisticsOptions Additional parameters for the operation
      * @throws IllegalArgumentException thrown if parameters fail the validation
@@ -203,7 +203,7 @@ public interface Pools {
 
     /**
      * Gets lifetime summary statistics for all of the pools in the specified account.
-     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param poolGetAllLifetimeStatisticsOptions Additional parameters for the operation
      * @param serviceCallback the async ServiceCallback to handle successful and failed responses.
@@ -214,7 +214,7 @@ public interface Pools {
 
     /**
      * Gets lifetime summary statistics for all of the pools in the specified account.
-     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param poolGetAllLifetimeStatisticsOptions Additional parameters for the operation
      * @throws IllegalArgumentException thrown if parameters fail the validation
@@ -224,7 +224,7 @@ public interface Pools {
 
     /**
      * Gets lifetime summary statistics for all of the pools in the specified account.
-     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
+     * Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
      *
      * @param poolGetAllLifetimeStatisticsOptions Additional parameters for the operation
      * @throws IllegalArgumentException thrown if parameters fail the validation

src/main/java/com/microsoft/azure/batch/protocol/implementation/JobsImpl.java

@@ -1730,7 +1730,7 @@ private ServiceResponseWithHeaders<Void, JobEnableHeaders> enableDelegate(Respon
 
     /**
      * Terminates the specified job, marking it as completed.
-     * When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any active or running tasks associated with the job, and runs any required Job Release tasks. The job then moves into the completed state.
+     * When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.
      *
      * @param jobId The ID of the job to terminate.
      * @throws IllegalArgumentException thrown if parameters fail the validation

src/main/java/com/microsoft/azure/batch/protocol/models/CloudJob.java

@@ -188,7 +188,9 @@ public class CloudJob {
     private JobExecutionInformation executionInfo;
 
     /**
-     * Resource usage statistics for the entire lifetime of the job.
+     * Resource usage statistics for the entire lifetime of the job. The
+     * statistics may not be immediately available. The Batch service performs
+     * periodic roll-up of statistics. The typical delay is about 30 minutes.
      */
     @JsonProperty(value = "stats")
     private JobStatistics stats;

src/main/java/com/microsoft/azure/batch/protocol/models/CloudJobSchedule.java

@@ -122,7 +122,9 @@ public class CloudJobSchedule {
     private List<MetadataItem> metadata;
 
     /**
-     * The lifetime resource usage statistics for the job schedule.
+     * The lifetime resource usage statistics for the job schedule. The
+     * statistics may not be immediately available. The Batch service performs
+     * periodic roll-up of statistics. The typical delay is about 30 minutes.
      */
     @JsonProperty(value = "stats")
     private JobScheduleStatistics stats;

src/main/java/com/microsoft/azure/batch/protocol/models/CloudPool.java

@@ -100,7 +100,7 @@ public class CloudPool {
      * For information about available sizes of virtual machines for Cloud
      * Services pools (pools created with cloudServiceConfiguration), see Sizes
      * for Cloud Services
-     * (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
+     * (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
      * Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and
      * A2V2. For information about available VM sizes for pools using images
      * from the Virtual Machines Marketplace (pools created with
@@ -291,7 +291,9 @@ public class CloudPool {
 
     /**
      * Utilization and resource usage statistics for the entire lifetime of the
-     * pool.
+     * pool. The statistics may not be immediately available. The Batch service
+     * performs periodic roll-up of statistics. The typical delay is about 30
+     * minutes.
      */
     @JsonProperty(value = "stats")
     private PoolStatistics stats;

src/main/java/com/microsoft/azure/batch/protocol/models/CloudTask.java

@@ -16,6 +16,16 @@
 
 /**
  * An Azure Batch task.
+ * Batch will retry tasks when a recovery operation is triggered on a compute
+ * node. Examples of recovery operations include (but are not limited to) when
+ * an unhealthy compute node is rebooted or a compute node disappeared due to
+ * host failure. Retries due to recovery operations are independent of and are
+ * not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is
+ * 0, an internal retry due to a recovery operation may occur. Because of this,
+ * all tasks should be idempotent. This means tasks need to tolerate being
+ * interrupted and restarted without causing any corruption or duplicate data.
+ * The best practice for long running tasks is to use some form of
+ * checkpointing.
  */
 public class CloudTask {
     /**
@@ -105,6 +115,10 @@ public class CloudTask {
      * environment variable expansion. If you want to take advantage of such
      * features, you should invoke the shell in the command line, for example
      * using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux.
+     * If the command line refers to file paths, it should use a relative path
+     * (relative to the task working directory), or use the Batch provided
+     * environment variable
+     * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
      */
     @JsonProperty(value = "commandLine")
     private String commandLine;

src/main/java/com/microsoft/azure/batch/protocol/models/ComputeNode.java

@@ -97,7 +97,7 @@ public class ComputeNode {
      * For information about available sizes of virtual machines for Cloud
      * Services pools (pools created with cloudServiceConfiguration), see Sizes
      * for Cloud Services
-     * (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
+     * (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
      * Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and
      * A2V2. For information about available VM sizes for pools using images
      * from the Virtual Machines Marketplace (pools created with