Skip to content

ExecuteGremlinProfileQueryInput

Source code in docs_src/capo_neptunedata/types/execute_gremlin_profile_query_input.py 
 8
 9
10
11
12
13
14
15
16
17
18
class ExecuteGremlinProfileQueryInput(TypedDict, closed=True):
    gremlin_query: "str"
    """<p>The Gremlin query string to profile.</p>"""
    results: NotRequired["bool"]
    """<p>If this flag is set to <code>TRUE</code>, the query results are gathered and displayed as part of the profile report. If <code>FALSE</code>, only the result count is displayed.</p>"""
    chop: NotRequired["int"]
    """<p>If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.</p>"""
    serializer: NotRequired["str"]
    """<p>If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/gremlin-profile-api.html">Gremlin profile API in Neptune</a> for more information.</p>"""
    index_ops: NotRequired["bool"]
    """<p>If this flag is set to <code>TRUE</code>, the results include a detailed report of all index operations that took place during query execution and serialization.</p>"""

chop instance-attribute 

chop: NotRequired[int]

If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

gremlin_query instance-attribute 

gremlin_query: str

The Gremlin query string to profile.

index_ops instance-attribute 

index_ops: NotRequired[bool]

If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

results instance-attribute 

results: NotRequired[bool]

If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

serializer instance-attribute 

serializer: NotRequired[str]

If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.