File tree Expand file tree Collapse file tree 1 file changed +14
-2
lines changed
libs/labelbox/src/labelbox/schema Expand file tree Collapse file tree 1 file changed +14
-2
lines changed Original file line number Diff line number Diff line change @@ -850,7 +850,19 @@ def get_buffered_stream(
850
850
self ,
851
851
stream_type : StreamType = StreamType .RESULT ,
852
852
) -> Stream :
853
- """Returns the result of the task."""
853
+ """
854
+ Returns the result of the task.
855
+
856
+ Args:
857
+ stream_type (StreamType, optional): The type of stream to retrieve. Defaults to StreamType.RESULT.
858
+
859
+ Returns:
860
+ Stream: The buffered stream object.
861
+
862
+ Raises:
863
+ ExportTask.ExportTaskException: If the task has failed or is not ready yet.
864
+ ValueError: If the task does not have the specified stream type.
865
+ """
854
866
if self ._task .status == "FAILED" :
855
867
raise ExportTask .ExportTaskException ("Task failed" )
856
868
if self ._task .status != "COMPLETE" :
@@ -864,7 +876,7 @@ def get_buffered_stream(
864
876
)
865
877
return BufferedStream (
866
878
_TaskContext (self ._task .client , self ._task .uid , stream_type ,
867
- metadata_header ),
879
+ metadata_header ),
868
880
)
869
881
870
882
def get_stream (
You can’t perform that action at this time.
0 commit comments