Skip to content

Python: Update comments for Kinesis GetRecords #7058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 13, 2024
Merged

Python: Update comments for Kinesis GetRecords #7058

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cc76fd
Adding better description to the get_records function.
rlhagerm Nov 12, 2024
7437a05
Update metadata.
rlhagerm Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .doc_gen/metadata/kinesis_metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,7 @@ kinesis_GetRecords:
snippet_tags:
- python.example_code.kinesis.KinesisStream.class
- python.example_code.kinesis.GetRecords
- python.example_code.kinesis.DescribeStream
SAP ABAP:
versions:
- sdk_version: 1
Expand Down
6 changes: 4 additions & 2 deletions python/example_code/kinesis/streams/kinesis_stream.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,10 @@ def get_records(self, max_records):
"""
Gets records from the stream. This function is a generator that first gets
a shard iterator for the stream, then uses the shard iterator to get records
in batches from the stream. Each batch of records is yielded back to the
caller until the specified maximum number of records has been retrieved.
in batches from the stream. The shard iterator can be accessed through the
'details' property, which is populated using the 'describe' function of this class.
Each batch of records is yielded back to the caller until the specified
maximum number of records has been retrieved.

:param max_records: The maximum number of records to retrieve.
:return: Yields the current batch of retrieved records.
Expand Down
Loading