HttpEndpoint | @vertx/service-discovery

for HTTP endpoint (REST api). Consumers receive a HTTP client configured with the host and port of the endpoint.

Hierarchy

HttpEndpoint

Index

Properties

TYPE
UNKNOWN

Methods

Properties

Static Readonly TYPE

TYPE: string

Static Readonly UNKNOWN

UNKNOWN: string

Unknown type.

Methods

Static createRecord

createRecord(name: string, host: string, port: number, root: string, metadata: {}): Record
createRecord(name: string, ssl: boolean, host: string, port: number, root: string, metadata: {}): Record
createRecord(name: string, host: string, port: number, root: string): Record
createRecord(name: string, host: string): Record

- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:100
Convenient method to create a record for a HTTP endpoint.

Parameters
- name: string
- host: string
- port: number
- root: string
- metadata: {}
  - [key: string]: any
Returns Record
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:106
Same as {@link HttpEndpoint#createRecord} but let you configure whether or not the service is using https.

Parameters
- name: string
- ssl: boolean
- host: string
- port: number
- root: string
- metadata: {}
  - [key: string]: any
Returns Record
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:111
Same as {@link HttpEndpoint#createRecord} but without metadata.

Parameters
- name: string
- host: string
- port: number
- root: string
Returns Record
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:117
Same as {@link HttpEndpoint#createRecord} but without metadata, using the port 80 and using "/" as root.

Parameters
- name: string
- host: string
Returns Record

Static getClient

getClient(discovery: ServiceDiscovery, filter: {}): PromiseLike<HttpClient>
getClient(discovery: ServiceDiscovery, filter: {}, resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>): void
getClient(discovery: ServiceDiscovery, filter: {}, conf: {}): PromiseLike<HttpClient>
getClient(discovery: ServiceDiscovery, filter: {}, conf: {}, resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>): void
getClient(discovery: ServiceDiscovery, filter: (arg: Record) => boolean): PromiseLike<HttpClient>
getClient(discovery: ServiceDiscovery, filter: (arg: Record) => boolean, resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>): void
getClient(discovery: ServiceDiscovery, filter: (arg: Record) => boolean, conf: {}): PromiseLike<HttpClient>
getClient(discovery: ServiceDiscovery, filter: (arg: Record) => boolean, conf: {}, resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>): void

- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:123
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails.

Parameters
- discovery: ServiceDiscovery
- filter: {}
  - [key: string]: any
Returns PromiseLike<HttpClient>
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:129
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails.

Parameters
- discovery: ServiceDiscovery
- filter: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>
Returns void
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:148
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client

Parameters
- discovery: ServiceDiscovery
- filter: {}
  - [key: string]: any
- conf: {}
  - [key: string]: any
Returns PromiseLike<HttpClient>
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:155
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client

Parameters
- discovery: ServiceDiscovery
- filter: {}
  - [key: string]: any
- conf: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>
Returns void
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:175
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails.

Parameters
- discovery: ServiceDiscovery
- filter: (arg: Record) => boolean
  - - (arg: Record): boolean
    - Parameters
      - arg: Record
      Returns boolean
Returns PromiseLike<HttpClient>
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:181
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails.

Parameters
- discovery: ServiceDiscovery
- filter: (arg: Record) => boolean
  - - (arg: Record): boolean
    - Parameters
      - arg: Record
      Returns boolean
- resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>
Returns void
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:200
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client.

Parameters
- discovery: ServiceDiscovery
- filter: (arg: Record) => boolean
  - - (arg: Record): boolean
    - Parameters
      - arg: Record
      Returns boolean
- conf: {}
  - [key: string]: any
Returns PromiseLike<HttpClient>
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:207
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client.

Parameters
- discovery: ServiceDiscovery
- filter: (arg: Record) => boolean
  - - (arg: Record): boolean
    - Parameters
      - arg: Record
      Returns boolean
- conf: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>
Returns void

Static getWebClient

getWebClient(discovery: ServiceDiscovery, filter: {}): PromiseLike<WebClient>
getWebClient(discovery: ServiceDiscovery, filter: {}, resultHandler: ((res: AsyncResult<WebClient>) => void) | Handler<AsyncResult<WebClient>>): void
getWebClient(discovery: ServiceDiscovery, filter: {}, conf: {}): PromiseLike<WebClient>
getWebClient(discovery: ServiceDiscovery, filter: {}, conf: {}, resultHandler: ((res: AsyncResult<WebClient>) => void) | Handler<AsyncResult<WebClient>>): void
getWebClient(discovery: ServiceDiscovery, filter: (arg: Record) => boolean): PromiseLike<WebClient>
getWebClient(discovery: ServiceDiscovery, filter: (arg: Record) => boolean, resultHandler: ((res: AsyncResult<WebClient>) => void) | Handler<AsyncResult<WebClient>>): void
getWebClient(discovery: ServiceDiscovery, filter: (arg: Record) => boolean, conf: {}): PromiseLike<WebClient>
getWebClient(discovery: ServiceDiscovery, filter: (arg: Record) => boolean, conf: {}, resultHandler: ((res: AsyncResult<WebClient>) => void) | Handler<AsyncResult<WebClient>>): void

- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:135
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails.

Parameters
- discovery: ServiceDiscovery
- filter: {}
  - [key: string]: any
Returns PromiseLike<WebClient>
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:141
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails.

Parameters
- discovery: ServiceDiscovery
- filter: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<WebClient>) => void) | Handler<AsyncResult<WebClient>>
Returns void
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:162
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client

Parameters
- discovery: ServiceDiscovery
- filter: {}
  - [key: string]: any
- conf: {}
  - [key: string]: any
Returns PromiseLike<WebClient>
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:169
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client

Parameters
- discovery: ServiceDiscovery
- filter: {}
  - [key: string]: any
- conf: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<WebClient>) => void) | Handler<AsyncResult<WebClient>>
Returns void
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:187
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails.

Parameters
- discovery: ServiceDiscovery
- filter: (arg: Record) => boolean
  - - (arg: Record): boolean
    - Parameters
      - arg: Record
      Returns boolean
Returns PromiseLike<WebClient>
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:193
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails.

Parameters
- discovery: ServiceDiscovery
- filter: (arg: Record) => boolean
  - - (arg: Record): boolean
    - Parameters
      - arg: Record
      Returns boolean
- resultHandler: ((res: AsyncResult<WebClient>) => void) | Handler<AsyncResult<WebClient>>
Returns void
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:214
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client.

Parameters
- discovery: ServiceDiscovery
- filter: (arg: Record) => boolean
  - - (arg: Record): boolean
    - Parameters
      - arg: Record
      Returns boolean
- conf: {}
  - [key: string]: any
Returns PromiseLike<WebClient>
- Defined in io.vertx/vertx-service-discovery/target/npm/index.d.ts:221
Convenient method that looks for a HTTP endpoint and provides the configured . The async result is marked as failed is there are no matching services, or if the lookup fails. This method accepts a configuration for the HTTP client.

Parameters
- discovery: ServiceDiscovery
- filter: (arg: Record) => boolean
  - - (arg: Record): boolean
    - Parameters
      - arg: Record
      Returns boolean
- conf: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<WebClient>) => void) | Handler<AsyncResult<WebClient>>
Returns void

Hierarchy

Index

Properties

Methods

Properties

Static Readonly TYPE

Static Readonly UNKNOWN

Methods

Static createRecord

Parameters

name: string

host: string

port: number

root: string

metadata: {}

[key: string]: any

Returns Record

Parameters

name: string

ssl: boolean

host: string

port: number

root: string

metadata: {}

[key: string]: any

Returns Record

Parameters

name: string

host: string

port: number

root: string

Returns Record

Parameters

name: string

host: string

Returns Record

Static getClient

Parameters

discovery: ServiceDiscovery

filter: {}

[key: string]: any

Returns PromiseLike<HttpClient>

Parameters

discovery: ServiceDiscovery

filter: {}

[key: string]: any

resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>

Returns void

Parameters

discovery: ServiceDiscovery

filter: {}

[key: string]: any

conf: {}

[key: string]: any

Returns PromiseLike<HttpClient>

Parameters

discovery: ServiceDiscovery

filter: {}

[key: string]: any

conf: {}

[key: string]: any

resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>

Returns void

Parameters

discovery: ServiceDiscovery

filter: (arg: Record) => boolean

Parameters

arg: Record

Returns boolean

Returns PromiseLike<HttpClient>

Parameters

discovery: ServiceDiscovery

filter: (arg: Record) => boolean

Parameters

arg: Record

Returns boolean

resultHandler: ((res: AsyncResult<HttpClient>) => void) | Handler<AsyncResult<HttpClient>>

Returns void

Parameters

discovery: ServiceDiscovery