Class RelayComponent

constructor

• new RelayComponent(
      name: string,
      cluster: string,
      namespace: string,
      consensusNodeAliases?: NodeAliases,
  ): RelayComponent

• Parameters

  • name: string

    to distinguish components.
  • cluster: string

    in which the component is deployed.
  • namespace: string

    associated with the component.
  • consensusNodeAliases: NodeAliases = []

    list node aliases

  Returns RelayComponent

ReadonlyconsensusNodeAliases

toObject

• toObject(): IRelayComponent

• Converts the class instance to a plain object.

  Returns IRelayComponent

  the plain object representation of the class.

validate

• validate(): void

• Validates all properties of the class and throws if data is invalid

  Returns void

StaticfromObject

• fromObject(component: IRelayComponent): RelayComponent

• Handles creating instance of the class from plain object.

  Parameters

  • component: IRelayComponent

  Returns RelayComponent