| :py:mod:`airflow.providers.google.cloud.hooks.dataform` |
| ======================================================= |
| |
| .. py:module:: airflow.providers.google.cloud.hooks.dataform |
| |
| |
| Module Contents |
| --------------- |
| |
| Classes |
| ~~~~~~~ |
| |
| .. autoapisummary:: |
| |
| airflow.providers.google.cloud.hooks.dataform.DataformHook |
| |
| |
| |
| |
| .. py:class:: DataformHook(gcp_conn_id = 'google_cloud_default', delegate_to = None, impersonation_chain = None) |
| |
| Bases: :py:obj:`airflow.providers.google.common.hooks.base_google.GoogleBaseHook` |
| |
| Hook for Google Cloud DataForm APIs. |
| |
| .. py:method:: get_dataform_client() |
| |
| Retrieves client library object that allow access to Cloud Dataform service. |
| |
| |
| .. py:method:: wait_for_workflow_invocation(workflow_invocation_id, repository_id, project_id, region, wait_time = 10, timeout = None) |
| |
| Helper method which polls a job to check if it finishes. |
| |
| :param workflow_invocation_id: Id of the Workflow Invocation |
| :param repository_id: Id of the Dataform repository |
| :param project_id: Required. The ID of the Google Cloud project the cluster belongs to. |
| :param region: Required. The Cloud Dataproc region in which to handle the request. |
| :param wait_time: Number of seconds between checks |
| :param timeout: How many seconds wait for job to be ready. Used only if ``asynchronous`` is False |
| |
| |
| .. py:method:: create_compilation_result(project_id, region, repository_id, compilation_result, retry = DEFAULT, timeout = None, metadata = ()) |
| |
| Creates a new CompilationResult in a given project and location. |
| |
| :param project_id: Required. The ID of the Google Cloud project that the task belongs to. |
| :param region: Required. The ID of the Google Cloud region that the task belongs to. |
| :param repository_id: Required. The ID of the Dataform repository that the task belongs to. |
| :param compilation_result: Required. The compilation result to create. |
| :param retry: Designation of what errors, if any, should be retried. |
| :param timeout: The timeout for this request. |
| :param metadata: Strings which should be sent along with the request as metadata. |
| |
| |
| .. py:method:: get_compilation_result(project_id, region, repository_id, compilation_result_id, retry = DEFAULT, timeout = None, metadata = ()) |
| |
| Fetches a single CompilationResult. |
| |
| :param project_id: Required. The ID of the Google Cloud project that the task belongs to. |
| :param region: Required. The ID of the Google Cloud region that the task belongs to. |
| :param repository_id: Required. The ID of the Dataform repository that the task belongs to. |
| :param compilation_result_id: The Id of the Dataform Compilation Result |
| :param retry: Designation of what errors, if any, should be retried. |
| :param timeout: The timeout for this request. |
| :param metadata: Strings which should be sent along with the request as metadata. |
| |
| |
| .. py:method:: create_workflow_invocation(project_id, region, repository_id, workflow_invocation, retry = DEFAULT, timeout = None, metadata = ()) |
| |
| Creates a new WorkflowInvocation in a given Repository. |
| |
| :param project_id: Required. The ID of the Google Cloud project that the task belongs to. |
| :param region: Required. The ID of the Google Cloud region that the task belongs to. |
| :param repository_id: Required. The ID of the Dataform repository that the task belongs to. |
| :param workflow_invocation: Required. The workflow invocation resource to create. |
| :param retry: Designation of what errors, if any, should be retried. |
| :param timeout: The timeout for this request. |
| :param metadata: Strings which should be sent along with the request as metadata. |
| |
| |
| .. py:method:: get_workflow_invocation(project_id, region, repository_id, workflow_invocation_id, retry = DEFAULT, timeout = None, metadata = ()) |
| |
| Fetches a single WorkflowInvocation. |
| |
| :param project_id: Required. The ID of the Google Cloud project that the task belongs to. |
| :param region: Required. The ID of the Google Cloud region that the task belongs to. |
| :param repository_id: Required. The ID of the Dataform repository that the task belongs to. |
| :param workflow_invocation_id: Required. The workflow invocation resource's id. |
| :param retry: Designation of what errors, if any, should be retried. |
| :param timeout: The timeout for this request. |
| :param metadata: Strings which should be sent along with the request as metadata. |
| |
| |
| .. py:method:: cancel_workflow_invocation(project_id, region, repository_id, workflow_invocation_id, retry = DEFAULT, timeout = None, metadata = ()) |
| |
| Requests cancellation of a running WorkflowInvocation. |
| |
| :param project_id: Required. The ID of the Google Cloud project that the task belongs to. |
| :param region: Required. The ID of the Google Cloud region that the task belongs to. |
| :param repository_id: Required. The ID of the Dataform repository that the task belongs to. |
| :param workflow_invocation_id: Required. The workflow invocation resource's id. |
| :param retry: Designation of what errors, if any, should be retried. |
| :param timeout: The timeout for this request. |
| :param metadata: Strings which should be sent along with the request as metadata. |
| |
| |
| |