Class EpAsyncApiChannelParameterDocument

Hierarchy

EpAsyncApiChannelParameterDocument

Index

Constructors

Properties

asyncApiChannelParameter channelParameterName epAsyncApiDocument

Methods

getAsyncApiChannelParameter getDescription getDisplayName getEpApplicationDomainName getEpCustomAttributeValue getEpIsShared getEpStateId getParameterEnumValueList get_X_EpSharedFlag get_X_EpStateId get_X_EpStateName validate validate_BestPractices

Constructors

constructor

new EpAsyncApiChannelParameterDocument(epAsyncApiDocument: EpAsyncApiDocument, channelParameterName: string, asyncApiChannelParameter: ChannelParameter): EpAsyncApiChannelParameterDocument
Parameters
- epAsyncApiDocument: EpAsyncApiDocument
- channelParameterName: string
- asyncApiChannelParameter: ChannelParameter
Returns EpAsyncApiChannelParameterDocument
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelParameterDocument.ts:20

Properties

`Private` asyncApiChannelParameter

asyncApiChannelParameter: ChannelParameter

`Private` channelParameterName

channelParameterName: string

epAsyncApiDocument

epAsyncApiDocument: EpAsyncApiDocument

Methods

getAsyncApiChannelParameter

getAsyncApiChannelParameter(): ChannelParameter
Returns ChannelParameter
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelParameterDocument.ts:34

getDescription

getDescription(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelParameterDocument.ts:36

getDisplayName

getDisplayName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelParameterDocument.ts:42

getEpApplicationDomainName

getEpApplicationDomainName(): string
Returns string
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelParameterDocument.ts:57

getEpCustomAttributeValue

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

getEpIsShared

getEpIsShared(defaultValue: boolean): boolean
Parameters
- defaultValue: boolean
Returns boolean
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelParameterDocument.ts:82

getEpStateId

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

getParameterEnumValueList

getParameterEnumValueList(): string[]
Returns string[]
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelParameterDocument.ts:65

`Private` get_X_EpSharedFlag

get_X_EpSharedFlag(): undefined | boolean
Returns undefined | boolean
- Defined in packages/ep-asyncapi/src/documents/EpAsyncApiChannelParameterDocument.ts:72

`Private` get_X_EpStateId

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

`Private` get_X_EpStateName

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

validate

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

validate_BestPractices

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