Clarify parameter names and aliases for DW modules

Signed-off-by: Webster Mudge <wmudge@cloudera.com>

Author: wmudge

plugins/modules/dw_cluster.py

@@ -142,7 +142,7 @@
 # Delete a Data Warehouse Cluster
 - cloudera.cloud.dw_cluster:
     state: absent
-    id: my-id
+    cluster_id: my-id
     
 # Delete the Data Warehouse Cluster within the Environment
 - cloudera.cloud.dw_cluster:

plugins/modules/dw_cluster_info.py

@@ -65,7 +65,7 @@
     
 # Gather information about an identified Cluster
 - cloudera.cloud.dw_cluster_info:
-    id: env-xyzabc
+    cluster_id: env-xyzabc
 '''
 
 RETURN = r'''

plugins/modules/dw_database_catalog.py

@@ -35,11 +35,13 @@
 requirements:
   - cdpy
 options:
-  id:
+  catalog_id:
     description:
       - The identifier of the Database Catalog.
       - Required if C(state=absent).
     type: str
+    aliases:
+      - id
   cluster_id:
     description:
       - The identifier of the parent DW Cluster of the Database Catalog.
@@ -91,7 +93,7 @@
     
 # Delete Database Catalog
 - cloudera.cloud.dw_database_catalog:
-    id: example-database-id
+    catalog_id: example-database-id
     cluster_id: example-cluster-id
     state: absent
 '''
@@ -127,12 +129,12 @@
 '''
 
 
-class DwDbc(CdpModule):
+class DwDatabaseCatalog(CdpModule):
     def __init__(self, module):
-        super(DwDbc, self).__init__(module)
+        super(DwDatabaseCatalog, self).__init__(module)
 
         # Set variables
-        self.id = self._get_param('id')
+        self.catalog_id = self._get_param('catalog_id')
         self.cluster_id = self._get_param('cluster_id')
         self.name = self._get_param('name')
         self.load_demo_data = self._get_param('load_demo_data')
@@ -153,13 +155,13 @@ def __init__(self, module):
 
     @CdpModule._Decorators.process_debug
     def process(self):
-        if self.id is None:
+        if self.catalog_id is None:
             dbcs = self.cdpy.dw.list_dbcs(cluster_id=self.cluster_id)
             for dbc in dbcs:
                 if dbc['name'] == self.name:
                     self.target = self.cdpy.dw.describe_dbc(cluster_id=self.cluster_id, dbc_id=dbc['id'])
         else:
-            self.target = self.cdpy.dw.describe_dbc(cluster_id=self.cluster_id, dbc_id=self.id)
+            self.target = self.cdpy.dw.describe_dbc(cluster_id=self.cluster_id, dbc_id=self.catalog_id)
 
         if self.target is not None:
             # Begin Database Catalog Exists
@@ -222,7 +224,7 @@ def process(self):
 def main():
     module = AnsibleModule(
         argument_spec=CdpModule.argument_spec(
-            id=dict(type='str'),
+            catalog_id=dict(type='str', aliases=['catalog_id']),
             cluster_id=dict(required=True, type='str'),
             name = dict(type='str'),
             load_demo_data=dict(type='bool'),
@@ -239,7 +241,7 @@ def main():
         supports_check_mode=True
     )
 
-    result = DwDbc(module)
+    result = DwDatabaseCatalog(module)
     output = dict(changed=result.changed, database_catalog=result.database_catalog)
 
     if result.debug:

plugins/modules/dw_database_catalog_info.py

@@ -35,12 +35,14 @@
 requirements:
   - cdpy
 options:
-  id:
+  catalog_id:
     description:
       - The identifier of the Database Catalog.
       - If undefined, will return a list of all Database Catalogs in the Cluster.
       - Exclusive with I(name).
     type: str
+    aliases:
+      - id
   cluster_id:
     description:
       - The identifier of the parent Cluster of the Database Catalog or Catalogs.
@@ -102,12 +104,12 @@
 '''
 
 
-class DwDbcInfo(CdpModule):
+class DwDatabaseCatalogInfo(CdpModule):
     def __init__(self, module):
-        super(DwDbcInfo, self).__init__(module)
+        super(DwDatabaseCatalogInfo, self).__init__(module)
 
         # Set variables
-        self.id = self._get_param('id')
+        self.catalog_id = self._get_param('catalog_id')
         self.cluster_id = self._get_param('cluster_id')
         self.name = self._get_param('name')
 
@@ -119,8 +121,8 @@ def __init__(self, module):
 
     @CdpModule._Decorators.process_debug
     def process(self):
-        if self.id is not None:
-          target = self.cdpy.dw.describe_dbc(cluster_id=self.cluster_id, dbc_id=self.id)
+        if self.catalog_id is not None:
+          target = self.cdpy.dw.describe_dbc(cluster_id=self.cluster_id, dbc_id=self.catalog_id)
           if target is not None:
             self.database_catalogs.append(target)
         else:
@@ -136,15 +138,15 @@ def process(self):
 def main():
     module = AnsibleModule(
         argument_spec=CdpModule.argument_spec(
-            id=dict(type='str'),
+            catalog_id=dict(type='str', aliases=['id']),
             cluster_id=dict(required=True, type='str'),
             name = dict(type='str'),
         ),
         mutually_exclusive=[['id', 'name']],
         supports_check_mode=True
     )
 
-    result = DwDbcInfo(module)
+    result = DwDatabaseCatalogInfo(module)
     output = dict(changed=False, database_catalogs=result.database_catalogs)
 
     if result.debug:

plugins/modules/dw_virtual_warehouse.py

@@ -35,23 +35,26 @@
 requirements:
   - cdpy
 options:
-  id:
+  warehouse_id:
     description:
       - The identifier of the Virtual Warehouse.
       - Required if C(state=absent).
     type: str
     aliases:
       - vw_id
+      - id
   cluster_id:
     description: 
       - The identifier of the parent Data Warehouse Cluster of the Virtual Warehouse.
     type: str
     required: True
-  dbc_id:
+  catalog_id:
     description:
       - The identifier of the parent Database Catalog attached to the Virtual Warehouse.
       - Required if C(state=present)
     type: str
+    aliases:
+      - dbc_id
   type:
     description:
       - The type of Virtual Warehouse to be created.
@@ -239,7 +242,7 @@
 # Delete a Virtual Warehouse
 - cloudera.cloud.dw_virtual_warehouse:
     cluster_id: example-cluster-id
-    id: example-virtual-warehouse-id
+    warehouse_id: example-virtual-warehouse-id
     state: absent      
 '''
 
@@ -310,14 +313,14 @@
 '''
 
 
-class DwVw(CdpModule):
+class DwVirtualWarehouse(CdpModule):
     def __init__(self, module):
-        super(DwVw, self).__init__(module)
+        super(DwVirtualWarehouse, self).__init__(module)
 
         # Set variables
-        self.id = self._get_param('id')
+        self.warehouse_id = self._get_param('warehouse_id')
         self.cluster_id = self._get_param('cluster_id')
-        self.dbc_id = self._get_param('dbc_id')
+        self.dbc_id = self._get_param('catalog_id')
         self.type = self._get_param('type')
         self.name = self._get_param('name')
         self.template = self._get_param('template')
@@ -345,13 +348,13 @@ def __init__(self, module):
 
     @CdpModule._Decorators.process_debug
     def process(self):
-        if self.id is None:
+        if self.warehouse_id is None:
             vws = self.cdpy.dw.list_vws(cluster_id=self.cluster_id)
             for vw in vws:
                 if self.name is not None and vw['name'] == self.name:
                     self.target = self.cdpy.dw.describe_vw(cluster_id=self.cluster_id, vw_id=vw['id'])
         else:
-            self.target = self.cdpy.dw.describe_vw(cluster_id=self.cluster_id, vw_id=self.id)
+            self.target = self.cdpy.dw.describe_vw(cluster_id=self.cluster_id, vw_id=self.warehouse_id)
 
         if self.target is not None:
             # Begin Virtual Warehouse Exists
@@ -422,9 +425,9 @@ def process(self):
 def main():
     module = AnsibleModule(
         argument_spec=CdpModule.argument_spec(
-            id=dict(type='str', aliases=['vw_id']),
+            warehouse_id=dict(type='str', aliases=['vw_id', 'id']),
             cluster_id=dict(required=True, type='str'),
-            dbc_id=dict(type='str'),
+            catalog_id=dict(type='str', aliases=['dbc_id']),
             type = dict(type='str'),
             name = dict(type='str'),
             template=dict(type='str', choices=['xsmall', 'small', 'medium', 'large']),
@@ -451,13 +454,13 @@ def main():
             timeout = dict(type='int', aliases=['polling_timeout'], default=3600)
         ),
         required_if=[
-            ['state', 'absent', ['id']],
-            ['state', 'present', ['dbc_id', 'type', 'name']]
+            ['state', 'absent', ['warehouse_id']],
+            ['state', 'present', ['catalog_id', 'type', 'name']]
         ],
         supports_check_mode=True
     )
 
-    result = DwVw(module)
+    result = DwVirtualWarehouse(module)
     output = dict(changed=result.changed, virtual_warehouse=result.virtual_warehouse)
 
     if result.debug:

plugins/modules/dw_virtual_warehouse_info.py

@@ -35,29 +35,32 @@
 requirements:
   - cdpy
 options:
-  id:
+  warehouse_id:
     description:
       - The identifier of the Virtual Warehouse.
       - Requires I(cluster_id).
-      - Mutually exclusive with I(name) and I(dbc_id).
+      - Mutually exclusive with I(name) and I(catalog_id).
     type: str
     aliases:
       - vw_id
+      - id
   cluster_id:
     description: 
       - The identifier of the parent Data Warehouse Cluster of the Virtual Warehouse(s).
     type: str
-  dbc_id:
+  catalog_id:
     description:
       - The identifier of the parent Database Catalog attached to the Virtual Warehouse(s).
       - Requires I(cluster_id).
-      - Mutally exclusive with I(id) and I(name).
+      - Mutally exclusive with I(warehouse_id) and I(name).
     type: str
+    aliases:
+      - dbc_id
   name:
     description:
       - The name of the Virtual Warehouse.
       - Requires I(cluster_id).
-      - Mutually exclusive with I(id) and I(dbc_id).
+      - Mutually exclusive with I(warehouse_id) and I(catalog_id).
     type: str
   delay:
     description:
@@ -90,12 +93,12 @@
 # List all Virtual Warehouses associated with a Data Catalog
 - cloudera.cloud.dw_virtual_warehouse_info:
     cluster_id: example-cluster-id
-    dbc_id: example-data-catalog-id
+    catalog_id: example-data-catalog-id
 
 # Describe a Virtual Warehouse by ID
 - cloudera.cloud.dw_virtual_warehouse_info:
     cluster_id: example-cluster-id
-    id: example-virtual-warehouse-id
+    warehouse_id: example-virtual-warehouse-id
 
 # Describe a Virtual Warehouse by name
 - cloudera.cloud.dw_virtual_warehouse_info:
@@ -171,14 +174,14 @@
 '''
 
 
-class DwVwInfo(CdpModule):
+class DwVirtualWarehouseInfo(CdpModule):
     def __init__(self, module):
-        super(DwVwInfo, self).__init__(module)
+        super(DwVirtualWarehouseInfo, self).__init__(module)
 
         # Set variables
-        self.id = self._get_param('id')
+        self.warehouse_id = self._get_param('warehouse_id')
         self.cluster_id = self._get_param('cluster_id')
-        self.dbc_id = self._get_param('dbc_id')
+        self.catalog_id = self._get_param('catalog_id')
         self.type = self._get_param('type')
         self.name = self._get_param('name')
         self.delay = self._get_param('delay')
@@ -192,8 +195,8 @@ def __init__(self, module):
 
     @CdpModule._Decorators.process_debug
     def process(self):
-        if self.id is not None:
-            target = self.cdpy.dw.describe_vw(cluster_id=self.cluster_id, vw_id=self.id)
+        if self.warehouse_id is not None:
+            target = self.cdpy.dw.describe_vw(cluster_id=self.cluster_id, vw_id=self.warehouse_id)
             if target is not None:
                 self.virtual_warehouses.append(target)
         else:
@@ -204,29 +207,29 @@ def process(self):
                         self.virtual_warehouses.append(
                           self.cdpy.dw.describe_vw(cluster_id=self.cluster_id, vw_id=vw['id'])
                         )
-            elif self.dbc_id is not None:
-                self.virtual_warehouses =[v for v in vws if v['dbcId'] == self.dbc_id]
+            elif self.catalog_id is not None:
+                self.virtual_warehouses =[v for v in vws if v['dbcId'] == self.catalog_id]
             else:
                 self.virtual_warehouses = vws
 
 
 def main():
     module = AnsibleModule(
         argument_spec=CdpModule.argument_spec(
-            id=dict(type='str', aliases=['vw_id']),
+            warehouse_id=dict(type='str', aliases=['vw_id', 'id']),
             cluster_id=dict(required=True, type='str'),
-            dbc_id=dict(type='str'),
+            catalog_id=dict(type='str', aliases=['dbc_id']),
             name=dict(type='str'),
             delay=dict(type='int', aliases=['polling_delay'], default=15),
             timeout=dict(type='int', aliases=['polling_timeout'], default=3600)
         ),
         mutually_exclusive=[
-            ['id', 'name', 'dbc_id']
+            ['warehouse_id', 'name', 'catalog_id']
         ],
         supports_check_mode=True
     )
 
-    result = DwVwInfo(module)
+    result = DwVirtualWarehouseInfo(module)
     output = dict(changed=False, virtual_warehouses=result.virtual_warehouses)
 
     if result.debug: