You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2019/08/20 13:34:11 UTC

[GitHub] [airflow] kaxil commented on a change in pull request #5335: [AIRFLOW-4588] Add GoogleDiscoveryApiHook and GoogleApiToS3Transfer

kaxil commented on a change in pull request #5335: [AIRFLOW-4588] Add GoogleDiscoveryApiHook and GoogleApiToS3Transfer
URL: https://github.com/apache/airflow/pull/5335#discussion_r311204942
 
 

 ##########
 File path: airflow/contrib/hooks/google_discovery_api_hook.py
 ##########
 @@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+# 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.
+#
+"""
+This module allows you to connect to the Google Discovery API Service and query it.
+"""
+from googleapiclient.discovery import build
+
+from airflow.contrib.hooks.gcp_api_base_hook import GoogleCloudBaseHook
+
+
+class GoogleDiscoveryApiHook(GoogleCloudBaseHook):
+    """
+    A hook to use the Google API Discovery Service.
+
+    :param api_service_name: The name of the api service that is needed to get the data
+        for example 'youtube'.
+    :type api_service_name: str
+    :param api_version: The version of the api that will be requested for example 'v3'.
+    :type api_version: str
+    :param gcp_conn_id: The connection ID to use when fetching connection info.
+    :type gcp_conn_id: str
+    :param delegate_to: The account to impersonate, if any.
+        For this to work, the service account making the request must have
+        domain-wide delegation enabled.
+    :type delegate_to: str
+    """
+    _conn = None
+
+    def __init__(
+        self, api_service_name, api_version, gcp_conn_id='google_cloud_default', delegate_to=None
+    ):
+        super(GoogleDiscoveryApiHook, self).__init__(gcp_conn_id=gcp_conn_id, delegate_to=delegate_to)
+        self.api_service_name = api_service_name
+        self.api_version = api_version
+
+    def get_conn(self):
+        """
+        Creates an authenticated api client for the given api service name and credentials.
+
+        :return: the authenticated api service.
+        :rtype: Resource
+        """
+        self.log.info("Authenticating Google API Client")
+
+        if not self._conn:
+            http_authorized = self._authorize()
+            self._conn = build(serviceName=self.api_service_name, version=self.api_version,
+                               http=http_authorized, cache_discovery=False)
+        return self._conn
+
+    def query(self, endpoint, data, paginate=False):
+        """
+        Creates a dynamic API call to any Google API registered in Google's API Client Library
+        and queries it.
+
+        :param endpoint: The client libraries path to the api call's executing method.
+            For example: 'analyticsreporting.reports.batchGet'
+
+            .. seealso:: https://developers.google.com/apis-explorer
+                for more information on what methods are available.
+        :type endpoint: str
+        :param data: The data (endpoint params) needed for the specific request to given endpoint.
+        :type data: dict
+        :param paginate: If set to True, it will collect all pa
 
 Review comment:
   ```suggestion
           :param paginate: If set to True, it will collect all pages
   ```

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services