Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MaintenanceOptions

Options used to placing a given service into "maintenance mode". During maintenance mode, the service will be marked as unavailable and will not be present in DNS or API queries. Maintenance mode is persistent and will be automatically restored on agent restart.

Hierarchy

  • MaintenanceOptions

Index

Constructors

constructor

Methods

getId

  • getId(): string
  • Set the ID of service. This field is required.

    Returns string

getReason

  • getReason(): string
  • Set the reason message. If provided, its value should be a text string explaining the reason for placing the service into maintenance mode. This is simply to aid human operators.

    Returns string

isEnable

  • isEnable(): boolean
  • Set maintenance mode to enabled: true to enter maintenance mode or false to resume normal operation. This flag is required.

    Returns boolean

setEnable

  • Set maintenance mode to enabled: true to enter maintenance mode or false to resume normal operation. This flag is required.

    Parameters

    • enable: boolean

    Returns MaintenanceOptions

setId

  • Set the ID of service. This field is required.

    Parameters

    • id: string

    Returns MaintenanceOptions

setReason

  • Set the reason message. If provided, its value should be a text string explaining the reason for placing the service into maintenance mode. This is simply to aid human operators.

    Parameters

    • reason: string

    Returns MaintenanceOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc