ClientHttpRequestFactorySettings (spring-boot 3.0.6)

java.lang.Object

java.lang.Record

org.springframework.boot.web.client.ClientHttpRequestFactorySettings

Record Components:: connectTimeout - the connect timeout; readTimeout - the read timeout; bufferRequestBody - if request body buffering is used

public record ClientHttpRequestFactorySettings(Duration connectTimeout, Duration readTimeout, Boolean bufferRequestBody) extends Record

Settings that can be applied when creating a ClientHttpRequestFactory.

Since:

3.0.0

See Also:

ClientHttpRequestFactories

Field Summary

Fields

Modifier and Type

Field

Description

static final ClientHttpRequestFactorySettings

DEFAULTS

Use defaults for the ClientHttpRequestFactory which can differ depending on the implementation.
Constructor Summary

Constructors

Constructor

Description

ClientHttpRequestFactorySettings(Duration connectTimeout, Duration readTimeout, Boolean bufferRequestBody)

Creates an instance of a ClientHttpRequestFactorySettings record class.
Method Summary

Modifier and Type

Method

Description

Boolean

bufferRequestBody()

Returns the value of the bufferRequestBody record component.

Duration

connectTimeout()

Returns the value of the connectTimeout record component.

final boolean

equals(Object o)

Indicates whether some other object is "equal to" this one.

final int

hashCode()

Returns a hash code value for this object.

Duration

readTimeout()

Returns the value of the readTimeout record component.

final String

toString()

Returns a string representation of this record class.

ClientHttpRequestFactorySettings

withBufferRequestBody(Boolean bufferRequestBody)

Return a new ClientHttpRequestFactorySettings instance with an updated buffer request body setting.

ClientHttpRequestFactorySettings

withConnectTimeout(Duration connectTimeout)

Return a new ClientHttpRequestFactorySettings instance with an updated connect timeout setting .

ClientHttpRequestFactorySettings

withReadTimeout(Duration readTimeout)

Return a new ClientHttpRequestFactorySettings instance with an updated read timeout setting.

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

Field Details
- DEFAULTS
  
  public static final ClientHttpRequestFactorySettings DEFAULTS
  
  Use defaults for the ClientHttpRequestFactory which can differ depending on the implementation.
Constructor Details
- ClientHttpRequestFactorySettings
  
  public ClientHttpRequestFactorySettings(Duration connectTimeout, Duration readTimeout, Boolean bufferRequestBody)
  
  Creates an instance of a ClientHttpRequestFactorySettings record class.
  
  Parameters:
  
  connectTimeout - the value for the connectTimeout record component
  
  readTimeout - the value for the readTimeout record component
  
  bufferRequestBody - the value for the bufferRequestBody record component
Method Details
- withConnectTimeout
  
  public ClientHttpRequestFactorySettings withConnectTimeout(Duration connectTimeout)
  
  Return a new ClientHttpRequestFactorySettings instance with an updated connect timeout setting .
  
  Parameters:
  
  connectTimeout - the new connect timeout setting
  
  Returns:
  
  a new ClientHttpRequestFactorySettings instance
- withReadTimeout
  
  public ClientHttpRequestFactorySettings withReadTimeout(Duration readTimeout)
  
  Return a new ClientHttpRequestFactorySettings instance with an updated read timeout setting.
  
  Parameters:
  
  readTimeout - the new read timeout setting
  
  Returns:
  
  a new ClientHttpRequestFactorySettings instance
- withBufferRequestBody
  
  public ClientHttpRequestFactorySettings withBufferRequestBody(Boolean bufferRequestBody)
  
  Return a new ClientHttpRequestFactorySettings instance with an updated buffer request body setting.
  
  Parameters:
  
  bufferRequestBody - the new buffer request body setting
  
  Returns:
  
  a new ClientHttpRequestFactorySettings instance
- toString
  
  public final String toString()
  
  Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
  
  Specified by:
  
  toString in class Record
  
  Returns:
  
  a string representation of this object
- hashCode
  
  public final int hashCode()
  
  Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
  
  Specified by:
  
  hashCode in class Record
  
  Returns:
  
  a hash code value for this object
- equals
  
  public final boolean equals(Object o)
  
  Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
  
  Specified by:
  
  equals in class Record
  
  Parameters:
  
  o - the object with which to compare
  
  Returns:
  
  true if this object is the same as the o argument; false otherwise.
- connectTimeout
  
  public Duration connectTimeout()
  
  Returns the value of the connectTimeout record component.
  
  Returns:
  
  the value of the connectTimeout record component
- readTimeout
  
  public Duration readTimeout()
  
  Returns the value of the readTimeout record component.
  
  Returns:
  
  the value of the readTimeout record component
- bufferRequestBody
  
  public Boolean bufferRequestBody()
  
  Returns the value of the bufferRequestBody record component.
  
  Returns:
  
  the value of the bufferRequestBody record component

Record Class ClientHttpRequestFactorySettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

DEFAULTS

Constructor Details

ClientHttpRequestFactorySettings

Method Details

withConnectTimeout

withReadTimeout

withBufferRequestBody

toString

hashCode

equals

connectTimeout

readTimeout

bufferRequestBody