dhermes comments

googleapis · May 10, 2017 · ef54bc1 · dhermes · May 10, 2017 · waprin
1 parent a2a6be2
commit ef54bc1
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 6 deletions.
diff --git a/logging/google/cloud/logging/entries.py b/logging/google/cloud/logging/entries.py
@@ -72,7 +72,8 @@ class _BaseEntry(object):
 
     :type http_request: dict
     :param http_request: (optional) info about HTTP request associated with
-                         the entry
+                         the entry.
+
     :type resource: :class:`~google.cloud.logging.resource.Resource`
     :param resource: (Optional) Monitored resource of the entry
     """

diff --git a/logging/google/cloud/logging/logger.py b/logging/google/cloud/logging/logger.py
@@ -288,7 +288,8 @@ def log_proto(self, message, client=None, labels=None, insert_id=None,
                              the entry.
 
         :type resource: :class:`~google.cloud.logging.resource.Resource`
-        :param resource: Monitored resource of the entry
+        :param resource: Monitored resource of the entry, defaults
+                         to the global resource type.
 
         :type timestamp: :class:`datetime.datetime`
         :param timestamp: (optional) timestamp of event being logged.
@@ -369,7 +370,12 @@ class Batch(object):
     :param client: The client to use.
 
     :type resource: :class:`~google.cloud.logging.resource.Resource`
-    :param resource: (Optional) Monitored resource of the batch
+    :param resource: (Optional) Monitored resource of the batch, defaults
+                     to None, which requires that every entry should have a
+                     resource specified. Since the methods used to write
+                     entries default the entry's resource to the global
+                     resource type, this parameter is only required and used
+                     if an entry resource is explicitly set to None.
     """
     def __init__(self, logger, client, resource=None):
         self.logger = logger
@@ -408,7 +414,11 @@ def log_text(self, text, labels=None, insert_id=None, severity=None,
         :param timestamp: (optional) timestamp of event being logged.
 
         :type resource: :class:`~google.cloud.logging.resource.Resource`
-        :param resource: (Optional) Monitored resource of the entry
+        :param resource: (Optional) Monitored resource of the entry. Defaults
+                         to the global resource type. If set to None, the
+                         resource of the batch is used for this entry. If
+                         both this resource and the Batch resource are None,
+                         the API will return an error.
         """
         self.entries.append(
             ('text', text, labels, insert_id, severity, http_request,
@@ -439,7 +449,11 @@ def log_struct(self, info, labels=None, insert_id=None, severity=None,
         :param timestamp: (optional) timestamp of event being logged.
 
         :type resource: :class:`~google.cloud.logging.resource.Resource`
-        :param resource: (Optional) Monitored resource of the entry
+        :param resource: (Optional) Monitored resource of the entry. Defaults
+                         to the global resource type. If set to None, the
+                         resource of the batch is used for this entry. If
+                         both this resource and the Batch resource are None,
+                         the API will return an error.
         """
         self.entries.append(
             ('struct', info, labels, insert_id, severity, http_request,
@@ -470,7 +484,11 @@ def log_proto(self, message, labels=None, insert_id=None, severity=None,
         :param timestamp: (optional) timestamp of event being logged.
 
         :type resource: :class:`~google.cloud.logging.resource.Resource`
-        :param resource: (Optional) Monitored resource of the entry
+        :param resource: (Optional) Monitored resource of the entry. Defaults
+                         to the global resource type. If set to None, the
+                         resource of the batch is used for this entry. If
+                         both this resource and the Batch resource are None,
+                         the API will return an error.
         """
         self.entries.append(
             ('proto', message, labels, insert_id, severity, http_request,