Updated docs.

Author: lu-ohai

ads/jobs/builders/infrastructure/dataflow.py

@@ -802,18 +802,8 @@ def with_defined_tag(self, **kwargs) -> "DataFlow":
         """
         return self.set_spec(self.CONST_DEFINED_TAGS, kwargs)
 
-    @property
-    def freeform_tags(self) -> dict:
-        """Freeform tags"""
-        return self.get_spec(self.CONST_FREEFORM_TAGS, {})
-
-    @property
-    def defined_tags(self) -> dict:
-        """Defined tags"""
-        return self.get_spec(self.CONST_DEFINED_TAGS, {})
-
     def __getattr__(self, item):
-        if f"with_{item}" in self.__dir__():
+        if f"with_{item}" in self.__dir__() or (item == self.CONST_DEFINED_TAGS or self.CONST_FREEFORM_TAGS):
             return self.get_spec(item)
         raise AttributeError(f"Attribute {item} not found.")
 

docs/source/user_guide/apachespark/dataflow.rst

@@ -207,6 +207,8 @@ You can set them using the ``with_{property}`` functions:
 - ``with_spark_version``
 - ``with_warehouse_bucket_uri``
 - ``with_private_endpoint_id`` (`doc <https://docs.oracle.com/en-us/iaas/data-flow/using/pe-allowing.htm#pe-allowing>`__)
+- ``with_defined_tags``
+- ``with_freeform_tags``
 
 For more details, see `Data Flow class documentation <https://docs.oracle.com/en-us/iaas/tools/ads-sdk/latest/ads.jobs.html#module-ads.jobs.builders.infrastructure.dataflow>`__.
 
@@ -229,10 +231,10 @@ create applications.
 
 In the following "hello-world" example, ``DataFlow`` is populated with ``compartment_id``,
 ``driver_shape``, ``driver_shape_config``, ``executor_shape``, ``executor_shape_config``
-and ``spark_version``. ``DataFlowRuntime`` is populated with ``script_uri`` and
-``script_bucket``. The ``script_uri`` specifies the path to the script. It can be
-local or remote (an Object Storage path). If the path is local, then
-``script_bucket`` must be specified additionally because Data Flow
+, ``spark_version``, ``defined_tags`` and ``freeform_tags``. ``DataFlowRuntime`` is 
+populated with ``script_uri`` and ``script_bucket``. The ``script_uri`` specifies the 
+path to the script. It can be local or remote (an Object Storage path). If the path
+is local, then ``script_bucket`` must be specified additionally because Data Flow
 requires a script to be available in Object Storage. ADS
 performs the upload step for you, as long as you give the bucket name
 or the Object Storage path prefix to upload the script. Either can be
@@ -272,6 +274,10 @@ accepted. In the next example, the prefix is given for ``script_bucket``.
 		    .with_executor_shape("VM.Standard.E4.Flex")
 		    .with_executor_shape_config(ocpus=4, memory_in_gbs=64)
             .with_spark_version("3.0.2")
+            .with_defined_tag(
+                **{"Oracle-Tags": {"CreatedBy": "test_name@oracle.com"}}
+            )
+            .with_freeform_tag(test_freeform_key="test_freeform_value")
         )
         runtime_config = (
             DataFlowRuntime()
@@ -393,6 +399,10 @@ In the next example, ``archive_uri`` is given as an Object Storage location.
                 "spark.driverEnv.myEnvVariable": "value1",
                 "spark.executorEnv.myEnvVariable": "value2",
             })
+            .with_defined_tag(
+                **{"Oracle-Tags": {"CreatedBy": "test_name@oracle.com"}}
+            )
+            .with_freeform_tag(test_freeform_key="test_freeform_value")
         )
         runtime_config = (
             DataFlowRuntime()
@@ -566,6 +576,11 @@ into the ``Job.from_yaml()`` function to build a Data Flow job:
         numExecutors: 1
         sparkVersion: 3.2.1
         privateEndpointId: <private_endpoint_ocid>
+        definedTags:
+          Oracle-Tags:
+            CreatedBy: test_name@oracle.com
+        freeformTags:
+          test_freeform_key: test_freeform_value
       type: dataFlow
     name: dataflow_app_name
     runtime:
@@ -647,6 +662,12 @@ into the ``Job.from_yaml()`` function to build a Data Flow job:
             configuration:
                 required: false
                 type: dict
+            definedTags:
+                required: false
+                type: dict
+            freeformTags:
+                required: false
+                type: dict
     type:
         allowed:
             - dataFlow
@@ -694,7 +715,10 @@ into the ``Job.from_yaml()`` function to build a Data Flow job:
             configuration:
                 required: false
                 type: dict
-            freeform_tag:
+            definedTags:
+                required: false
+                type: dict
+            freeformTags:
                 required: false
                 type: dict
             scriptBucket:

docs/source/user_guide/apachespark/quickstart.rst

@@ -45,6 +45,10 @@ followed by the spark version, 3.2.1.
             .with_executor_shape("VM.Standard.E4.Flex")
             .with_executor_shape_config(ocpus=4, memory_in_gbs=64)
             .with_spark_version("3.2.1")
+            .with_defined_tag(
+                **{"Oracle-Tags": {"CreatedBy": "test_name@oracle.com"}}
+            )
+            .with_freeform_tag(test_freeform_key="test_freeform_value")
         )
         runtime_config = (
             DataFlowRuntime()
@@ -95,6 +99,11 @@ Assuming you have the following two files written in your current directory as `
                   memory_in_gbs: 64
                 sparkVersion: 3.2.1
                 numExecutors: 1
+                definedTags:
+                  Oracle-Tags:
+                    CreatedBy: test_name@oracle.com
+                freeformTags:
+                  test_freeform_key: test_freeform_value
             type: dataFlow
         runtime:
             kind: runtime
@@ -185,6 +194,10 @@ From a Python Environment
             .with_executor_shape("VM.Standard.E4.Flex")
             .with_executor_shape_config(ocpus=4, memory_in_gbs=64)
             .with_spark_version("3.2.1")
+            .with_defined_tag(
+                **{"Oracle-Tags": {"CreatedBy": "test_name@oracle.com"}}
+            )
+            .with_freeform_tag(test_freeform_key="test_freeform_value")
         )
         runtime_config = (
             DataFlowRuntime()
@@ -275,6 +288,11 @@ Again, assume you have the following two files written in your current directory
                     memory_in_gbs: 64
                 sparkVersion: 3.2.1
                 numExecutors: 1
+                definedTags:
+                    Oracle-Tags:
+                        CreatedBy: test_name@oracle.com
+                freeformTags:
+                    test_freeform_key: test_freeform_value
             type: dataFlow
         runtime:
             kind: runtime