Skip to main content

Class: 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?: $Properties | null

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()​

Call Signature​

static create(properties?): ExternalStorageMetrics & $Properties

Creates a new ExternalStorageMetrics instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExternalStorageMetrics & $Properties

ExternalStorageMetrics instance

Call Signature​

static create(properties?): ExternalStorageMetrics

Creates a new ExternalStorageMetrics instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExternalStorageMetrics

ExternalStorageMetrics instance

decode()​

static decode(reader, length?): ExternalStorageMetrics & $Properties

Decodes an ExternalStorageMetrics message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): ExternalStorageMetrics & $Properties

Decodes an ExternalStorageMetrics message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified ExternalStorageMetrics message. Does not implicitly coresdk.common.ExternalStorageMetrics.verify|verify messages.

Parameters​

message​

$Properties

ExternalStorageMetrics message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ExternalStorageMetrics message, length delimited. Does not implicitly coresdk.common.ExternalStorageMetrics.verify|verify messages.

Parameters​

message​

$Properties

ExternalStorageMetrics message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ExternalStorageMetrics

Creates an ExternalStorageMetrics message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ExternalStorageMetrics

ExternalStorageMetrics

toObject()​

static toObject(message, options?): object

Creates a plain object from an ExternalStorageMetrics message. Also converts values to other types if specified.

Parameters​

message​

ExternalStorageMetrics

ExternalStorageMetrics

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object