ferruzzi commented on a change in pull request #21863: URL: https://github.com/apache/airflow/pull/21863#discussion_r827383898
########## File path: docs/apache-airflow-providers-amazon/operators/quicksight.rst ########## @@ -0,0 +1,68 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + +Amazon QuickSight Operators +======================================== + +Prerequisite Tasks +------------------ + +.. include:: _partials/prerequisite_tasks.rst + +Overview +-------- + +Airflow to Amazon QuickSight integration allows to create and start the SPICE ingestion for dataset. + + - :class:`~airflow.providers.amazon.aws.operators.quicksight.QuickSightCreateIngestionOperator` + - :class:`~airflow.providers.amazon.aws.sensor.quicksight.QuickSightSensor` + +Purpose +""""""" + +This example DAG ``example_quicksight.py`` uses ``QuickSightCreateIngestionOperator`` for +creating and starting the SPICE ingestion for the dataset configured to use SPICE. In the example, +we created two ingestion. One of the ingestion waits for the SPICE ingestion to complete while +other ingestion does not wait for completion and uses ``QuickSightSensor`` to check for ingestion +status until it completes + +Defining tasks +"""""""""""""" + +In the following code we create and start a QuickSight SPICE ingestion for the dataset and wait +for its completion. + +.. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_quicksight.py + :language: python Review comment: ```suggestion :language: python :dedent: 4 ``` Something someone showed me recently,. un-indents the code sample for a cleaner look. ########## File path: docs/apache-airflow-providers-amazon/operators/quicksight.rst ########## @@ -0,0 +1,68 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + +Amazon QuickSight Operators +======================================== + +Prerequisite Tasks +------------------ + +.. include:: _partials/prerequisite_tasks.rst + +Overview +-------- + +Airflow to Amazon QuickSight integration allows to create and start the SPICE ingestion for dataset. Review comment: Might just be me, but "allows to create" feels awkward? Maybe "allows the user to create" or "allows users" or something? ########## File path: docs/apache-airflow-providers-amazon/operators/quicksight.rst ########## @@ -0,0 +1,68 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + +Amazon QuickSight Operators +======================================== + +Prerequisite Tasks +------------------ + +.. include:: _partials/prerequisite_tasks.rst + +Overview +-------- + +Airflow to Amazon QuickSight integration allows to create and start the SPICE ingestion for dataset. + + - :class:`~airflow.providers.amazon.aws.operators.quicksight.QuickSightCreateIngestionOperator` + - :class:`~airflow.providers.amazon.aws.sensor.quicksight.QuickSightSensor` + +Purpose +""""""" + +This example DAG ``example_quicksight.py`` uses ``QuickSightCreateIngestionOperator`` for +creating and starting the SPICE ingestion for the dataset configured to use SPICE. In the example, +we created two ingestion. One of the ingestion waits for the SPICE ingestion to complete while +other ingestion does not wait for completion and uses ``QuickSightSensor`` to check for ingestion +status until it completes + +Defining tasks +"""""""""""""" + +In the following code we create and start a QuickSight SPICE ingestion for the dataset and wait +for its completion. + +.. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_quicksight.py + :language: python + :start-after: [START howto_operator_quicksight] + :end-before: [END howto_operator_quicksight] + +In the below, we create and start the SPICE ingestion but does not wait for completion. We use Review comment: ```suggestion In the below example, we create and start the SPICE ingestion but do not wait for completion. We use ``` ########## File path: docs/apache-airflow-providers-amazon/operators/quicksight.rst ########## @@ -0,0 +1,68 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + +Amazon QuickSight Operators +======================================== + +Prerequisite Tasks +------------------ + +.. include:: _partials/prerequisite_tasks.rst + +Overview +-------- + +Airflow to Amazon QuickSight integration allows to create and start the SPICE ingestion for dataset. + + - :class:`~airflow.providers.amazon.aws.operators.quicksight.QuickSightCreateIngestionOperator` + - :class:`~airflow.providers.amazon.aws.sensor.quicksight.QuickSightSensor` + +Purpose +""""""" + +This example DAG ``example_quicksight.py`` uses ``QuickSightCreateIngestionOperator`` for +creating and starting the SPICE ingestion for the dataset configured to use SPICE. In the example, +we created two ingestion. One of the ingestion waits for the SPICE ingestion to complete while +other ingestion does not wait for completion and uses ``QuickSightSensor`` to check for ingestion +status until it completes + +Defining tasks +"""""""""""""" + +In the following code we create and start a QuickSight SPICE ingestion for the dataset and wait +for its completion. + +.. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_quicksight.py + :language: python + :start-after: [START howto_operator_quicksight] + :end-before: [END howto_operator_quicksight] + +In the below, we create and start the SPICE ingestion but does not wait for completion. We use +sensor to poll for Ingestion status until it Completes. + +.. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_quicksight.py + :language: python Review comment: ```suggestion :language: python :dedent: 4 ``` ########## File path: docs/apache-airflow-providers-amazon/operators/quicksight.rst ########## @@ -0,0 +1,68 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + +Amazon QuickSight Operators +======================================== + +Prerequisite Tasks +------------------ + +.. include:: _partials/prerequisite_tasks.rst + +Overview +-------- + +Airflow to Amazon QuickSight integration allows to create and start the SPICE ingestion for dataset. + + - :class:`~airflow.providers.amazon.aws.operators.quicksight.QuickSightCreateIngestionOperator` + - :class:`~airflow.providers.amazon.aws.sensor.quicksight.QuickSightSensor` + +Purpose +""""""" + +This example DAG ``example_quicksight.py`` uses ``QuickSightCreateIngestionOperator`` for +creating and starting the SPICE ingestion for the dataset configured to use SPICE. In the example, +we created two ingestion. One of the ingestion waits for the SPICE ingestion to complete while Review comment: ```suggestion we created two ingestions. One of the ingestions waits for the SPICE ingestion to complete while ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
