RestClientConfiguration (Flink : Runtime 2.0.0 API)

java.lang.Object
- org.apache.flink.runtime.rest.RestClientConfiguration

public final class RestClientConfiguration
extends Object

A configuration object for RestClients.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RestClientConfiguration`	`fromConfiguration(org.apache.flink.configuration.Configuration config)`	Creates and returns a new `RestClientConfiguration` from the given `Configuration`.
`long`	`getConnectionTimeout()`	{@see RestOptions#CONNECTION_TIMEOUT}.
`long`	`getIdlenessTimeout()`	{@see RestOptions#IDLENESS_TIMEOUT}.
`int`	`getMaxContentLength()`	Returns the max content length that the REST client endpoint could handle.
`SSLHandlerFactory`	`getSslHandlerFactory()`	Returns the `SSLEngine` that the REST client endpoint should use.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getSslHandlerFactory
```
@Nullable
public SSLHandlerFactory getSslHandlerFactory()
```
    Returns the SSLEngine that the REST client endpoint should use.
    
    Returns:
    
    SSLEngine that the REST client endpoint should use, or null if SSL was disabled
  - getConnectionTimeout
```
public long getConnectionTimeout()
```
    {@see RestOptions#CONNECTION_TIMEOUT}.
  - getIdlenessTimeout
```
public long getIdlenessTimeout()
```
    {@see RestOptions#IDLENESS_TIMEOUT}.
  - getMaxContentLength
```
public int getMaxContentLength()
```
    Returns the max content length that the REST client endpoint could handle.
    
    Returns:
    
    max content length that the REST client endpoint could handle
  - fromConfiguration
```
public static RestClientConfiguration fromConfiguration(org.apache.flink.configuration.Configuration config)
                                                 throws org.apache.flink.util.ConfigurationException
```
    Creates and returns a new RestClientConfiguration from the given Configuration.
    
    Parameters:
    
    config - configuration from which the REST client endpoint configuration should be created from
    
    Returns:
    
    REST client endpoint configuration
    
    Throws:
    
    org.apache.flink.util.ConfigurationException - if SSL was configured incorrectly