Class Check

Holds check properties

Hierarchy

Check

Index

Constructors

constructor

Methods

Constructors

constructor

new Check(): Check
new Check(obj: Check | {}): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:114
Returns Check
- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:116
Parameters
- obj: Check | {}
Returns Check

Methods

getId

getId(): string

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:123
Set the ID of check

Returns string

getName

getName(): string

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:133
Set the name of check

Returns string

getNodeName

getNodeName(): string

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:143
Set the name of node

Returns string

getNotes

getNotes(): string

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:153
Set the human-readable note of check

Returns string

getOutput

getOutput(): string

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:163
Set the output of check

Returns string

getServiceId

getServiceId(): string

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:173
Set the ID of service with which this check associated

Returns string

getServiceName

getServiceName(): string

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:183
Set the name of service with which this check associated

Returns string

getStatus

getStatus(): CheckStatus

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:193
Set the status of check

Returns CheckStatus

setId

setId(id: string): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:128
Set the ID of check

Parameters
- id: string
Returns Check

setName

setName(name: string): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:138
Set the name of check

Parameters
- name: string
Returns Check

setNodeName

setNodeName(nodeName: string): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:148
Set the name of node

Parameters
- nodeName: string
Returns Check

setNotes

setNotes(notes: string): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:158
Set the human-readable note of check

Parameters
- notes: string
Returns Check

setOutput

setOutput(output: string): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:168
Set the output of check

Parameters
- output: string
Returns Check

setServiceId

setServiceId(serviceId: string): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:178
Set the ID of service with which this check associated

Parameters
- serviceId: string
Returns Check

setServiceName

setServiceName(serviceName: string): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:188
Set the name of service with which this check associated

Parameters
- serviceName: string
Returns Check

setStatus

setStatus(status: CheckStatus): Check

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:198
Set the status of check

Parameters
- status: CheckStatus
Returns Check

toJson

toJson(): {}

- Defined in io.vertx/vertx-consul-client/target/npm/options.d.ts:201
Returns {}
- [key: string]: any

Generated using TypeDoc