update class desription for the new parameters

Author: bassel-zeidan

scala/src/main/scala/Osconfig.scala

@@ -129,25 +129,37 @@ class bluemix(sc: SparkContext, name: String, creds: HashMap[String, String],
 }
 
 /**
-* CloudObjectStorage class sets up a s3d connection between an IBM Spark service
-* instance and an IBM Cloud Object Storage instance.
+*  This class allows you to connect to a cloud object storage (COS) instance. It also support
+    connecting to a cos instance that is being hosted on bluemix.
 
 * Constructor arguments:
 
 *   sparkcontext:  a SparkContext object.
 
-*   credentials:  a dictionary with the following required keys:
-*
-*     endpoint
-
-*     accessKey
-
-*     secretKey
+*   credentials:  a dictionary with the following required keys to connect to cos.
+      The required keys differ according to the type of cos.
+*      - for cos type "softlayer_cos" the following key are required:
+          * endpoint [required]
+          * accessKey [required]
+          * secretKey [required]
+*      - for cos type "bluemix_cos", here are the required/optional key:
+          * endpoint [required]
+          * serviceId [required]
+          * apiKey OR iamToken depends on the selected authorization method (authMethod) [required]
+          * iamServiceEndpoint [optional] (default: https://iam.ng.bluemix.net/oidc/token)
+          * v2SignerType [optional]
 
 *   configurationName [optional]: string that identifies this configuration. You can
             use any string you like. This allows you to create
             multiple configurations to different Object Storage accounts.
             if a configuration name is not passed the default one will be used "service".
+
+*   cosType [optional]: string that identifies the type of cos to connect to. The supported types of cos
+            are "softlayer_cos" and "bluemix_cos". "softlayer_cos" will be chosen as default if no cosType is passed.
+
+*   authMethod [optional]: string that identifies the type of authorization method to use when connecting to cos. This parameter
+            is not reqired for softlayer_cos but only needed for bluemix_cos. Two options can be chosen for this params
+            "api_key" or "iam_token". "api_key" will be chosen as default if the value is not set.
 */
 class CloudObjectStorage(sc: SparkContext, credentials: HashMap[String, String],
                          configurationName: String = "", cosType="softlayer_cos",