Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
asapo
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Joao Alvim Oliveira Dias De Almeida
asapo
Commits
a7705d87
Commit
a7705d87
authored
1 year ago
by
Mikhail Karnevskiy
Browse files
Options
Downloads
Patches
Plain Diff
Add some docs-clarification to work with streams
parent
46eb9f28
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
consumer/api/python/asapo_consumer.pyx.in
+18
-10
18 additions, 10 deletions
consumer/api/python/asapo_consumer.pyx.in
with
18 additions
and
10 deletions
consumer/api/python/asapo_consumer.pyx.in
+
18
−
10
View file @
a7705d87
...
...
@@ -301,7 +301,9 @@ cdef class PyConsumer:
'finished': False, # Value of the stream-finish flag
'nextStream': ''} # Name of the next stream
Name of the next stream is taken from the stream-finish-flag message given by client. If this information is not given, field is empty.
Name of the next stream is taken from the stream-finish-flag message given by client.
If this information is not given, field is empty. Stream in asapo presented by the collection of messages,
which contains al least one message. If only stream metadata exists, stream would be not in the list of streams.
:param from_stream: name of stream to cut list of streams
:type from_stream: string
...
...
@@ -369,15 +371,21 @@ cdef class PyConsumer:
return id
def delete_stream(self, stream = 'default', bool error_on_not_exist = True):
"""
:param stream: stream name
:type stream: string
:param error_on_not_exist: will emit AsapoWrongInputError if set to true and tries to delete non-existing stream
:type error_on_not_exist: bool
:raises:
AsapoWrongInputError: wrong input (authorization, ...)
AsapoTimeoutError: request not finished for a given timeout
AsapoProducerError: other errors
""" Delete stream from the asapo database.
Function deletes stream footprint from asapo database. This include stream
message metadata and stream metadata. Files on disc are still untouched.
Function is not blocking, while request performs asynchronously.
If one want to see the effect of this action (e.g. on request of the stream list),
wait for a bit.
:param stream: stream name
:type stream: string
:param error_on_not_exist: will emit AsapoWrongInputError if set to true and tries to delete non-existing stream
:type error_on_not_exist: bool
:raises:
:AsapoWrongInputError: wrong input (authorization, non-existing stream, ...)
:AsapoTimeoutError: request not finished for a given consumer timeout
"""
cdef Error err
cdef DeleteStreamOptions opts
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment