IUploadSummaryResult Interface
Packages > @fluidframework/container-runtime > IUploadSummaryResult
Results of submitSummary after uploading the tree to storage.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/container-runtime/legacy
.
For more information about our API support guarantees, see here .
Signature
export interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage">
Extends: Omit<IGenerateSummaryTreeResult , “stage”>
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
handle | Alpha |
readonly |
string | The handle returned by storage pointing to the uploaded summary tree. |
stage | Alpha |
readonly |
"upload" | |
uploadDuration | Alpha |
readonly |
number | Time it took to upload the summary tree to storage. |
Property Details
handle
The handle returned by storage pointing to the uploaded summary tree.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly handle: string;
Type: string
stage
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly stage: "upload";
Type: “upload”
uploadDuration
Time it took to upload the summary tree to storage.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/container-runtime/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly uploadDuration: number;
Type: number