Package com.io7m.brooklime.api

Class BLStagingRepositoryUploadRequestParameters

java.lang.Object

com.io7m.brooklime.api.BLStagingRepositoryUploadRequestParameters

All Implemented Interfaces:

BLStagingRepositoryUploadRequestParametersType

public final class BLStagingRepositoryUploadRequestParameters
extends Object
implements BLStagingRepositoryUploadRequestParametersType

A request to schedule the upload of a set of files to a staging repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BLStagingRepositoryUploadRequestParameters.Builder	Builds instances of type BLStagingRepositoryUploadRequestParameters.

Method Summary

Modifier and Type	Method	Description
Path	baseDirectory()
static BLStagingRepositoryUploadRequestParameters.Builder	builder()	Creates a builder for BLStagingRepositoryUploadRequestParameters.
static BLStagingRepositoryUploadRequestParameters	copyOf(BLStagingRepositoryUploadRequestParametersType instance)	Creates an immutable copy of a BLStagingRepositoryUploadRequestParametersType value.
boolean	equals(Object another)	This instance is equal to all instances of BLStagingRepositoryUploadRequestParameters that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: repositoryId, baseDirectory, retryDelay, retryCount.
String	repositoryId()
int	retryCount()
Duration	retryDelay()
String	toString()	Prints the immutable value BLStagingRepositoryUploadRequestParameters with attribute values.
final BLStagingRepositoryUploadRequestParameters	withBaseDirectory(Path value)	Copy the current immutable object by setting a value for the baseDirectory attribute.
final BLStagingRepositoryUploadRequestParameters	withRepositoryId(String value)	Copy the current immutable object by setting a value for the repositoryId attribute.
final BLStagingRepositoryUploadRequestParameters	withRetryCount(int value)	Copy the current immutable object by setting a value for the retryCount attribute.
final BLStagingRepositoryUploadRequestParameters	withRetryDelay(Duration value)	Copy the current immutable object by setting a value for the retryDelay attribute.

Methods inherited from class java.lang.Object

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

Method Details

repositoryId

public String repositoryId()

Specified by:

repositoryId in interface BLStagingRepositoryUploadRequestParametersType

Returns:

The ID of the staging repository

baseDirectory

public Path baseDirectory()

Specified by:

baseDirectory in interface BLStagingRepositoryUploadRequestParametersType

Returns:

The base directory containing files

retryDelay

public Duration retryDelay()

Specified by:

retryDelay in interface BLStagingRepositoryUploadRequestParametersType

Returns:

The duration by which to pause between failed upload attempts

retryCount

public int retryCount()

Specified by:

retryCount in interface BLStagingRepositoryUploadRequestParametersType

Returns:

The maximum number of times to retry uploading any given file

withRepositoryId

public final BLStagingRepositoryUploadRequestParameters withRepositoryId(String value)

Copy the current immutable object by setting a value for the repositoryId attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for repositoryId

Returns:

A modified copy of the this object

withBaseDirectory

public final BLStagingRepositoryUploadRequestParameters withBaseDirectory(Path value)

Copy the current immutable object by setting a value for the baseDirectory attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for baseDirectory

Returns:

A modified copy of the this object

withRetryDelay

public final BLStagingRepositoryUploadRequestParameters withRetryDelay(Duration value)

Copy the current immutable object by setting a value for the retryDelay attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for retryDelay

Returns:

A modified copy of the this object

withRetryCount

public final BLStagingRepositoryUploadRequestParameters withRetryCount(int value)

Copy the current immutable object by setting a value for the retryCount attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for retryCount

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of BLStagingRepositoryUploadRequestParameters that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: repositoryId, baseDirectory, retryDelay, retryCount.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BLStagingRepositoryUploadRequestParameters with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static BLStagingRepositoryUploadRequestParameters copyOf(BLStagingRepositoryUploadRequestParametersType instance)

Creates an immutable copy of a BLStagingRepositoryUploadRequestParametersType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable BLStagingRepositoryUploadRequestParameters instance

builder

public static BLStagingRepositoryUploadRequestParameters.Builder builder()

Creates a builder for BLStagingRepositoryUploadRequestParameters.

 BLStagingRepositoryUploadRequestParameters.builder()
    .setRepositoryId(String) // required repositoryId
    .setBaseDirectory(java.nio.file.Path) // required baseDirectory
    .setRetryDelay(java.time.Duration) // required retryDelay
    .setRetryCount(int) // required retryCount
    .build();
 

Returns:

A new BLStagingRepositoryUploadRequestParameters builder