Package org.broadinstitute.http.nio

Record Class HttpFileSystemProviderSettings

java.lang.Object

java.lang.Record

org.broadinstitute.http.nio.HttpFileSystemProviderSettings

public record HttpFileSystemProviderSettings(Duration timeout, HttpClient.Redirect redirect, HttpFileSystemProviderSettings.RetrySettings retrySettings)
extends Record

Settings that control the behavior of newly instantiated Http(s)FileSystems

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	HttpFileSystemProviderSettings.RetrySettings	Settings which control the behavior of http retries

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpFileSystemProviderSettings.RetrySettings	DEFAULT_RETRY_SETTINGS	The default retry settings, these are a good basis for retry handling
static final HttpFileSystemProviderSettings	DEFAULT_SETTINGS	default settings which will be used unless they are reset
private final HttpClient.Redirect	redirect	The field for the redirect record component.
private final HttpFileSystemProviderSettings.RetrySettings	retrySettings	The field for the retrySettings record component.
private final Duration	timeout	The field for the timeout record component.

Constructor Summary

Constructors

Constructor	Description
HttpFileSystemProviderSettings(Duration timeout, HttpClient.Redirect redirect, HttpFileSystemProviderSettings.RetrySettings retrySettings)	Creates an instance of a HttpFileSystemProviderSettings record class.

Method Summary

Modifier and Type	Method	Description
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.
HttpClient.Redirect	redirect()	Returns the value of the redirect record component.
HttpFileSystemProviderSettings.RetrySettings	retrySettings()	Returns the value of the retrySettings record component.
Duration	timeout()	Returns the value of the timeout record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

timeout

private final Duration timeout

The field for the timeout record component.

redirect

private final HttpClient.Redirect redirect

The field for the redirect record component.

retrySettings

private final HttpFileSystemProviderSettings.RetrySettings retrySettings

The field for the retrySettings record component.

DEFAULT_RETRY_SETTINGS

public static final HttpFileSystemProviderSettings.RetrySettings DEFAULT_RETRY_SETTINGS

The default retry settings, these are a good basis for retry handling

DEFAULT_SETTINGS

public static final HttpFileSystemProviderSettings DEFAULT_SETTINGS

default settings which will be used unless they are reset

Constructor Details

HttpFileSystemProviderSettings

public HttpFileSystemProviderSettings(Duration timeout,
 HttpClient.Redirect redirect,
 HttpFileSystemProviderSettings.RetrySettings retrySettings)

Creates an instance of a HttpFileSystemProviderSettings record class.

Parameters:

timeout - the value for the timeout record component

redirect - the value for the redirect record component

retrySettings - the value for the retrySettings record component

Method Details

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.

timeout

public Duration timeout()

Returns the value of the timeout record component.

Returns:

the value of the timeout record component

redirect

public HttpClient.Redirect redirect()

Returns the value of the redirect record component.

Returns:

the value of the redirect record component

retrySettings

public HttpFileSystemProviderSettings.RetrySettings retrySettings()

Returns the value of the retrySettings record component.

Returns:

the value of the retrySettings record component