java.lang.Object
- com.io7m.brooklime.api.BLStagingRepositoryUpload

All Implemented Interfaces:

BLStagingRepositoryUploadType
```
public final class BLStagingRepositoryUpload
extends java.lang.Object
implements BLStagingRepositoryUploadType
```
A request to upload a set of files to a staging repository.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BLStagingRepositoryUpload.Builder
Builds instances of type BLStagingRepositoryUpload.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.nio.file.Path`	`baseDirectory()`
`static BLStagingRepositoryUpload.Builder`	`builder()`	Creates a builder for `BLStagingRepositoryUpload`.
`static BLStagingRepositoryUpload`	`copyOf(BLStagingRepositoryUploadType instance)`	Creates an immutable copy of a `BLStagingRepositoryUploadType` value.
`boolean`	`equals(java.lang.Object another)`	This instance is equal to all instances of `BLStagingRepositoryUpload` that have equal attribute values.
`java.util.List<java.nio.file.Path>`	`files()`
`int`	`hashCode()`	Computes a hash code from attributes: `repositoryId`, `baseDirectory`, `files`, `retryDelay`, `retryCount`.
`java.lang.String`	`repositoryId()`
`int`	`retryCount()`
`java.time.Duration`	`retryDelay()`
`java.lang.String`	`toString()`	Prints the immutable value `BLStagingRepositoryUpload` with attribute values.
`BLStagingRepositoryUpload`	`withBaseDirectory(java.nio.file.Path value)`	Copy the current immutable object by setting a value for the `baseDirectory` attribute.
`BLStagingRepositoryUpload`	`withFiles(java.lang.Iterable<? extends java.nio.file.Path> elements)`	Copy the current immutable object with elements that replace the content of `files`.
`BLStagingRepositoryUpload`	`withFiles(java.nio.file.Path... elements)`	Copy the current immutable object with elements that replace the content of `files`.
`BLStagingRepositoryUpload`	`withRepositoryId(java.lang.String value)`	Copy the current immutable object by setting a value for the `repositoryId` attribute.
`BLStagingRepositoryUpload`	`withRetryCount(int value)`	Copy the current immutable object by setting a value for the `retryCount` attribute.
`BLStagingRepositoryUpload`	`withRetryDelay(java.time.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

Methods inherited from interface com.io7m.brooklime.api.BLStagingRepositoryUploadType
checkPreconditions

- Method Detail
  - repositoryId
```
public java.lang.String repositoryId()
```
    Specified by:
    
    repositoryId in interface BLStagingRepositoryUploadType
    
    Returns:
    
    The ID of the staging repository
  - baseDirectory
```
public java.nio.file.Path baseDirectory()
```
    Specified by:
    
    baseDirectory in interface BLStagingRepositoryUploadType
    
    Returns:
    
    The base directory containing files
  - files
```
public java.util.List<java.nio.file.Path> files()
```
    Specified by:
    
    files in interface BLStagingRepositoryUploadType
    
    Returns:
    
    The files to be uploaded
  - retryDelay
```
public java.time.Duration retryDelay()
```
    Specified by:
    
    retryDelay in interface BLStagingRepositoryUploadType
    
    Returns:
    
    The duration by which to pause between failed upload attempts
  - retryCount
```
public int retryCount()
```
    Specified by:
    
    retryCount in interface BLStagingRepositoryUploadType
    
    Returns:
    
    The maximum number of times to retry uploading any given file
  - withRepositoryId
```
public final BLStagingRepositoryUpload withRepositoryId(java.lang.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 BLStagingRepositoryUpload withBaseDirectory(java.nio.file.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
  - withFiles
```
public final BLStagingRepositoryUpload withFiles(java.nio.file.Path... elements)
```
    Copy the current immutable object with elements that replace the content of files.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withFiles
```
public final BLStagingRepositoryUpload withFiles(java.lang.Iterable<? extends java.nio.file.Path> elements)
```
    Copy the current immutable object with elements that replace the content of files. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of files elements to set
    
    Returns:
    
    A modified copy of this object
  - withRetryDelay
```
public final BLStagingRepositoryUpload withRetryDelay(java.time.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 BLStagingRepositoryUpload 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(java.lang.Object another)
```
    This instance is equal to all instances of BLStagingRepositoryUpload that have equal attribute values.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: repositoryId, baseDirectory, files, retryDelay, retryCount.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    hashCode value
  - toString
```
public java.lang.String toString()
```
    Prints the immutable value BLStagingRepositoryUpload with attribute values.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static BLStagingRepositoryUpload copyOf(BLStagingRepositoryUploadType instance)
```
    Creates an immutable copy of a BLStagingRepositoryUploadType 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 BLStagingRepositoryUpload instance
  - builder
```
public static BLStagingRepositoryUpload.Builder builder()
```
    Creates a builder for BLStagingRepositoryUpload.
    BLStagingRepositoryUpload.builder() .setRepositoryId(String) // required repositoryId .setBaseDirectory(java.nio.file.Path) // required baseDirectory .addFiles|addAllFiles(java.nio.file.Path) // files elements .setRetryDelay(java.time.Duration) // required retryDelay .setRetryCount(int) // required retryCount .build();
    Returns:
    
    A new BLStagingRepositoryUpload builder

Class BLStagingRepositoryUpload

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.io7m.brooklime.api.BLStagingRepositoryUploadType

Method Detail

repositoryId

baseDirectory

files

retryDelay

retryCount

withRepositoryId

withBaseDirectory

withFiles

withFiles

withRetryDelay

withRetryCount

equals

hashCode

toString

copyOf

builder