Class Record

Describes a service. The record is the only piece of information shared between consumer and provider. It should contains enough metadata to let consumer find the service they want.

Hierarchy

Record

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:89
Returns Record
- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:91
Parameters
- obj: Record | {}
Returns Record

Methods

getLocation

getLocation(): {}

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:99
Sets the json object describing the location of the service. By convention, this json object should contain the Record entry.

Returns {}
- [key: string]: any

getMetadata

getMetadata(): {}

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:110
Gets the metadata attached to the record.

Returns {}
- [key: string]: any

getName

getName(): string

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:120
Sets the name of the service. It can reflect the service name of the name of the provider.

Returns string

getRegistration

getRegistration(): string

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:130
Sets the registration id. This method is called when the service is published.

Returns string

getStatus

getStatus(): Status

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:141
Sets the status of the service. When published, the status is set to. When withdrawn, the status is set to .

Returns Status

getType

getType(): string

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:152
Sets the type of service.

Returns string

setLocation

setLocation(location: {}): Record

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:105
Sets the json object describing the location of the service. By convention, this json object should contain the Record entry.

Parameters
- location: {}
  - [key: string]: any
Returns Record

setMetadata

setMetadata(metadata: {}): Record

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:115
Gets the metadata attached to the record.

Parameters
- metadata: {}
  - [key: string]: any
Returns Record

setName

setName(name: string): Record

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:125
Sets the name of the service. It can reflect the service name of the name of the provider.

Parameters
- name: string
Returns Record

setRegistration

setRegistration(registration: string): Record

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:135
Sets the registration id. This method is called when the service is published.

Parameters
- registration: string
Returns Record

setStatus

setStatus(status: Status): Record

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:147
Sets the status of the service. When published, the status is set to. When withdrawn, the status is set to .

Parameters
- status: Status
Returns Record

setType

setType(type: string): Record

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:157
Sets the type of service.

Parameters
- type: string
Returns Record

toJson

toJson(): {}

- Defined in io.vertx/vertx-service-discovery/target/npm/options.d.ts:160
Returns {}
- [key: string]: any

Generated using TypeDoc