Skip to content

GetPropertygraphStreamInput

Source code in docs_src/capo_neptunedata/types/get_propertygraph_stream_input.py 
12
13
14
15
16
17
18
19
20
21
22
class GetPropertygraphStreamInput(TypedDict, closed=True):
    limit: NotRequired["int"]
    """<p>Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the <code>limit</code> parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.</p> <p>The range for <code>limit</code> is 1 to 100,000, with a default of 10.</p>"""
    iterator_type: NotRequired["capo_neptunedata.types.iterator_type.IteratorType"]
    """<p>Can be one of:</p> <ul> <li> <p> <code>AT_SEQUENCE_NUMBER</code> - Indicates that reading should start from the event sequence number specified jointly by the <code>commitNum</code> and <code>opNum</code> parameters.</p> </li> <li> <p> <code>AFTER_SEQUENCE_NUMBER</code> - Indicates that reading should start right after the event sequence number specified jointly by the <code>commitNum</code> and <code>opNum</code> parameters.</p> </li> <li> <p> <code>TRIM_HORIZON</code> - Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.</p> </li> <li> <p> <code>LATEST</code> - Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.</p> </li> </ul>"""
    commit_num: NotRequired["int"]
    """<p>The commit number of the starting record to read from the change-log stream. This parameter is required when <code>iteratorType</code> is<code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>, and ignored when <code>iteratorType</code> is <code>TRIM_HORIZON</code> or <code>LATEST</code>.</p>"""
    op_num: NotRequired["int"]
    """<p>The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is <code>1</code>.</p>"""
    encoding: NotRequired["capo_neptunedata.types.encoding.Encoding"]
    """<p>If set to TRUE, Neptune compresses the response using gzip encoding.</p>"""

commit_num instance-attribute 

commit_num: NotRequired[int]

The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

encoding instance-attribute 

encoding: NotRequired[Encoding]

If set to TRUE, Neptune compresses the response using gzip encoding.

iterator_type instance-attribute 

iterator_type: NotRequired[IteratorType]

Can be one of:

  • AT_SEQUENCE_NUMBER - Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

  • AFTER_SEQUENCE_NUMBER - Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

  • TRIM_HORIZON - Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

  • LATEST - Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

limit instance-attribute 

limit: NotRequired[int]

Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.

The range for limit is 1 to 100,000, with a default of 10.

op_num instance-attribute 

op_num: NotRequired[int]

The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.