Class EpAsyncApiMessageDocument

Hierarchy

EpAsyncApiMessageDocument

Index

Constructors

Properties

asyncApiMessage asyncApiMessageKey epAsyncApiChannelDocument epAsyncApiDocument schemaFormatType MissingMessagePayloadSchemaIssue

Methods

determineSchemaFormatType extractMessageKey getEpCustomAttributeValue getEpStateId getMessageDescription getMessageDisplayName getMessageEpApplicationDomainName getMessageEpIsShared getMessageName getMessageNameAsFilePath getMessage_X_EpSharedFlag getOriginalPayloadSchema getPayloadSchema getPayloadSchemaAsString getPayloadSchemaDescription getPayloadSchemaDisplayName getPayloadSchemaEpApplicationDomainName getPayloadSchemaEpCustomAttributeValue getPayloadSchemaEpIsShared getPayloadSchemaEpStateId getPayloadSchemaId getPayloadSchemaName getPayloadSchemaVersionId getPayloadSchema_X_EpSchemaId getPayloadSchema_X_EpSchemaVersionId getPayloadSchema_X_EpSharedFlag getPayloadSchema_X_EpStateId getPayloadSchema_X_EpStateName getSchemaAsSanitizedJson getSchemaFileName getSchemaFormatType get_X_EpStateId get_X_EpStateName validate validate_BestPractices

Constructors

constructor

new EpAsyncApiMessageDocument(epAsyncApiDocument: EpAsyncApiDocument, epAsyncApiChannelDocument: EpAsyncApiChannelDocument, asyncApiMessage: Message): EpAsyncApiMessageDocument
Parameters
- epAsyncApiDocument: EpAsyncApiDocument
- epAsyncApiChannelDocument: EpAsyncApiChannelDocument
- asyncApiMessage: Message
Returns EpAsyncApiMessageDocument
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:79

Properties

asyncApiMessage

asyncApiMessage: Message

`Private` asyncApiMessageKey

asyncApiMessageKey: string

`Private` epAsyncApiChannelDocument

epAsyncApiChannelDocument: EpAsyncApiChannelDocument

epAsyncApiDocument

epAsyncApiDocument: EpAsyncApiDocument

`Private` schemaFormatType

schemaFormatType: E_EpAsyncApiSchemaFormatType

`Static` `Readonly` MissingMessagePayloadSchemaIssue

MissingMessagePayloadSchemaIssue: "Missing message payload schema." = "Missing message payload schema."

Methods

`Private` determineSchemaFormatType

determineSchemaFormatType(): E_EpAsyncApiSchemaFormatType
Returns E_EpAsyncApiSchemaFormatType
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:40

`Private` extractMessageKey

extractMessageKey(asyncApiMessage: Message): string
Parameters
- asyncApiMessage: Message
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:58

getEpCustomAttributeValue

getEpCustomAttributeValue(name: string): undefined | string
Parameters
- name: string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:140

getEpStateId

getEpStateId(defaultValue: EpAsyncApiStateIds): EpAsyncApiStateIds
Parameters
- defaultValue: EpAsyncApiStateIds
Returns EpAsyncApiStateIds
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:132

getMessageDescription

getMessageDescription(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:169

getMessageDisplayName

getMessageDisplayName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:146

getMessageEpApplicationDomainName

getMessageEpApplicationDomainName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:154

getMessageEpIsShared

getMessageEpIsShared(defaultValue: boolean): boolean
Parameters
- defaultValue: boolean
Returns boolean
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:111

getMessageName

getMessageName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:144

getMessageNameAsFilePath

getMessageNameAsFilePath(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:177

`Private` getMessage_X_EpSharedFlag

getMessage_X_EpSharedFlag(): undefined | boolean
Returns undefined | boolean
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:106

getOriginalPayloadSchema

getOriginalPayloadSchema(): any
Returns any
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:341

getPayloadSchema

getPayloadSchema(): any
Returns any
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:313

getPayloadSchemaAsString

getPayloadSchemaAsString(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:343

getPayloadSchemaDescription

getPayloadSchemaDescription(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:298

getPayloadSchemaDisplayName

getPayloadSchemaDisplayName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:270

getPayloadSchemaEpApplicationDomainName

getPayloadSchemaEpApplicationDomainName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:279

getPayloadSchemaEpCustomAttributeValue

getPayloadSchemaEpCustomAttributeValue(name: string): undefined | string
Parameters
- name: string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:246

getPayloadSchemaEpIsShared

getPayloadSchemaEpIsShared(defaultValue: boolean): boolean
Parameters
- defaultValue: boolean
Returns boolean
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:211

getPayloadSchemaEpStateId

getPayloadSchemaEpStateId(defaultValue: EpAsyncApiStateIds): EpAsyncApiStateIds
Parameters
- defaultValue: EpAsyncApiStateIds
Returns EpAsyncApiStateIds
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:238

getPayloadSchemaId

getPayloadSchemaId(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:188

getPayloadSchemaName

getPayloadSchemaName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:255

getPayloadSchemaVersionId

getPayloadSchemaVersionId(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:199

`Private` getPayloadSchema_X_EpSchemaId

getPayloadSchema_X_EpSchemaId(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:181

`Private` getPayloadSchema_X_EpSchemaVersionId

getPayloadSchema_X_EpSchemaVersionId(): undefined | string
Returns undefined | string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:192

`Private` getPayloadSchema_X_EpSharedFlag

getPayloadSchema_X_EpSharedFlag(): undefined | boolean
Returns undefined | boolean
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:203

`Private` getPayloadSchema_X_EpStateId

getPayloadSchema_X_EpStateId(): undefined | EpAsyncApiStateIds
Returns undefined | EpAsyncApiStateIds
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:217

`Private` getPayloadSchema_X_EpStateName

getPayloadSchema_X_EpStateName(): undefined | EpAsyncApiStateNames
Returns undefined | EpAsyncApiStateNames
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:227

getSchemaAsSanitizedJson

getSchemaAsSanitizedJson(): any
Returns any
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:331

getSchemaFileName

getSchemaFileName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:309

getSchemaFormatType

getSchemaFormatType(): E_EpAsyncApiSchemaFormatType
Returns E_EpAsyncApiSchemaFormatType
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:253

`Private` get_X_EpStateId

get_X_EpStateId(): undefined | EpAsyncApiStateIds
Returns undefined | EpAsyncApiStateIds
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:117

`Private` get_X_EpStateName

get_X_EpStateName(): undefined | EpAsyncApiStateNames
Returns undefined | EpAsyncApiStateNames
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:124

validate

validate(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:87

validate_BestPractices

validate_BestPractices(): void
Returns void
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiMessageDocument.ts:91