Link spec URLs for job configuration properties.

tseaver · tseaver · commit 4c4c3849999f · 2015-08-17T21:50:25.000-04:00
Addresses: googleapis#1064 (comment)
diff --git a/gcloud/bigquery/job.py b/gcloud/bigquery/job.py
@@ -289,29 +289,46 @@ def validate(cls, value):
 
 class CreateDisposition(_Enum):
     """Pseudo-enum for allowed values for ``create_disposition`` properties.
+
+    See:
+    https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.createDisposition
+    https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.createDisposition
     """
     CREATE_IF_NEEDED = 'CREATE_IF_NEEDED'
     CREATE_NEVER = 'CREATE_NEVER'
     ALLOWED = (CREATE_IF_NEEDED, CREATE_NEVER)
 
 
 class Encoding(_Enum):
-    """Pseudo-enum for allowed values for ``encoding`` properties."""
+    """Pseudo-enum for allowed values for ``encoding`` properties.
+
+    See:
+    https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.encoding
+    """
     UTF_8 = 'UTF-8'
     ISO_8559_1 = 'ISO-8559-1'
     ALLOWED = (UTF_8, ISO_8559_1)
 
 
 class SourceFormat(_Enum):
-    """Pseudo-enum for allowed values for ``source_format`` properties."""
+    """Pseudo-enum for allowed values for ``source_format`` properties.
+
+    See:
+    https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.sourceFormat
+    """
     CSV = 'CSV'
     DATASTORE_BACKUP = 'DATASTORE_BACKUP'
     NEWLINE_DELIMITED_JSON = 'NEWLINE_DELIMITED_JSON'
     ALLOWED = (CSV, DATASTORE_BACKUP, NEWLINE_DELIMITED_JSON)
 
 
 class WriteDisposition(_Enum):
-    """Pseudo-enum for allowed values for ``write_disposition`` properties."""
+    """Pseudo-enum for allowed values for ``write_disposition`` properties.
+
+    See:
+    https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.writeDisposition
+    https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.writeDisposition
+    """
     WRITE_APPEND = 'WRITE_APPEND'
     WRITE_TRUNCATE = 'WRITE_TRUNCATE'
     WRITE_EMPTY = 'WRITE_EMPTY'
@@ -431,6 +448,9 @@ def output_rows(self):
     def allow_jagged_rows(self):
         """Allow rows with missing trailing commas for optional fields.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.allowJaggedRows
+
         :rtype: boolean, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -458,6 +478,9 @@ def allow_jagged_rows(self):
     def allow_quoted_newlines(self):
         """Allow rows with quoted newlines.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.allowQuotedNewlines
+
         :rtype: boolean, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -485,6 +508,9 @@ def allow_quoted_newlines(self):
     def create_disposition(self):
         """Define how the back-end handles a missing destination table.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.createDisposition
+
         :rtype: string, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -509,6 +535,9 @@ def create_disposition(self):
     def encoding(self):
         """Encoding for source data.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.encoding
+
         :rtype: string, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -533,6 +562,9 @@ def encoding(self):
     def field_delimiter(self):
         """Allow rows with missing trailing commas for optional fields.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.fieldDelimiter
+
         :rtype: string, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -560,6 +592,9 @@ def field_delimiter(self):
     def ignore_unknown_values(self):
         """Ignore rows with extra columns beyond those specified by the schema.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.ignoreUnknownValues
+
         :rtype: boolean, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -587,6 +622,9 @@ def ignore_unknown_values(self):
     def max_bad_records(self):
         """Max number of bad records to be ignored.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.maxBadRecords
+
         :rtype: integer, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -614,6 +652,9 @@ def max_bad_records(self):
     def quote_character(self):
         """Character used to quote values.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.quote
+
         :rtype: string, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -641,6 +682,9 @@ def quote_character(self):
     def skip_leading_rows(self):
         """Count of leading rows to be skipped.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.skipLeadingRows
+
         :rtype: integer, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -668,6 +712,9 @@ def skip_leading_rows(self):
     def source_format(self):
         """Format of source data files.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.sourceFormat
+
         :rtype: string, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -692,6 +739,9 @@ def source_format(self):
     def write_disposition(self):
         """Allow rows with missing trailing commas for optional fields.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.writeDisposition
+
         :rtype: boolean, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -803,6 +853,9 @@ def __init__(self, name, destination, sources, client):
     def create_disposition(self):
         """Handling for missing destination table.
 
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.createDisposition
+
         :rtype: string, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
@@ -812,9 +865,8 @@ def create_disposition(self):
     def create_disposition(self, value):
         """Update create_disposition.
 
-        :type value: boolean
-        :param value: new create_disposition: one of "CREATE_IF_NEEDED" or
-                      "CREATE_NEVER"
+        :type value: string
+        :param value: allowed values for :class:`CreateDisposition`
         """
         CreateDisposition.validate(value)   # raises ValueError if invalid
         self._configuration._create_disposition = value
@@ -828,7 +880,10 @@ def create_disposition(self):
     def write_disposition(self):
         """Allow rows with missing trailing commas for optional fields.
 
-        :rtype: boolean, or ``NoneType``
+        See:
+        https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.writeDisposition
+
+        :rtype: string, or ``NoneType``
         :returns: The value as set by the user, or None (the default).
         """
         return self._configuration._write_disposition
