Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Commit

Permalink
docs: Improvements to various message and field descriptions
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 391604499

Source-Link: googleapis/googleapis@853cfd3

Source-Link: googleapis/googleapis-gen@512fb81
  • Loading branch information
gcf-owl-bot[bot] committed Aug 19, 2021
1 parent 5054572 commit b023c0e
Show file tree
Hide file tree
Showing 34 changed files with 13,121 additions and 0 deletions.
17 changes: 17 additions & 0 deletions owl-bot-staging/v1/.coveragerc
@@ -0,0 +1,17 @@
[run]
branch = True

[report]
show_missing = True
omit =
google/cloud/bigquery_datatransfer/__init__.py
exclude_lines =
# Re-enable the standard pragma
pragma: NO COVER
# Ignore debug-only repr
def __repr__
# Ignore pkg_resources exceptions.
# This is added at the module level as a safeguard for if someone
# generates the code and tries to run it without pip installing. This
# makes it virtually impossible to test properly.
except pkg_resources.DistributionNotFound
2 changes: 2 additions & 0 deletions owl-bot-staging/v1/MANIFEST.in
@@ -0,0 +1,2 @@
recursive-include google/cloud/bigquery_datatransfer *.py
recursive-include google/cloud/bigquery_datatransfer_v1 *.py
49 changes: 49 additions & 0 deletions owl-bot-staging/v1/README.rst
@@ -0,0 +1,49 @@
Python Client for Google Cloud Bigquery Datatransfer API
=================================================

Quick Start
-----------

In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. Enable the Google Cloud Bigquery Datatransfer API.
4. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
~~~~~~~~~~~~

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.

With `virtualenv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/


Mac/Linux
^^^^^^^^^

.. code-block:: console
python3 -m venv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install /path/to/library
Windows
^^^^^^^

.. code-block:: console
python3 -m venv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install \path\to\library
@@ -0,0 +1,10 @@
DataTransferService
-------------------------------------

.. automodule:: google.cloud.bigquery_datatransfer_v1.services.data_transfer_service
:members:
:inherited-members:

.. automodule:: google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers
:members:
:inherited-members:
6 changes: 6 additions & 0 deletions owl-bot-staging/v1/docs/bigquery_datatransfer_v1/services.rst
@@ -0,0 +1,6 @@
Services for Google Cloud Bigquery Datatransfer v1 API
======================================================
.. toctree::
:maxdepth: 2

data_transfer_service
7 changes: 7 additions & 0 deletions owl-bot-staging/v1/docs/bigquery_datatransfer_v1/types.rst
@@ -0,0 +1,7 @@
Types for Google Cloud Bigquery Datatransfer v1 API
===================================================

.. automodule:: google.cloud.bigquery_datatransfer_v1.types
:members:
:undoc-members:
:show-inheritance:

0 comments on commit b023c0e

Please sign in to comment.