apollo-engine-reporting-protobuf

  • Version 0.5.2
  • Published
  • 527 kB
  • 1 dependency
  • MIT license

Install

npm i apollo-engine-reporting-protobuf
yarn add apollo-engine-reporting-protobuf
pnpm add apollo-engine-reporting-protobuf

Overview

Protobuf format for Apollo Engine

Index

Classes

Interfaces

Namespaces

Classes

class ContextualizedQueryLatencyStats

class ContextualizedQueryLatencyStats implements IContextualizedQueryLatencyStats {}
  • Represents a ContextualizedQueryLatencyStats.

constructor

constructor(properties?: IContextualizedQueryLatencyStats);
  • Constructs a new ContextualizedQueryLatencyStats.

    Parameter properties

    Properties to set

property context

context?: IStatsContext;
  • ContextualizedQueryLatencyStats context.

property queryLatencyStats

queryLatencyStats?: IQueryLatencyStats;
  • ContextualizedQueryLatencyStats queryLatencyStats.

method create

static create: (
properties?: IContextualizedQueryLatencyStats
) => ContextualizedQueryLatencyStats;
  • Creates a new ContextualizedQueryLatencyStats instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    ContextualizedQueryLatencyStats instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => ContextualizedQueryLatencyStats;
  • Decodes a ContextualizedQueryLatencyStats message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    ContextualizedQueryLatencyStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
reader: $protobuf.Reader | Uint8Array
) => ContextualizedQueryLatencyStats;
  • Decodes a ContextualizedQueryLatencyStats message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    ContextualizedQueryLatencyStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IContextualizedQueryLatencyStats, writer?: any) => any;
  • Encodes the specified ContextualizedQueryLatencyStats message. Does not implicitly verify messages.

    Parameter message

    ContextualizedQueryLatencyStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (
message: IContextualizedQueryLatencyStats,
writer?: any
) => any;
  • Encodes the specified ContextualizedQueryLatencyStats message, length delimited. Does not implicitly verify messages.

    Parameter message

    ContextualizedQueryLatencyStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: {
[k: string]: any;
}) => ContextualizedQueryLatencyStats;
  • Creates a ContextualizedQueryLatencyStats message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    ContextualizedQueryLatencyStats

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this ContextualizedQueryLatencyStats to JSON.

    Returns

    JSON object

method toObject

static toObject: (
message: ContextualizedQueryLatencyStats,
options?: any
) => { [k: string]: any };
  • Creates a plain object from a ContextualizedQueryLatencyStats message. Also converts values to other types if specified.

    Parameter message

    ContextualizedQueryLatencyStats

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a ContextualizedQueryLatencyStats message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class ContextualizedStats

class ContextualizedStats implements IContextualizedStats {}
  • Represents a ContextualizedStats.

constructor

constructor(properties?: IContextualizedStats);
  • Constructs a new ContextualizedStats.

    Parameter properties

    Properties to set

property context

context?: IStatsContext;
  • ContextualizedStats context.

property perTypeStat

perTypeStat: { [k: string]: ITypeStat };
  • ContextualizedStats perTypeStat.

property queryLatencyStats

queryLatencyStats?: IQueryLatencyStats;
  • ContextualizedStats queryLatencyStats.

method create

static create: (properties?: IContextualizedStats) => ContextualizedStats;
  • Creates a new ContextualizedStats instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    ContextualizedStats instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => ContextualizedStats;
  • Decodes a ContextualizedStats message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    ContextualizedStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
reader: $protobuf.Reader | Uint8Array
) => ContextualizedStats;
  • Decodes a ContextualizedStats message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    ContextualizedStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IContextualizedStats, writer?: any) => any;
  • Encodes the specified ContextualizedStats message. Does not implicitly verify messages.

    Parameter message

    ContextualizedStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IContextualizedStats, writer?: any) => any;
  • Encodes the specified ContextualizedStats message, length delimited. Does not implicitly verify messages.

    Parameter message

    ContextualizedStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => ContextualizedStats;
  • Creates a ContextualizedStats message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    ContextualizedStats

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this ContextualizedStats to JSON.

    Returns

    JSON object

method toObject

static toObject: (
message: ContextualizedStats,
options?: any
) => { [k: string]: any };
  • Creates a plain object from a ContextualizedStats message. Also converts values to other types if specified.

    Parameter message

    ContextualizedStats

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a ContextualizedStats message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class ContextualizedTypeStats

class ContextualizedTypeStats implements IContextualizedTypeStats {}
  • Represents a ContextualizedTypeStats.

constructor

constructor(properties?: IContextualizedTypeStats);
  • Constructs a new ContextualizedTypeStats.

    Parameter properties

    Properties to set

property context

context?: IStatsContext;
  • ContextualizedTypeStats context.

property perTypeStat

perTypeStat: { [k: string]: ITypeStat };
  • ContextualizedTypeStats perTypeStat.

method create

static create: (
properties?: IContextualizedTypeStats
) => ContextualizedTypeStats;
  • Creates a new ContextualizedTypeStats instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    ContextualizedTypeStats instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => ContextualizedTypeStats;
  • Decodes a ContextualizedTypeStats message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    ContextualizedTypeStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
reader: $protobuf.Reader | Uint8Array
) => ContextualizedTypeStats;
  • Decodes a ContextualizedTypeStats message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    ContextualizedTypeStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IContextualizedTypeStats, writer?: any) => any;
  • Encodes the specified ContextualizedTypeStats message. Does not implicitly verify messages.

    Parameter message

    ContextualizedTypeStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IContextualizedTypeStats, writer?: any) => any;
  • Encodes the specified ContextualizedTypeStats message, length delimited. Does not implicitly verify messages.

    Parameter message

    ContextualizedTypeStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => ContextualizedTypeStats;
  • Creates a ContextualizedTypeStats message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    ContextualizedTypeStats

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this ContextualizedTypeStats to JSON.

    Returns

    JSON object

method toObject

static toObject: (
message: ContextualizedTypeStats,
options?: any
) => { [k: string]: any };
  • Creates a plain object from a ContextualizedTypeStats message. Also converts values to other types if specified.

    Parameter message

    ContextualizedTypeStats

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a ContextualizedTypeStats message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class Field

class Field implements IField {}
  • Represents a Field.

constructor

constructor(properties?: IField);
  • Constructs a new Field.

    Parameter properties

    Properties to set

property name

name: string;
  • Field name.

property returnType

returnType: string;
  • Field returnType.

method create

static create: (properties?: IField) => Field;
  • Creates a new Field instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    Field instance

method decode

static decode: (reader: $protobuf.Reader | Uint8Array, length?: number) => Field;
  • Decodes a Field message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    Field

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => Field;
  • Decodes a Field message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    Field

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IField, writer?: any) => any;
  • Encodes the specified Field message. Does not implicitly verify messages.

    Parameter message

    Field message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IField, writer?: any) => any;
  • Encodes the specified Field message, length delimited. Does not implicitly verify messages.

    Parameter message

    Field message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => Field;
  • Creates a Field message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    Field

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this Field to JSON.

    Returns

    JSON object

method toObject

static toObject: (message: Field, options?: any) => { [k: string]: any };
  • Creates a plain object from a Field message. Also converts values to other types if specified.

    Parameter message

    Field

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a Field message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class FieldStat

class FieldStat implements IFieldStat {}
  • Represents a FieldStat.

constructor

constructor(properties?: IFieldStat);
  • Constructs a new FieldStat.

    Parameter properties

    Properties to set

property count

count: number;
  • FieldStat count.

property errorsCount

errorsCount: number;
  • FieldStat errorsCount.

property latencyCount

latencyCount: number[];
  • FieldStat latencyCount.

property requestsWithErrorsCount

requestsWithErrorsCount: number;
  • FieldStat requestsWithErrorsCount.

property returnType

returnType: string;
  • FieldStat returnType.

method create

static create: (properties?: IFieldStat) => FieldStat;
  • Creates a new FieldStat instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    FieldStat instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => FieldStat;
  • Decodes a FieldStat message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    FieldStat

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => FieldStat;
  • Decodes a FieldStat message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    FieldStat

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IFieldStat, writer?: any) => any;
  • Encodes the specified FieldStat message. Does not implicitly verify messages.

    Parameter message

    FieldStat message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IFieldStat, writer?: any) => any;
  • Encodes the specified FieldStat message, length delimited. Does not implicitly verify messages.

    Parameter message

    FieldStat message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => FieldStat;
  • Creates a FieldStat message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    FieldStat

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this FieldStat to JSON.

    Returns

    JSON object

method toObject

static toObject: (message: FieldStat, options?: any) => { [k: string]: any };
  • Creates a plain object from a FieldStat message. Also converts values to other types if specified.

    Parameter message

    FieldStat

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a FieldStat message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class PathErrorStats

class PathErrorStats implements IPathErrorStats {}
  • Represents a PathErrorStats.

constructor

constructor(properties?: IPathErrorStats);
  • Constructs a new PathErrorStats.

    Parameter properties

    Properties to set

property children

children: { [k: string]: IPathErrorStats };
  • PathErrorStats children.

property errorsCount

errorsCount: number;
  • PathErrorStats errorsCount.

property requestsWithErrorsCount

requestsWithErrorsCount: number;
  • PathErrorStats requestsWithErrorsCount.

method create

static create: (properties?: IPathErrorStats) => PathErrorStats;
  • Creates a new PathErrorStats instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    PathErrorStats instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => PathErrorStats;
  • Decodes a PathErrorStats message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    PathErrorStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
reader: $protobuf.Reader | Uint8Array
) => PathErrorStats;
  • Decodes a PathErrorStats message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    PathErrorStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IPathErrorStats, writer?: any) => any;
  • Encodes the specified PathErrorStats message. Does not implicitly verify messages.

    Parameter message

    PathErrorStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IPathErrorStats, writer?: any) => any;
  • Encodes the specified PathErrorStats message, length delimited. Does not implicitly verify messages.

    Parameter message

    PathErrorStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => PathErrorStats;
  • Creates a PathErrorStats message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    PathErrorStats

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this PathErrorStats to JSON.

    Returns

    JSON object

method toObject

static toObject: (
message: PathErrorStats,
options?: any
) => { [k: string]: any };
  • Creates a plain object from a PathErrorStats message. Also converts values to other types if specified.

    Parameter message

    PathErrorStats

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a PathErrorStats message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class QueryLatencyStats

class QueryLatencyStats implements IQueryLatencyStats {}
  • Represents a QueryLatencyStats.

constructor

constructor(properties?: IQueryLatencyStats);
  • Constructs a new QueryLatencyStats.

    Parameter properties

    Properties to set

property cacheHits

cacheHits: number;
  • QueryLatencyStats cacheHits.

property cacheLatencyCount

cacheLatencyCount: number[];
  • QueryLatencyStats cacheLatencyCount.

property forbiddenOperationCount

forbiddenOperationCount: number;
  • QueryLatencyStats forbiddenOperationCount.

property latencyCount

latencyCount: number[];
  • QueryLatencyStats latencyCount.

property persistedQueryHits

persistedQueryHits: number;
  • QueryLatencyStats persistedQueryHits.

property persistedQueryMisses

persistedQueryMisses: number;
  • QueryLatencyStats persistedQueryMisses.

property privateCacheTtlCount

privateCacheTtlCount: number[];
  • QueryLatencyStats privateCacheTtlCount.

property publicCacheTtlCount

publicCacheTtlCount: number[];
  • QueryLatencyStats publicCacheTtlCount.

property registeredOperationCount

registeredOperationCount: number;
  • QueryLatencyStats registeredOperationCount.

property requestCount

requestCount: number;
  • QueryLatencyStats requestCount.

property requestsWithErrorsCount

requestsWithErrorsCount: number;
  • QueryLatencyStats requestsWithErrorsCount.

property rootErrorStats

rootErrorStats?: IPathErrorStats;
  • QueryLatencyStats rootErrorStats.

method create

static create: (properties?: IQueryLatencyStats) => QueryLatencyStats;
  • Creates a new QueryLatencyStats instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    QueryLatencyStats instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => QueryLatencyStats;
  • Decodes a QueryLatencyStats message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    QueryLatencyStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
reader: $protobuf.Reader | Uint8Array
) => QueryLatencyStats;
  • Decodes a QueryLatencyStats message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    QueryLatencyStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IQueryLatencyStats, writer?: any) => any;
  • Encodes the specified QueryLatencyStats message. Does not implicitly verify messages.

    Parameter message

    QueryLatencyStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IQueryLatencyStats, writer?: any) => any;
  • Encodes the specified QueryLatencyStats message, length delimited. Does not implicitly verify messages.

    Parameter message

    QueryLatencyStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => QueryLatencyStats;
  • Creates a QueryLatencyStats message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    QueryLatencyStats

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this QueryLatencyStats to JSON.

    Returns

    JSON object

method toObject

static toObject: (
message: QueryLatencyStats,
options?: any
) => { [k: string]: any };
  • Creates a plain object from a QueryLatencyStats message. Also converts values to other types if specified.

    Parameter message

    QueryLatencyStats

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a QueryLatencyStats message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class Report

class Report implements IReport {}
  • Represents a Report.

constructor

constructor(properties?: IReport);
  • Constructs a new Report.

    Parameter properties

    Properties to set

property endTime

endTime?: google.protobuf.ITimestamp;
  • Report endTime.

property header

header?: IReportHeader;
  • Report header.

property tracesPerQuery

tracesPerQuery: { [k: string]: ITracesAndStats };
  • Report tracesPerQuery.

method create

static create: (properties?: IReport) => Report;
  • Creates a new Report instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    Report instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => Report;
  • Decodes a Report message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    Report

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => Report;
  • Decodes a Report message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    Report

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IReport, writer?: any) => any;
  • Encodes the specified Report message. Does not implicitly verify messages.

    Parameter message

    Report message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IReport, writer?: any) => any;
  • Encodes the specified Report message, length delimited. Does not implicitly verify messages.

    Parameter message

    Report message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => Report;
  • Creates a Report message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    Report

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this Report to JSON.

    Returns

    JSON object

method toObject

static toObject: (message: Report, options?: any) => { [k: string]: any };
  • Creates a plain object from a Report message. Also converts values to other types if specified.

    Parameter message

    Report

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a Report message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class ReportHeader

class ReportHeader implements IReportHeader {}
  • Represents a ReportHeader.

constructor

constructor(properties?: IReportHeader);
  • Constructs a new ReportHeader.

    Parameter properties

    Properties to set

property agentVersion

agentVersion: string;
  • ReportHeader agentVersion.

property executableSchemaId

executableSchemaId: string;
  • ReportHeader executableSchemaId.

property hostname

hostname: string;
  • ReportHeader hostname.

property runtimeVersion

runtimeVersion: string;
  • ReportHeader runtimeVersion.

property schemaTag

schemaTag: string;
  • ReportHeader schemaTag.

property serviceVersion

serviceVersion: string;
  • ReportHeader serviceVersion.

property uname

uname: string;
  • ReportHeader uname.

method create

static create: (properties?: IReportHeader) => ReportHeader;
  • Creates a new ReportHeader instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    ReportHeader instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => ReportHeader;
  • Decodes a ReportHeader message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    ReportHeader

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => ReportHeader;
  • Decodes a ReportHeader message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    ReportHeader

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IReportHeader, writer?: any) => any;
  • Encodes the specified ReportHeader message. Does not implicitly verify messages.

    Parameter message

    ReportHeader message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IReportHeader, writer?: any) => any;
  • Encodes the specified ReportHeader message, length delimited. Does not implicitly verify messages.

    Parameter message

    ReportHeader message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => ReportHeader;
  • Creates a ReportHeader message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    ReportHeader

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this ReportHeader to JSON.

    Returns

    JSON object

method toObject

static toObject: (message: ReportHeader, options?: any) => { [k: string]: any };
  • Creates a plain object from a ReportHeader message. Also converts values to other types if specified.

    Parameter message

    ReportHeader

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a ReportHeader message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class StatsContext

class StatsContext implements IStatsContext {}
  • Represents a StatsContext.

constructor

constructor(properties?: IStatsContext);
  • Constructs a new StatsContext.

    Parameter properties

    Properties to set

property clientName

clientName: string;
  • StatsContext clientName.

property clientReferenceId

clientReferenceId: string;
  • StatsContext clientReferenceId.

property clientVersion

clientVersion: string;
  • StatsContext clientVersion.

method create

static create: (properties?: IStatsContext) => StatsContext;
  • Creates a new StatsContext instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    StatsContext instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => StatsContext;
  • Decodes a StatsContext message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    StatsContext

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => StatsContext;
  • Decodes a StatsContext message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    StatsContext

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IStatsContext, writer?: any) => any;
  • Encodes the specified StatsContext message. Does not implicitly verify messages.

    Parameter message

    StatsContext message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IStatsContext, writer?: any) => any;
  • Encodes the specified StatsContext message, length delimited. Does not implicitly verify messages.

    Parameter message

    StatsContext message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => StatsContext;
  • Creates a StatsContext message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    StatsContext

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this StatsContext to JSON.

    Returns

    JSON object

method toObject

static toObject: (message: StatsContext, options?: any) => { [k: string]: any };
  • Creates a plain object from a StatsContext message. Also converts values to other types if specified.

    Parameter message

    StatsContext

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a StatsContext message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class Trace

class Trace implements ITrace {}
  • Represents a Trace.

constructor

constructor(properties?: ITrace);
  • Constructs a new Trace.

    Parameter properties

    Properties to set

property cachePolicy

cachePolicy?: Trace.ICachePolicy;
  • Trace cachePolicy.

property clientAddress

clientAddress: string;
  • Trace clientAddress.

property clientName

clientName: string;
  • Trace clientName.

property clientReferenceId

clientReferenceId: string;
  • Trace clientReferenceId.

property clientVersion

clientVersion: string;
  • Trace clientVersion.

property details

details?: Trace.IDetails;
  • Trace details.

property durationNs

durationNs: number;
  • Trace durationNs.

property endTime

endTime?: google.protobuf.ITimestamp;
  • Trace endTime.

property forbiddenOperation

forbiddenOperation: boolean;
  • Trace forbiddenOperation.

property fullQueryCacheHit

fullQueryCacheHit: boolean;
  • Trace fullQueryCacheHit.

property http

http?: Trace.IHTTP;
  • Trace http.

property legacySignatureNeedsResigning

legacySignatureNeedsResigning: string;
  • Trace legacySignatureNeedsResigning.

property persistedQueryHit

persistedQueryHit: boolean;
  • Trace persistedQueryHit.

property persistedQueryRegister

persistedQueryRegister: boolean;
  • Trace persistedQueryRegister.

property queryPlan

queryPlan?: Trace.IQueryPlanNode;
  • Trace queryPlan.

property registeredOperation

registeredOperation: boolean;
  • Trace registeredOperation.

property root

root?: Trace.INode;
  • Trace root.

property signature

signature: string;
  • Trace signature.

property startTime

startTime?: google.protobuf.ITimestamp;
  • Trace startTime.

method create

static create: (properties?: ITrace) => Trace;
  • Creates a new Trace instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    Trace instance

method decode

static decode: (reader: $protobuf.Reader | Uint8Array, length?: number) => Trace;
  • Decodes a Trace message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    Trace

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => Trace;
  • Decodes a Trace message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    Trace

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: ITrace, writer?: any) => any;
  • Encodes the specified Trace message. Does not implicitly verify messages.

    Parameter message

    Trace message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: ITrace, writer?: any) => any;
  • Encodes the specified Trace message, length delimited. Does not implicitly verify messages.

    Parameter message

    Trace message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => Trace;
  • Creates a Trace message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    Trace

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this Trace to JSON.

    Returns

    JSON object

method toObject

static toObject: (message: Trace, options?: any) => { [k: string]: any };
  • Creates a plain object from a Trace message. Also converts values to other types if specified.

    Parameter message

    Trace

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a Trace message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class TracesAndStats

class TracesAndStats implements ITracesAndStats {}
  • Represents a TracesAndStats.

constructor

constructor(properties?: ITracesAndStats);
  • Constructs a new TracesAndStats.

    Parameter properties

    Properties to set

property statsWithContext

statsWithContext: IContextualizedStats[];
  • TracesAndStats statsWithContext.

property trace

trace: ITrace[];
  • TracesAndStats trace.

method create

static create: (properties?: ITracesAndStats) => TracesAndStats;
  • Creates a new TracesAndStats instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    TracesAndStats instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => TracesAndStats;
  • Decodes a TracesAndStats message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    TracesAndStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
reader: $protobuf.Reader | Uint8Array
) => TracesAndStats;
  • Decodes a TracesAndStats message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    TracesAndStats

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: ITracesAndStats, writer?: any) => any;
  • Encodes the specified TracesAndStats message. Does not implicitly verify messages.

    Parameter message

    TracesAndStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: ITracesAndStats, writer?: any) => any;
  • Encodes the specified TracesAndStats message, length delimited. Does not implicitly verify messages.

    Parameter message

    TracesAndStats message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => TracesAndStats;
  • Creates a TracesAndStats message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    TracesAndStats

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this TracesAndStats to JSON.

    Returns

    JSON object

method toObject

static toObject: (
message: TracesAndStats,
options?: any
) => { [k: string]: any };
  • Creates a plain object from a TracesAndStats message. Also converts values to other types if specified.

    Parameter message

    TracesAndStats

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a TracesAndStats message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class Type

class Type implements IType {}
  • Represents a Type.

constructor

constructor(properties?: IType);
  • Constructs a new Type.

    Parameter properties

    Properties to set

property field

field: IField[];
  • Type field.

property name

name: string;
  • Type name.

method create

static create: (properties?: IType) => Type;
  • Creates a new Type instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    Type instance

method decode

static decode: (reader: $protobuf.Reader | Uint8Array, length?: number) => Type;
  • Decodes a Type message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    Type

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => Type;
  • Decodes a Type message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    Type

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: IType, writer?: any) => any;
  • Encodes the specified Type message. Does not implicitly verify messages.

    Parameter message

    Type message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: IType, writer?: any) => any;
  • Encodes the specified Type message, length delimited. Does not implicitly verify messages.

    Parameter message

    Type message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => Type;
  • Creates a Type message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    Type

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this Type to JSON.

    Returns

    JSON object

method toObject

static toObject: (message: Type, options?: any) => { [k: string]: any };
  • Creates a plain object from a Type message. Also converts values to other types if specified.

    Parameter message

    Type

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a Type message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

class TypeStat

class TypeStat implements ITypeStat {}
  • Represents a TypeStat.

constructor

constructor(properties?: ITypeStat);
  • Constructs a new TypeStat.

    Parameter properties

    Properties to set

property perFieldStat

perFieldStat: { [k: string]: IFieldStat };
  • TypeStat perFieldStat.

method create

static create: (properties?: ITypeStat) => TypeStat;
  • Creates a new TypeStat instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    TypeStat instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => TypeStat;
  • Decodes a TypeStat message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    TypeStat

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => TypeStat;
  • Decodes a TypeStat message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    TypeStat

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: ITypeStat, writer?: any) => any;
  • Encodes the specified TypeStat message. Does not implicitly verify messages.

    Parameter message

    TypeStat message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (message: ITypeStat, writer?: any) => any;
  • Encodes the specified TypeStat message, length delimited. Does not implicitly verify messages.

    Parameter message

    TypeStat message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => TypeStat;
  • Creates a TypeStat message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    TypeStat

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this TypeStat to JSON.

    Returns

    JSON object

method toObject

static toObject: (message: TypeStat, options?: any) => { [k: string]: any };
  • Creates a plain object from a TypeStat message. Also converts values to other types if specified.

    Parameter message

    TypeStat

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a TypeStat message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

Interfaces

interface IContextualizedQueryLatencyStats

interface IContextualizedQueryLatencyStats {}
  • Properties of a ContextualizedQueryLatencyStats.

property context

context?: IStatsContext | null;
  • ContextualizedQueryLatencyStats context

property queryLatencyStats

queryLatencyStats?: IQueryLatencyStats | null;
  • ContextualizedQueryLatencyStats queryLatencyStats

interface IContextualizedStats

interface IContextualizedStats {}
  • Properties of a ContextualizedStats.

property context

context?: IStatsContext | null;
  • ContextualizedStats context

property perTypeStat

perTypeStat?: { [k: string]: ITypeStat } | null;
  • ContextualizedStats perTypeStat

property queryLatencyStats

queryLatencyStats?: IQueryLatencyStats | null;
  • ContextualizedStats queryLatencyStats

interface IContextualizedTypeStats

interface IContextualizedTypeStats {}
  • Properties of a ContextualizedTypeStats.

property context

context?: IStatsContext | null;
  • ContextualizedTypeStats context

property perTypeStat

perTypeStat?: { [k: string]: ITypeStat } | null;
  • ContextualizedTypeStats perTypeStat

interface IField

interface IField {}
  • Properties of a Field.

property name

name?: string | null;
  • Field name

property returnType

returnType?: string | null;
  • Field returnType

interface IFieldStat

interface IFieldStat {}
  • Properties of a FieldStat.

property count

count?: number | null;
  • FieldStat count

property errorsCount

errorsCount?: number | null;
  • FieldStat errorsCount

property latencyCount

latencyCount?: number[] | null;
  • FieldStat latencyCount

property requestsWithErrorsCount

requestsWithErrorsCount?: number | null;
  • FieldStat requestsWithErrorsCount

property returnType

returnType?: string | null;
  • FieldStat returnType

interface IPathErrorStats

interface IPathErrorStats {}
  • Properties of a PathErrorStats.

property children

children?: { [k: string]: IPathErrorStats } | null;
  • PathErrorStats children

property errorsCount

errorsCount?: number | null;
  • PathErrorStats errorsCount

property requestsWithErrorsCount

requestsWithErrorsCount?: number | null;
  • PathErrorStats requestsWithErrorsCount

interface IQueryLatencyStats

interface IQueryLatencyStats {}
  • Properties of a QueryLatencyStats.

property cacheHits

cacheHits?: number | null;
  • QueryLatencyStats cacheHits

property cacheLatencyCount

cacheLatencyCount?: number[] | null;
  • QueryLatencyStats cacheLatencyCount

property forbiddenOperationCount

forbiddenOperationCount?: number | null;
  • QueryLatencyStats forbiddenOperationCount

property latencyCount

latencyCount?: number[] | null;
  • QueryLatencyStats latencyCount

property persistedQueryHits

persistedQueryHits?: number | null;
  • QueryLatencyStats persistedQueryHits

property persistedQueryMisses

persistedQueryMisses?: number | null;
  • QueryLatencyStats persistedQueryMisses

property privateCacheTtlCount

privateCacheTtlCount?: number[] | null;
  • QueryLatencyStats privateCacheTtlCount

property publicCacheTtlCount

publicCacheTtlCount?: number[] | null;
  • QueryLatencyStats publicCacheTtlCount

property registeredOperationCount

registeredOperationCount?: number | null;
  • QueryLatencyStats registeredOperationCount

property requestCount

requestCount?: number | null;
  • QueryLatencyStats requestCount

property requestsWithErrorsCount

requestsWithErrorsCount?: number | null;
  • QueryLatencyStats requestsWithErrorsCount

property rootErrorStats

rootErrorStats?: IPathErrorStats | null;
  • QueryLatencyStats rootErrorStats

interface IReport

interface IReport {}
  • Properties of a Report.

property endTime

endTime?: google.protobuf.ITimestamp | null;
  • Report endTime

property header

header?: IReportHeader | null;
  • Report header

property tracesPerQuery

tracesPerQuery?: { [k: string]: ITracesAndStats } | null;
  • Report tracesPerQuery

interface IReportHeader

interface IReportHeader {}
  • Properties of a ReportHeader.

property agentVersion

agentVersion?: string | null;
  • ReportHeader agentVersion

property executableSchemaId

executableSchemaId?: string | null;
  • ReportHeader executableSchemaId

property hostname

hostname?: string | null;
  • ReportHeader hostname

property runtimeVersion

runtimeVersion?: string | null;
  • ReportHeader runtimeVersion

property schemaTag

schemaTag?: string | null;
  • ReportHeader schemaTag

property serviceVersion

serviceVersion?: string | null;
  • ReportHeader serviceVersion

property uname

uname?: string | null;
  • ReportHeader uname

interface IStatsContext

interface IStatsContext {}
  • Properties of a StatsContext.

property clientName

clientName?: string | null;
  • StatsContext clientName

property clientReferenceId

clientReferenceId?: string | null;
  • StatsContext clientReferenceId

property clientVersion

clientVersion?: string | null;
  • StatsContext clientVersion

interface ITrace

interface ITrace {}
  • Properties of a Trace.

property cachePolicy

cachePolicy?: Trace.ICachePolicy | null;
  • Trace cachePolicy

property clientAddress

clientAddress?: string | null;
  • Trace clientAddress

property clientName

clientName?: string | null;
  • Trace clientName

property clientReferenceId

clientReferenceId?: string | null;
  • Trace clientReferenceId

property clientVersion

clientVersion?: string | null;
  • Trace clientVersion

property details

details?: Trace.IDetails | null;
  • Trace details

property durationNs

durationNs?: number | null;
  • Trace durationNs

property endTime

endTime?: google.protobuf.ITimestamp | null;
  • Trace endTime

property forbiddenOperation

forbiddenOperation?: boolean | null;
  • Trace forbiddenOperation

property fullQueryCacheHit

fullQueryCacheHit?: boolean | null;
  • Trace fullQueryCacheHit

property http

http?: Trace.IHTTP | null;
  • Trace http

property legacySignatureNeedsResigning

legacySignatureNeedsResigning?: string | null;
  • Trace legacySignatureNeedsResigning

property persistedQueryHit

persistedQueryHit?: boolean | null;
  • Trace persistedQueryHit

property persistedQueryRegister

persistedQueryRegister?: boolean | null;
  • Trace persistedQueryRegister

property queryPlan

queryPlan?: Trace.IQueryPlanNode | null;
  • Trace queryPlan

property registeredOperation

registeredOperation?: boolean | null;
  • Trace registeredOperation

property root

root?: Trace.INode | null;
  • Trace root

property signature

signature?: string | null;
  • Trace signature

property startTime

startTime?: google.protobuf.ITimestamp | null;
  • Trace startTime

interface ITracesAndStats

interface ITracesAndStats {}
  • Properties of a TracesAndStats.

property statsWithContext

statsWithContext?: IContextualizedStats[] | null;
  • TracesAndStats statsWithContext

property trace

trace?: ITrace[] | null;
  • TracesAndStats trace

interface IType

interface IType {}
  • Properties of a Type.

property field

field?: IField[] | null;
  • Type field

property name

name?: string | null;
  • Type name

interface ITypeStat

interface ITypeStat {}
  • Properties of a TypeStat.

property perFieldStat

perFieldStat?: { [k: string]: IFieldStat } | null;
  • TypeStat perFieldStat

Namespaces

namespace google

namespace google {}
  • Namespace google.

namespace google.protobuf

namespace google.protobuf {}
  • Namespace protobuf.

class Timestamp

class Timestamp implements ITimestamp {}
  • Represents a Timestamp.

constructor

constructor(properties?: ITimestamp);
  • Constructs a new Timestamp.

    Parameter properties

    Properties to set

property nanos

nanos: number;
  • Timestamp nanos.

property seconds

seconds: number;
  • Timestamp seconds.

method create

static create: (
properties?: google.protobuf.ITimestamp
) => google.protobuf.Timestamp;
  • Creates a new Timestamp instance using the specified properties.

    Parameter properties

    Properties to set

    Returns

    Timestamp instance

method decode

static decode: (
reader: $protobuf.Reader | Uint8Array,
length?: number
) => google.protobuf.Timestamp;
  • Decodes a Timestamp message from the specified reader or buffer.

    Parameter reader

    Reader or buffer to decode from

    Parameter length

    Message length if known beforehand

    Returns

    Timestamp

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
reader: $protobuf.Reader | Uint8Array
) => google.protobuf.Timestamp;
  • Decodes a Timestamp message from the specified reader or buffer, length delimited.

    Parameter reader

    Reader or buffer to decode from

    Returns

    Timestamp

    Throws

    {Error} If the payload is not a reader or valid buffer

    Throws

    {$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (message: google.protobuf.ITimestamp, writer?: any) => any;
  • Encodes the specified Timestamp message. Does not implicitly verify messages.

    Parameter message

    Timestamp message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method encodeDelimited

static encodeDelimited: (
message: google.protobuf.ITimestamp,
writer?: any
) => any;
  • Encodes the specified Timestamp message, length delimited. Does not implicitly verify messages.

    Parameter message

    Timestamp message or plain object to encode

    Parameter writer

    Writer to encode to

    Returns

    Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => google.protobuf.Timestamp;
  • Creates a Timestamp message from a plain object. Also converts values to their respective internal types.

    Parameter object

    Plain object

    Returns

    Timestamp

method toJSON

toJSON: () => { [k: string]: any };
  • Converts this Timestamp to JSON.

    Returns

    JSON object

method toObject

static toObject: (
message: google.protobuf.Timestamp,
options?: any
) => { [k: string]: any };
  • Creates a plain object from a Timestamp message. Also converts values to other types if specified.

    Parameter message

    Timestamp

    Parameter options

    Conversion options

    Returns

    Plain object

method verify

static verify: (message: { [k: string]: any }) => string | null;
  • Verifies a Timestamp message.

    Parameter message

    Plain object to verify

    Returns

    null if valid, otherwise the reason why it is not

interface ITimestamp

interface ITimestamp {}
  • Properties of a Timestamp.

property nanos

nanos?: number | null;
  • Timestamp nanos

property seconds

seconds?: number | null;
  • Timestamp seconds

namespace Trace

namespace Trace {}

    class CachePolicy

    class CachePolicy implements ICachePolicy {}
    • Represents a CachePolicy.

    constructor

    constructor(properties?: ICachePolicy);
    • Constructs a new CachePolicy.

      Parameter properties

      Properties to set

    property maxAgeNs

    maxAgeNs: number;
    • CachePolicy maxAgeNs.

    property scope

    scope: CachePolicy.Scope;
    • CachePolicy scope.

    method create

    static create: (properties?: Trace.ICachePolicy) => Trace.CachePolicy;
    • Creates a new CachePolicy instance using the specified properties.

      Parameter properties

      Properties to set

      Returns

      CachePolicy instance

    method decode

    static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
    ) => Trace.CachePolicy;
    • Decodes a CachePolicy message from the specified reader or buffer.

      Parameter reader

      Reader or buffer to decode from

      Parameter length

      Message length if known beforehand

      Returns

      CachePolicy

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method decodeDelimited

    static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
    ) => Trace.CachePolicy;
    • Decodes a CachePolicy message from the specified reader or buffer, length delimited.

      Parameter reader

      Reader or buffer to decode from

      Returns

      CachePolicy

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method encode

    static encode: (message: Trace.ICachePolicy, writer?: any) => any;
    • Encodes the specified CachePolicy message. Does not implicitly verify messages.

      Parameter message

      CachePolicy message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method encodeDelimited

    static encodeDelimited: (message: Trace.ICachePolicy, writer?: any) => any;
    • Encodes the specified CachePolicy message, length delimited. Does not implicitly verify messages.

      Parameter message

      CachePolicy message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method fromObject

    static fromObject: (object: { [k: string]: any }) => Trace.CachePolicy;
    • Creates a CachePolicy message from a plain object. Also converts values to their respective internal types.

      Parameter object

      Plain object

      Returns

      CachePolicy

    method toJSON

    toJSON: () => { [k: string]: any };
    • Converts this CachePolicy to JSON.

      Returns

      JSON object

    method toObject

    static toObject: (
    message: Trace.CachePolicy,
    options?: any
    ) => { [k: string]: any };
    • Creates a plain object from a CachePolicy message. Also converts values to other types if specified.

      Parameter message

      CachePolicy

      Parameter options

      Conversion options

      Returns

      Plain object

    method verify

    static verify: (message: { [k: string]: any }) => string | null;
    • Verifies a CachePolicy message.

      Parameter message

      Plain object to verify

      Returns

      null if valid, otherwise the reason why it is not

    class Details

    class Details implements IDetails {}
    • Represents a Details.

    constructor

    constructor(properties?: IDetails);
    • Constructs a new Details.

      Parameter properties

      Properties to set

    property deprecatedVariables

    deprecatedVariables: { [k: string]: Uint8Array };
    • Details deprecatedVariables.

    property operationName

    operationName: string;
    • Details operationName.

    property variablesJson

    variablesJson: { [k: string]: string };
    • Details variablesJson.

    method create

    static create: (properties?: Trace.IDetails) => Trace.Details;
    • Creates a new Details instance using the specified properties.

      Parameter properties

      Properties to set

      Returns

      Details instance

    method decode

    static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
    ) => Trace.Details;
    • Decodes a Details message from the specified reader or buffer.

      Parameter reader

      Reader or buffer to decode from

      Parameter length

      Message length if known beforehand

      Returns

      Details

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method decodeDelimited

    static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => Trace.Details;
    • Decodes a Details message from the specified reader or buffer, length delimited.

      Parameter reader

      Reader or buffer to decode from

      Returns

      Details

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method encode

    static encode: (message: Trace.IDetails, writer?: any) => any;
    • Encodes the specified Details message. Does not implicitly verify messages.

      Parameter message

      Details message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method encodeDelimited

    static encodeDelimited: (message: Trace.IDetails, writer?: any) => any;
    • Encodes the specified Details message, length delimited. Does not implicitly verify messages.

      Parameter message

      Details message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method fromObject

    static fromObject: (object: { [k: string]: any }) => Trace.Details;
    • Creates a Details message from a plain object. Also converts values to their respective internal types.

      Parameter object

      Plain object

      Returns

      Details

    method toJSON

    toJSON: () => { [k: string]: any };
    • Converts this Details to JSON.

      Returns

      JSON object

    method toObject

    static toObject: (message: Trace.Details, options?: any) => { [k: string]: any };
    • Creates a plain object from a Details message. Also converts values to other types if specified.

      Parameter message

      Details

      Parameter options

      Conversion options

      Returns

      Plain object

    method verify

    static verify: (message: { [k: string]: any }) => string | null;
    • Verifies a Details message.

      Parameter message

      Plain object to verify

      Returns

      null if valid, otherwise the reason why it is not

    class Error

    class Error implements IError {}
    • Represents an Error.

    constructor

    constructor(properties?: IError);
    • Constructs a new Error.

      Parameter properties

      Properties to set

    property json

    json: string;
    • Error json.

    property location

    location: ILocation[];
    • Error location.

    property message

    message: string;
    • Error message.

    property timeNs

    timeNs: number;
    • Error timeNs.

    method create

    static create: (properties?: Trace.IError) => Trace.Error;
    • Creates a new Error instance using the specified properties.

      Parameter properties

      Properties to set

      Returns

      Error instance

    method decode

    static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
    ) => Trace.Error;
    • Decodes an Error message from the specified reader or buffer.

      Parameter reader

      Reader or buffer to decode from

      Parameter length

      Message length if known beforehand

      Returns

      Error

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method decodeDelimited

    static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => Trace.Error;
    • Decodes an Error message from the specified reader or buffer, length delimited.

      Parameter reader

      Reader or buffer to decode from

      Returns

      Error

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method encode

    static encode: (message: Trace.IError, writer?: any) => any;
    • Encodes the specified Error message. Does not implicitly verify messages.

      Parameter message

      Error message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method encodeDelimited

    static encodeDelimited: (message: Trace.IError, writer?: any) => any;
    • Encodes the specified Error message, length delimited. Does not implicitly verify messages.

      Parameter message

      Error message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method fromObject

    static fromObject: (object: { [k: string]: any }) => Trace.Error;
    • Creates an Error message from a plain object. Also converts values to their respective internal types.

      Parameter object

      Plain object

      Returns

      Error

    method toJSON

    toJSON: () => { [k: string]: any };
    • Converts this Error to JSON.

      Returns

      JSON object

    method toObject

    static toObject: (message: Trace.Error, options?: any) => { [k: string]: any };
    • Creates a plain object from an Error message. Also converts values to other types if specified.

      Parameter message

      Error

      Parameter options

      Conversion options

      Returns

      Plain object

    method verify

    static verify: (message: { [k: string]: any }) => string | null;
    • Verifies an Error message.

      Parameter message

      Plain object to verify

      Returns

      null if valid, otherwise the reason why it is not

    class HTTP

    class HTTP implements IHTTP {}
    • Represents a HTTP.

    constructor

    constructor(properties?: IHTTP);
    • Constructs a new HTTP.

      Parameter properties

      Properties to set

    property host

    host: string;
    • HTTP host.

    property method

    method: HTTP.Method;
    • HTTP method.

    property path

    path: string;
    • HTTP path.

    property protocol

    protocol: string;
    • HTTP protocol.

    property requestHeaders

    requestHeaders: { [k: string]: HTTP.IValues };
    • HTTP requestHeaders.

    property responseHeaders

    responseHeaders: { [k: string]: HTTP.IValues };
    • HTTP responseHeaders.

    property secure

    secure: boolean;
    • HTTP secure.

    property statusCode

    statusCode: number;
    • HTTP statusCode.

    method create

    static create: (properties?: Trace.IHTTP) => Trace.HTTP;
    • Creates a new HTTP instance using the specified properties.

      Parameter properties

      Properties to set

      Returns

      HTTP instance

    method decode

    static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
    ) => Trace.HTTP;
    • Decodes a HTTP message from the specified reader or buffer.

      Parameter reader

      Reader or buffer to decode from

      Parameter length

      Message length if known beforehand

      Returns

      HTTP

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method decodeDelimited

    static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => Trace.HTTP;
    • Decodes a HTTP message from the specified reader or buffer, length delimited.

      Parameter reader

      Reader or buffer to decode from

      Returns

      HTTP

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method encode

    static encode: (message: Trace.IHTTP, writer?: any) => any;
    • Encodes the specified HTTP message. Does not implicitly verify messages.

      Parameter message

      HTTP message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method encodeDelimited

    static encodeDelimited: (message: Trace.IHTTP, writer?: any) => any;
    • Encodes the specified HTTP message, length delimited. Does not implicitly verify messages.

      Parameter message

      HTTP message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method fromObject

    static fromObject: (object: { [k: string]: any }) => Trace.HTTP;
    • Creates a HTTP message from a plain object. Also converts values to their respective internal types.

      Parameter object

      Plain object

      Returns

      HTTP

    method toJSON

    toJSON: () => { [k: string]: any };
    • Converts this HTTP to JSON.

      Returns

      JSON object

    method toObject

    static toObject: (message: Trace.HTTP, options?: any) => { [k: string]: any };
    • Creates a plain object from a HTTP message. Also converts values to other types if specified.

      Parameter message

      HTTP

      Parameter options

      Conversion options

      Returns

      Plain object

    method verify

    static verify: (message: { [k: string]: any }) => string | null;
    • Verifies a HTTP message.

      Parameter message

      Plain object to verify

      Returns

      null if valid, otherwise the reason why it is not

    class Location

    class Location implements ILocation {}
    • Represents a Location.

    constructor

    constructor(properties?: ILocation);
    • Constructs a new Location.

      Parameter properties

      Properties to set

    property column

    column: number;
    • Location column.

    property line

    line: number;
    • Location line.

    method create

    static create: (properties?: Trace.ILocation) => Trace.Location;
    • Creates a new Location instance using the specified properties.

      Parameter properties

      Properties to set

      Returns

      Location instance

    method decode

    static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
    ) => Trace.Location;
    • Decodes a Location message from the specified reader or buffer.

      Parameter reader

      Reader or buffer to decode from

      Parameter length

      Message length if known beforehand

      Returns

      Location

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method decodeDelimited

    static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
    ) => Trace.Location;
    • Decodes a Location message from the specified reader or buffer, length delimited.

      Parameter reader

      Reader or buffer to decode from

      Returns

      Location

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method encode

    static encode: (message: Trace.ILocation, writer?: any) => any;
    • Encodes the specified Location message. Does not implicitly verify messages.

      Parameter message

      Location message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method encodeDelimited

    static encodeDelimited: (message: Trace.ILocation, writer?: any) => any;
    • Encodes the specified Location message, length delimited. Does not implicitly verify messages.

      Parameter message

      Location message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method fromObject

    static fromObject: (object: { [k: string]: any }) => Trace.Location;
    • Creates a Location message from a plain object. Also converts values to their respective internal types.

      Parameter object

      Plain object

      Returns

      Location

    method toJSON

    toJSON: () => { [k: string]: any };
    • Converts this Location to JSON.

      Returns

      JSON object

    method toObject

    static toObject: (
    message: Trace.Location,
    options?: any
    ) => { [k: string]: any };
    • Creates a plain object from a Location message. Also converts values to other types if specified.

      Parameter message

      Location

      Parameter options

      Conversion options

      Returns

      Plain object

    method verify

    static verify: (message: { [k: string]: any }) => string | null;
    • Verifies a Location message.

      Parameter message

      Plain object to verify

      Returns

      null if valid, otherwise the reason why it is not

    class Node

    class Node implements INode {}
    • Represents a Node.

    constructor

    constructor(properties?: INode);
    • Constructs a new Node.

      Parameter properties

      Properties to set

    property cachePolicy

    cachePolicy?: ICachePolicy;
    • Node cachePolicy.

    property child

    child: INode[];
    • Node child.

    property endTime

    endTime: number;
    • Node endTime.

    property error

    error: IError[];
    • Node error.

    property id

    id?: 'responseName' | 'index';
    • Node id.

    property index

    index: number;
    • Node index.

    property originalFieldName

    originalFieldName: string;
    • Node originalFieldName.

    property parentType

    parentType: string;
    • Node parentType.

    property responseName

    responseName: string;
    • Node responseName.

    property startTime

    startTime: number;
    • Node startTime.

    property type

    type: string;
    • Node type.

    method create

    static create: (properties?: Trace.INode) => Trace.Node;
    • Creates a new Node instance using the specified properties.

      Parameter properties

      Properties to set

      Returns

      Node instance

    method decode

    static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
    ) => Trace.Node;
    • Decodes a Node message from the specified reader or buffer.

      Parameter reader

      Reader or buffer to decode from

      Parameter length

      Message length if known beforehand

      Returns

      Node

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method decodeDelimited

    static decodeDelimited: (reader: $protobuf.Reader | Uint8Array) => Trace.Node;
    • Decodes a Node message from the specified reader or buffer, length delimited.

      Parameter reader

      Reader or buffer to decode from

      Returns

      Node

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method encode

    static encode: (message: Trace.INode, writer?: any) => any;
    • Encodes the specified Node message. Does not implicitly verify messages.

      Parameter message

      Node message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method encodeDelimited

    static encodeDelimited: (message: Trace.INode, writer?: any) => any;
    • Encodes the specified Node message, length delimited. Does not implicitly verify messages.

      Parameter message

      Node message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method fromObject

    static fromObject: (object: { [k: string]: any }) => Trace.Node;
    • Creates a Node message from a plain object. Also converts values to their respective internal types.

      Parameter object

      Plain object

      Returns

      Node

    method toJSON

    toJSON: () => { [k: string]: any };
    • Converts this Node to JSON.

      Returns

      JSON object

    method toObject

    static toObject: (message: Trace.Node, options?: any) => { [k: string]: any };
    • Creates a plain object from a Node message. Also converts values to other types if specified.

      Parameter message

      Node

      Parameter options

      Conversion options

      Returns

      Plain object

    method verify

    static verify: (message: { [k: string]: any }) => string | null;
    • Verifies a Node message.

      Parameter message

      Plain object to verify

      Returns

      null if valid, otherwise the reason why it is not

    class QueryPlanNode

    class QueryPlanNode implements IQueryPlanNode {}
    • Represents a QueryPlanNode.

    constructor

    constructor(properties?: IQueryPlanNode);
    • Constructs a new QueryPlanNode.

      Parameter properties

      Properties to set

    property fetch

    fetch?: QueryPlanNode.IFetchNode;
    • QueryPlanNode fetch.

    property flatten

    flatten?: QueryPlanNode.IFlattenNode;
    • QueryPlanNode flatten.

    property node

    node?: 'sequence' | 'parallel' | 'fetch' | 'flatten';
    • QueryPlanNode node.

    property parallel

    parallel?: QueryPlanNode.IParallelNode;
    • QueryPlanNode parallel.

    property sequence

    sequence?: QueryPlanNode.ISequenceNode;
    • QueryPlanNode sequence.

    method create

    static create: (properties?: Trace.IQueryPlanNode) => Trace.QueryPlanNode;
    • Creates a new QueryPlanNode instance using the specified properties.

      Parameter properties

      Properties to set

      Returns

      QueryPlanNode instance

    method decode

    static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
    ) => Trace.QueryPlanNode;
    • Decodes a QueryPlanNode message from the specified reader or buffer.

      Parameter reader

      Reader or buffer to decode from

      Parameter length

      Message length if known beforehand

      Returns

      QueryPlanNode

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method decodeDelimited

    static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
    ) => Trace.QueryPlanNode;
    • Decodes a QueryPlanNode message from the specified reader or buffer, length delimited.

      Parameter reader

      Reader or buffer to decode from

      Returns

      QueryPlanNode

      Throws

      {Error} If the payload is not a reader or valid buffer

      Throws

      {$protobuf.util.ProtocolError} If required fields are missing

    method encode

    static encode: (message: Trace.IQueryPlanNode, writer?: any) => any;
    • Encodes the specified QueryPlanNode message. Does not implicitly verify messages.

      Parameter message

      QueryPlanNode message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method encodeDelimited

    static encodeDelimited: (message: Trace.IQueryPlanNode, writer?: any) => any;
    • Encodes the specified QueryPlanNode message, length delimited. Does not implicitly verify messages.

      Parameter message

      QueryPlanNode message or plain object to encode

      Parameter writer

      Writer to encode to

      Returns

      Writer

    method fromObject

    static fromObject: (object: { [k: string]: any }) => Trace.QueryPlanNode;
    • Creates a QueryPlanNode message from a plain object. Also converts values to their respective internal types.

      Parameter object

      Plain object

      Returns

      QueryPlanNode

    method toJSON

    toJSON: () => { [k: string]: any };
    • Converts this QueryPlanNode to JSON.

      Returns

      JSON object

    method toObject

    static toObject: (
    message: Trace.QueryPlanNode,
    options?: any
    ) => { [k: string]: any };
    • Creates a plain object from a QueryPlanNode message. Also converts values to other types if specified.

      Parameter message

      QueryPlanNode

      Parameter options

      Conversion options

      Returns

      Plain object

    method verify

    static verify: (message: { [k: string]: any }) => string | null;
    • Verifies a QueryPlanNode message.

      Parameter message

      Plain object to verify

      Returns

      null if valid, otherwise the reason why it is not

    interface ICachePolicy

    interface ICachePolicy {}
    • Properties of a CachePolicy.

    property maxAgeNs

    maxAgeNs?: number | null;
    • CachePolicy maxAgeNs

    property scope

    scope?: Trace.CachePolicy.Scope | null;
    • CachePolicy scope

    interface IDetails

    interface IDetails {}
    • Properties of a Details.

    property deprecatedVariables

    deprecatedVariables?: { [k: string]: Uint8Array } | null;
    • Details deprecatedVariables

    property operationName

    operationName?: string | null;
    • Details operationName

    property variablesJson

    variablesJson?: { [k: string]: string } | null;
    • Details variablesJson

    interface IError

    interface IError {}
    • Properties of an Error.

    property json

    json?: string | null;
    • Error json

    property location

    location?: Trace.ILocation[] | null;
    • Error location

    property message

    message?: string | null;
    • Error message

    property timeNs

    timeNs?: number | null;
    • Error timeNs

    interface IHTTP

    interface IHTTP {}
    • Properties of a HTTP.

    property host

    host?: string | null;
    • HTTP host

    property method

    method?: Trace.HTTP.Method | null;
    • HTTP method

    property path

    path?: string | null;
    • HTTP path

    property protocol

    protocol?: string | null;
    • HTTP protocol

    property requestHeaders

    requestHeaders?: { [k: string]: Trace.HTTP.IValues } | null;
    • HTTP requestHeaders

    property responseHeaders

    responseHeaders?: { [k: string]: Trace.HTTP.IValues } | null;
    • HTTP responseHeaders

    property secure

    secure?: boolean | null;
    • HTTP secure

    property statusCode

    statusCode?: number | null;
    • HTTP statusCode

    interface ILocation

    interface ILocation {}
    • Properties of a Location.

    property column

    column?: number | null;
    • Location column

    property line

    line?: number | null;
    • Location line

    interface INode

    interface INode {}
    • Properties of a Node.

    property cachePolicy

    cachePolicy?: Trace.ICachePolicy | null;
    • Node cachePolicy

    property child

    child?: Trace.INode[] | null;
    • Node child

    property endTime

    endTime?: number | null;
    • Node endTime

    property error

    error?: Trace.IError[] | null;
    • Node error

    property index

    index?: number | null;
    • Node index

    property originalFieldName

    originalFieldName?: string | null;
    • Node originalFieldName

    property parentType

    parentType?: string | null;
    • Node parentType

    property responseName

    responseName?: string | null;
    • Node responseName

    property startTime

    startTime?: number | null;
    • Node startTime

    property type

    type?: string | null;
    • Node type

    interface IQueryPlanNode

    interface IQueryPlanNode {}
    • Properties of a QueryPlanNode.

    property fetch

    fetch?: Trace.QueryPlanNode.IFetchNode | null;
    • QueryPlanNode fetch

    property flatten

    flatten?: Trace.QueryPlanNode.IFlattenNode | null;
    • QueryPlanNode flatten

    property parallel

    parallel?: Trace.QueryPlanNode.IParallelNode | null;
    • QueryPlanNode parallel

    property sequence

    sequence?: Trace.QueryPlanNode.ISequenceNode | null;
    • QueryPlanNode sequence

    namespace Trace.CachePolicy

    namespace Trace.CachePolicy {}

      enum Scope

      enum Scope {
      UNKNOWN = 0,
      PUBLIC = 1,
      PRIVATE = 2,
      }
      • Scope enum.

      member PRIVATE

      PRIVATE = 2

        member PUBLIC

        PUBLIC = 1

          member UNKNOWN

          UNKNOWN = 0

            namespace Trace.HTTP

            namespace Trace.HTTP {}

              class Values

              class Values implements IValues {}
              • Represents a Values.

              constructor

              constructor(properties?: IValues);
              • Constructs a new Values.

                Parameter properties

                Properties to set

              property value

              value: string[];
              • Values value.

              method create

              static create: (properties?: Trace.HTTP.IValues) => Trace.HTTP.Values;
              • Creates a new Values instance using the specified properties.

                Parameter properties

                Properties to set

                Returns

                Values instance

              method decode

              static decode: (
              reader: $protobuf.Reader | Uint8Array,
              length?: number
              ) => Trace.HTTP.Values;
              • Decodes a Values message from the specified reader or buffer.

                Parameter reader

                Reader or buffer to decode from

                Parameter length

                Message length if known beforehand

                Returns

                Values

                Throws

                {Error} If the payload is not a reader or valid buffer

                Throws

                {$protobuf.util.ProtocolError} If required fields are missing

              method decodeDelimited

              static decodeDelimited: (
              reader: $protobuf.Reader | Uint8Array
              ) => Trace.HTTP.Values;
              • Decodes a Values message from the specified reader or buffer, length delimited.

                Parameter reader

                Reader or buffer to decode from

                Returns

                Values

                Throws

                {Error} If the payload is not a reader or valid buffer

                Throws

                {$protobuf.util.ProtocolError} If required fields are missing

              method encode

              static encode: (message: Trace.HTTP.IValues, writer?: any) => any;
              • Encodes the specified Values message. Does not implicitly verify messages.

                Parameter message

                Values message or plain object to encode

                Parameter writer

                Writer to encode to

                Returns

                Writer

              method encodeDelimited

              static encodeDelimited: (message: Trace.HTTP.IValues, writer?: any) => any;
              • Encodes the specified Values message, length delimited. Does not implicitly verify messages.

                Parameter message

                Values message or plain object to encode

                Parameter writer

                Writer to encode to

                Returns

                Writer

              method fromObject

              static fromObject: (object: { [k: string]: any }) => Trace.HTTP.Values;
              • Creates a Values message from a plain object. Also converts values to their respective internal types.

                Parameter object

                Plain object

                Returns

                Values

              method toJSON

              toJSON: () => { [k: string]: any };
              • Converts this Values to JSON.

                Returns

                JSON object

              method toObject

              static toObject: (
              message: Trace.HTTP.Values,
              options?: any
              ) => { [k: string]: any };
              • Creates a plain object from a Values message. Also converts values to other types if specified.

                Parameter message

                Values

                Parameter options

                Conversion options

                Returns

                Plain object

              method verify

              static verify: (message: { [k: string]: any }) => string | null;
              • Verifies a Values message.

                Parameter message

                Plain object to verify

                Returns

                null if valid, otherwise the reason why it is not

              interface IValues

              interface IValues {}
              • Properties of a Values.

              property value

              value?: string[] | null;
              • Values value

              enum Method

              enum Method {
              UNKNOWN = 0,
              OPTIONS = 1,
              GET = 2,
              HEAD = 3,
              POST = 4,
              PUT = 5,
              DELETE = 6,
              TRACE = 7,
              CONNECT = 8,
              PATCH = 9,
              }
              • Method enum.

              member CONNECT

              CONNECT = 8

                member DELETE

                DELETE = 6

                  member GET

                  GET = 2

                    member HEAD

                    HEAD = 3

                      member OPTIONS

                      OPTIONS = 1

                        member PATCH

                        PATCH = 9

                          member POST

                          POST = 4

                            member PUT

                            PUT = 5

                              member TRACE

                              TRACE = 7

                                member UNKNOWN

                                UNKNOWN = 0

                                  namespace Trace.QueryPlanNode

                                  namespace Trace</