org.apache.flink.runtime.rest

Class RestClient

java.lang.Object

org.apache.flink.runtime.rest.RestClient

All Implemented Interfaces:

AutoCloseable, AutoCloseableAsync

public class RestClient
extends Object
implements AutoCloseableAsync

This client is the counter-part to the RestServerEndpoint.

Constructor Summary

Constructors

Constructor and Description
RestClient(RestClientConfiguration configuration, Executor executor)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	closeAsync() Trigger the closing of the resource and return the corresponding close future.
<M extends MessageHeaders<EmptyRequestBody,P,EmptyMessageParameters>,P extends ResponseBody> CompletableFuture<P>	sendRequest(String targetAddress, int targetPort, M messageHeaders)
<M extends MessageHeaders<R,P,U>,U extends MessageParameters,R extends RequestBody,P extends ResponseBody> CompletableFuture<P>	sendRequest(String targetAddress, int targetPort, M messageHeaders, U messageParameters, R request)
<M extends MessageHeaders<R,P,U>,U extends MessageParameters,R extends RequestBody,P extends ResponseBody> CompletableFuture<P>	sendRequest(String targetAddress, int targetPort, M messageHeaders, U messageParameters, R request, Collection<FileUpload> fileUploads)
<M extends MessageHeaders<R,P,U>,U extends MessageParameters,R extends RequestBody,P extends ResponseBody> CompletableFuture<P>	sendRequest(String targetAddress, int targetPort, M messageHeaders, U messageParameters, R request, Collection<FileUpload> fileUploads, RestAPIVersion apiVersion)
void	shutdown(Time timeout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

close

Constructor Detail

RestClient

public RestClient(RestClientConfiguration configuration,
                  Executor executor)

Method Detail

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: AutoCloseableAsync

Trigger the closing of the resource and return the corresponding close future.

Specified by:

closeAsync in interface AutoCloseableAsync

Returns:

Future which is completed once the resource has been closed

shutdown

public void shutdown(Time timeout)

sendRequest

public <M extends MessageHeaders<EmptyRequestBody,P,EmptyMessageParameters>,P extends ResponseBody> CompletableFuture<P> sendRequest(String targetAddress,
                                                                                                                                     int targetPort,
                                                                                                                                     M messageHeaders)
                                                                                                                              throws IOException

Throws:

IOException

sendRequest

public <M extends MessageHeaders<R,P,U>,U extends MessageParameters,R extends RequestBody,P extends ResponseBody> CompletableFuture<P> sendRequest(String targetAddress,
                                                                                                                                                   int targetPort,
                                                                                                                                                   M messageHeaders,
                                                                                                                                                   U messageParameters,
                                                                                                                                                   R request)
                                                                                                                                            throws IOException

Throws:

IOException

sendRequest

public <M extends MessageHeaders<R,P,U>,U extends MessageParameters,R extends RequestBody,P extends ResponseBody> CompletableFuture<P> sendRequest(String targetAddress,
                                                                                                                                                   int targetPort,
                                                                                                                                                   M messageHeaders,
                                                                                                                                                   U messageParameters,
                                                                                                                                                   R request,
                                                                                                                                                   Collection<FileUpload> fileUploads)
                                                                                                                                            throws IOException

Throws:

IOException

sendRequest

public <M extends MessageHeaders<R,P,U>,U extends MessageParameters,R extends RequestBody,P extends ResponseBody> CompletableFuture<P> sendRequest(String targetAddress,
                                                                                                                                                   int targetPort,
                                                                                                                                                   M messageHeaders,
                                                                                                                                                   U messageParameters,
                                                                                                                                                   R request,
                                                                                                                                                   Collection<FileUpload> fileUploads,
                                                                                                                                                   RestAPIVersion apiVersion)
                                                                                                                                            throws IOException

Throws:

IOException