Clients -
http :
LoadBalanceClient
LoadBalanceClient endpoint provides load balancing functionality over multiple HTTP clients.
Constructor
__init
(LoadBalanceClientConfiguration loadBalanceClientConfig)
- loadBalanceClientConfig LoadBalanceClientConfiguration
-
The configurations for the load balance client endpoint
Remote Methods
post | The POST remote function implementation of the LoadBalancer Connector. |
head | The HEAD remote function implementation of the LoadBalancer Connector. |
patch | The PATCH remote function implementation of the LoadBalancer Connector. |
put | The PUT remote function implementation of the Load Balance Connector. |
options | The OPTIONS remote function implementation of the LoadBalancer Connector. |
forward | The FORWARD remote function implementation of the LoadBalancer Connector. |
execute | The EXECUTE remote function implementation of the LoadBalancer Connector. The Execute remote function can be used to invoke an HTTP call with the given HTTP verb. |
delete | The DELETE remote function implementation of the LoadBalancer Connector. |
get | The GET remote function implementation of the LoadBalancer Connector. |
submit | The submit implementation of the LoadBalancer Connector. |
getResponse | The getResponse implementation of the LoadBalancer Connector. |
hasPromise | The hasPromise implementation of the LoadBalancer Connector. |
getNextPromise | The getNextPromise implementation of the LoadBalancer Connector. |
getPromisedResponse | The getPromisedResponse implementation of the LoadBalancer Connector. |
rejectPromise | The rejectPromise implementation of the LoadBalancer Connector. |
Fields
- loadBalanceClientConfig LoadBalanceClientConfiguration
-
The configurations for the load balance client endpoint
- loadBalanceClientsArray Client?[]
-
Array of HTTP clients for load balancing
- lbRule LoadBalancerRule
-
Load balancing rule
- failover boolean
-
Whether to fail over in case of a failure
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP request or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP request or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP request or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP request or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP request or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Parameters
- httpVerb string
-
HTTP method to be used for the request
- path string
-
Resource path
- message RequestMessage
-
An HTTP request or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An HTTP request or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP request or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Parameters
- httpVerb string
-
The HTTP verb value
- path string
-
The resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
, ormime:Entity[]
-
Return Type
(HttpFuture | ClientError) An
http:HttpFuture
that represents an asynchronous service invocation or else anhttp:ClientError
if the submission fails
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(Response | ClientError) An
http:Response
message or else anhttp:ClientError
if the invocation fails
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(boolean) A
boolean
, which represents whether anhttp:PushPromise
exists
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(PushPromise | ClientError) An
http:PushPromise
message or else anhttp:ClientError
if the invocation fails
Parameters
- promise PushPromise
-
The related
http:PushPromise
-
Return Type
(Response | ClientError) A promised
http:Response
message or else anhttp:ClientError
if the invocation fails
Parameters
- promise PushPromise
-
The Push Promise to be rejected