Skip to content

Commit 0503ee7

Browse files
authored
Link concrete entry classes into usage docs. (googleapis#5512)
Closes googleapis#4118. Note that those API docs won't be as useful as they could be without either making '_BaseEntry' public (see googleapis#5511) or going to extra effort to propagate the signature docs for '__init__'.
1 parent 2252253 commit 0503ee7

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

docs/logging/usage.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,16 @@ Fetch entries for the default project.
9797
:end-before: [END client_list_entries_default]
9898
:dedent: 4
9999

100+
Entries returned by
101+
:meth:`Client.list_entries <google.cloud.logging.client.Client.list_entries>`
102+
or
103+
:meth:`Logger.list_entries <google.cloud.logging.logger.Logger.list_entries>`
104+
will be instances of one of the following classes:
105+
106+
- :class:`~google.cloud.logging.entries.TextEntry`
107+
- :class:`~google.cloud.logging.entries.StructEntry`
108+
- :class:`~google.cloud.logging.entries.ProtobufEntry`
109+
100110
Fetch entries across multiple projects.
101111

102112
.. literalinclude:: snippets.py

0 commit comments

Comments
 (0)