Package com.io7m.brooklime.api
Class BLStagingRepositoryUploadRequestParameters
- java.lang.Object
-
- com.io7m.brooklime.api.BLStagingRepositoryUploadRequestParameters
-
- All Implemented Interfaces:
BLStagingRepositoryUploadRequestParametersType
public final class BLStagingRepositoryUploadRequestParameters extends java.lang.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 classBLStagingRepositoryUploadRequestParameters.BuilderBuilds instances of typeBLStagingRepositoryUploadRequestParameters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.nio.file.PathbaseDirectory()static BLStagingRepositoryUploadRequestParameters.Builderbuilder()Creates a builder forBLStagingRepositoryUploadRequestParameters.static BLStagingRepositoryUploadRequestParameterscopyOf(BLStagingRepositoryUploadRequestParametersType instance)Creates an immutable copy of aBLStagingRepositoryUploadRequestParametersTypevalue.booleanequals(java.lang.Object another)This instance is equal to all instances ofBLStagingRepositoryUploadRequestParametersthat have equal attribute values.inthashCode()Computes a hash code from attributes:repositoryId,baseDirectory,retryDelay,retryCount.java.lang.StringrepositoryId()intretryCount()java.time.DurationretryDelay()java.lang.StringtoString()Prints the immutable valueBLStagingRepositoryUploadRequestParameterswith attribute values.BLStagingRepositoryUploadRequestParameterswithBaseDirectory(java.nio.file.Path value)Copy the current immutable object by setting a value for thebaseDirectoryattribute.BLStagingRepositoryUploadRequestParameterswithRepositoryId(java.lang.String value)Copy the current immutable object by setting a value for therepositoryIdattribute.BLStagingRepositoryUploadRequestParameterswithRetryCount(int value)Copy the current immutable object by setting a value for theretryCountattribute.BLStagingRepositoryUploadRequestParameterswithRetryDelay(java.time.Duration value)Copy the current immutable object by setting a value for theretryDelayattribute.
-
-
-
Method Detail
-
repositoryId
public java.lang.String repositoryId()
- Specified by:
repositoryIdin interfaceBLStagingRepositoryUploadRequestParametersType- Returns:
- The ID of the staging repository
-
baseDirectory
public java.nio.file.Path baseDirectory()
- Specified by:
baseDirectoryin interfaceBLStagingRepositoryUploadRequestParametersType- Returns:
- The base directory containing files
-
retryDelay
public java.time.Duration retryDelay()
- Specified by:
retryDelayin interfaceBLStagingRepositoryUploadRequestParametersType- Returns:
- The duration by which to pause between failed upload attempts
-
retryCount
public int retryCount()
- Specified by:
retryCountin interfaceBLStagingRepositoryUploadRequestParametersType- Returns:
- The maximum number of times to retry uploading any given file
-
withRepositoryId
public final BLStagingRepositoryUploadRequestParameters withRepositoryId(java.lang.String value)
Copy the current immutable object by setting a value for therepositoryIdattribute. An equals check used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for repositoryId- Returns:
- A modified copy of the
thisobject
-
withBaseDirectory
public final BLStagingRepositoryUploadRequestParameters withBaseDirectory(java.nio.file.Path value)
Copy the current immutable object by setting a value for thebaseDirectoryattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for baseDirectory- Returns:
- A modified copy of the
thisobject
-
withRetryDelay
public final BLStagingRepositoryUploadRequestParameters withRetryDelay(java.time.Duration value)
Copy the current immutable object by setting a value for theretryDelayattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for retryDelay- Returns:
- A modified copy of the
thisobject
-
withRetryCount
public final BLStagingRepositoryUploadRequestParameters withRetryCount(int value)
Copy the current immutable object by setting a value for theretryCountattribute. A value equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for retryCount- Returns:
- A modified copy of the
thisobject
-
equals
public boolean equals(java.lang.Object another)
This instance is equal to all instances ofBLStagingRepositoryUploadRequestParametersthat have equal attribute values.- Overrides:
equalsin classjava.lang.Object- Returns:
trueifthisis equal toanotherinstance
-
hashCode
public int hashCode()
Computes a hash code from attributes:repositoryId,baseDirectory,retryDelay,retryCount.- Overrides:
hashCodein classjava.lang.Object- Returns:
- hashCode value
-
toString
public java.lang.String toString()
Prints the immutable valueBLStagingRepositoryUploadRequestParameterswith attribute values.- Overrides:
toStringin classjava.lang.Object- Returns:
- A string representation of the value
-
copyOf
public static BLStagingRepositoryUploadRequestParameters copyOf(BLStagingRepositoryUploadRequestParametersType instance)
Creates an immutable copy of aBLStagingRepositoryUploadRequestParametersTypevalue. 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 forBLStagingRepositoryUploadRequestParameters.BLStagingRepositoryUploadRequestParameters.builder() .setRepositoryId(String) // requiredrepositoryId.setBaseDirectory(java.nio.file.Path) // requiredbaseDirectory.setRetryDelay(java.time.Duration) // requiredretryDelay.setRetryCount(int) // requiredretryCount.build();- Returns:
- A new BLStagingRepositoryUploadRequestParameters builder
-
-