Class protos.google.backstory.Srum (0.10.1)

Represents a Srum.

Implements

Package

@google-cloud/chronicle

Constructors

(constructor)(properties)

constructor(properties?: google.backstory.ISrum);

Constructs a new Srum.

Parameter
Name Description
properties ISrum

Properties to set

Properties

backgroundBytesRead

public backgroundBytesRead: (number|Long|string);

Srum backgroundBytesRead.

backgroundBytesWritten

public backgroundBytesWritten: (number|Long|string);

Srum backgroundBytesWritten.

backgroundContextSwitches

public backgroundContextSwitches: (number|Long|string);

Srum backgroundContextSwitches.

backgroundCycleCount

public backgroundCycleCount: (number|Long|string);

Srum backgroundCycleCount.

backgroundFlushesCount

public backgroundFlushesCount: (number|Long|string);

Srum backgroundFlushesCount.

backgroundReadOperations

public backgroundReadOperations: (number|Long|string);

Srum backgroundReadOperations.

backgroundWriteOperations

public backgroundWriteOperations: (number|Long|string);

Srum backgroundWriteOperations.

id

public id: string;

Srum id.

interfaceLuid

public interfaceLuid: string;

Srum interfaceLuid.

Methods

create(properties)

public static create(properties?: google.backstory.ISrum): google.backstory.Srum;

Creates a new Srum instance using the specified properties.

Parameter
Name Description
properties ISrum

Properties to set

Returns
Type Description
Srum

Srum instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.backstory.Srum;

Decodes a Srum message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
Srum

Srum

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.backstory.Srum;

Decodes a Srum message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Srum

Srum

encode(message, writer)

public static encode(message: google.backstory.ISrum, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Srum message. Does not implicitly messages.

Parameters
Name Description
message ISrum

Srum message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.backstory.ISrum, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Srum message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ISrum

Srum message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.backstory.Srum;

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
Srum

Srum

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Srum

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Srum to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.backstory.Srum, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message Srum

Srum

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Srum message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not