Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceOptions

Options used to register service.

Hierarchy

  • ServiceOptions

Index

Constructors

Methods

Constructors

constructor

  • Returns ServiceOptions

  • Parameters

    Returns ServiceOptions

Methods

getAddress

  • getAddress(): string

  • Set service address

    Returns string

getCheckListOptions

  • Set checks options of service

    Returns CheckOptions[]

getCheckOptions

  • Set check options of service

    Returns CheckOptions

getId

  • getId(): string

  • Set the ID of session

    Returns string

getMeta

  • getMeta(): {}

  • Specifies arbitrary KV metadata linked to the service instance.

    Returns {}

    • [key: string]: string

getName

  • getName(): string

  • Set service name

    Returns string

getPort

  • getPort(): number

  • Set service port

    Returns number

getTags

  • getTags(): string[]

  • Set list of tags associated with service

    Returns string[]

setAddress

  • Set service address

    Parameters

    • address: string

    Returns ServiceOptions

setCheckListOptions

  • Set checks options of service

    Parameters

    Returns ServiceOptions

setCheckOptions

  • Set check options of service

    Parameters

    Returns ServiceOptions

setId

  • Set the ID of session

    Parameters

    • id: string

    Returns ServiceOptions

setMeta

  • Specifies arbitrary KV metadata linked to the service instance.

    Parameters

    • meta: {}
      • [key: string]: string

    Returns ServiceOptions

setName

  • Set service name

    Parameters

    • name: string

    Returns ServiceOptions

setPort

  • Set service port

    Parameters

    • port: number

    Returns ServiceOptions

setTags

  • Set list of tags associated with service

    Parameters

    • tags: string[]

    Returns ServiceOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc