Class: ExternalStorageMetrics
coresdk.common.ExternalStorageMetrics
Metrics for a set of external payload storage operations (all uploads and downloads) performed while processing a task, so core can emit unified logging and metrics.
Properties
driverNames
• driverNames: string[]
Names of the drivers that participated in the operations.
payloadCount
• payloadCount: Long
Number of payloads stored or retrieved externally.
totalDuration
• Optional totalDuration: null | $Properties
Wall-clock time spent on the external storage operations.
totalSizeBytes
• totalSizeBytes: Long
Total size in bytes of the externally stored or retrieved payloads.
Methods
toJSON
▸ toJSON(): Object
Converts this ExternalStorageMetrics to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ExternalStorageMetrics & $Properties
Creates a new ExternalStorageMetrics instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ExternalStorageMetrics & $Properties
ExternalStorageMetrics instance
▸ create(properties?): ExternalStorageMetrics
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ExternalStorageMetrics & $Properties
Decodes an ExternalStorageMetrics message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
ExternalStorageMetrics & $Properties
ExternalStorageMetrics
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ExternalStorageMetrics & $Properties
Decodes an ExternalStorageMetrics message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ExternalStorageMetrics & $Properties
ExternalStorageMetrics
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified ExternalStorageMetrics message. Does not implicitly coresdk.common.ExternalStorageMetrics.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ExternalStorageMetrics message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ExternalStorageMetrics message, length delimited. Does not implicitly coresdk.common.ExternalStorageMetrics.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ExternalStorageMetrics message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ExternalStorageMetrics
Creates an ExternalStorageMetrics message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ExternalStorageMetrics
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ExternalStorageMetrics message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ExternalStorageMetrics | ExternalStorageMetrics |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object