on_fragment_complete Event

Fires after each part in an automatic multipart upload is complete.

Syntax

class S3ClientFragmentCompleteEventParams(object):
  @property
  def fragment_number() -> int: ...
  @property
  def fragment_count() -> int: ...
  @property
  def interrupt() -> bool: ...
  @interrupt.setter
  def interrupt(value) -> None: ...

# In class S3Client:
@property
def on_fragment_complete() -> Callable[[S3ClientFragmentCompleteEventParams], None]: ...
@on_fragment_complete.setter
def on_fragment_complete(event_hook: Callable[[S3ClientFragmentCompleteEventParams], None]) -> None: ...

Remarks

If, when create_object is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current part that has completed. This value starts at 1.

FragmentCount is the total number of parts that will be uploaded.

Interrupt can be set to True to interrupt the upload. The upload may be resumed later.

Refer to create_object for more information.

Note: This event is not applicable when service_provider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.