Class UploadStatus
-
- All Implemented Interfaces:
-
java.io.Externalizable
,java.io.Serializable
,java.lang.Comparable
,org.apache.avro.generic.GenericContainer
,org.apache.avro.generic.GenericRecord
,org.apache.avro.generic.IndexedRecord
,org.apache.avro.specific.SpecificRecord
public class UploadStatus extends SpecificRecordBase implements SpecificRecord
Upload status of a given requestId for a collection of net.corda.data.chunking.Chunk objects. There will be one message per chunk. Request id and partnumber are carried by the key net.corda.data.chunking.ChunkAckKey
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
UploadStatus.Builder
RecordBuilder for UploadStatus instances.
-
Field Summary
Fields Modifier and Type Field Description public final static Schema
SCHEMA$
public boolean
complete
public String
message
public SecureHash
checksum
public ExceptionEnvelope
exception
-
Constructor Summary
Constructors Constructor Description UploadStatus()
Default constructor. UploadStatus(Boolean complete, String message, SecureHash checksum, ExceptionEnvelope exception)
All-args constructor.
-
Method Summary
Modifier and Type Method Description boolean
getComplete()
Gets the value of the 'complete' field. void
setComplete(boolean value)
Sets the value of the 'complete' field. String
getMessage()
Gets the value of the 'message' field. void
setMessage(String value)
Sets the value of the 'message' field. SecureHash
getChecksum()
Gets the value of the 'checksum' field. void
setChecksum(SecureHash value)
Sets the value of the 'checksum' field. ExceptionEnvelope
getException()
Gets the value of the 'exception' field. void
setException(ExceptionEnvelope value)
Sets the value of the 'exception' field. static Schema
getClassSchema()
static BinaryMessageEncoder<UploadStatus>
getEncoder()
Return the BinaryMessageEncoder instance used by this class. static BinaryMessageDecoder<UploadStatus>
getDecoder()
Return the BinaryMessageDecoder instance used by this class. static BinaryMessageDecoder<UploadStatus>
createDecoder(SchemaStore resolver)
Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore. ByteBuffer
toByteBuffer()
Serializes this UploadStatus to a ByteBuffer. static UploadStatus
fromByteBuffer(ByteBuffer b)
Deserializes a UploadStatus from a ByteBuffer. SpecificData
getSpecificData()
Schema
getSchema()
Object
get(int field$)
void
put(int field$, Object value$)
static UploadStatus.Builder
newBuilder()
Creates a new UploadStatus RecordBuilder. static UploadStatus.Builder
newBuilder(UploadStatus.Builder other)
Creates a new UploadStatus RecordBuilder by copying an existing Builder. static UploadStatus.Builder
newBuilder(UploadStatus other)
Creates a new UploadStatus RecordBuilder by copying an existing UploadStatus instance. void
writeExternal(ObjectOutput out)
void
readExternal(ObjectInput in)
void
customEncode(Encoder out)
void
customDecode(ResolvingDecoder in)
-
Methods inherited from class org.apache.avro.specific.SpecificRecordBase
compareTo, equals, getConversion, hashCode, toString
-
Methods inherited from class org.apache.avro.generic.GenericRecord
hasField
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
UploadStatus
UploadStatus()
Default constructor.
-
UploadStatus
UploadStatus(Boolean complete, String message, SecureHash checksum, ExceptionEnvelope exception)
All-args constructor.- Parameters:
complete
- Has the upload completed?message
- A message indicating the current status of the upload.checksum
- The checksum of the file that was uploaded that can be used to reference it.exception
- cause of failure if the request was unsuccessful
-
-
Method Detail
-
getComplete
boolean getComplete()
Gets the value of the 'complete' field.
-
setComplete
void setComplete(boolean value)
Sets the value of the 'complete' field. Has the upload completed? If false, it's likely in progress, but you should check the exception field
- Parameters:
value
- the value to set.
-
getMessage
String getMessage()
Gets the value of the 'message' field.
-
setMessage
void setMessage(String value)
Sets the value of the 'message' field. A message indicating the current status of the upload.
- Parameters:
value
- the value to set.
-
getChecksum
SecureHash getChecksum()
Gets the value of the 'checksum' field.
-
setChecksum
void setChecksum(SecureHash value)
Sets the value of the 'checksum' field. The checksum of the file that was uploaded that can be used to reference it.
- Parameters:
value
- the value to set.
-
getException
ExceptionEnvelope getException()
Gets the value of the 'exception' field.
-
setException
void setException(ExceptionEnvelope value)
Sets the value of the 'exception' field. cause of failure if the request was unsuccessful
- Parameters:
value
- the value to set.
-
getClassSchema
static Schema getClassSchema()
-
getEncoder
static BinaryMessageEncoder<UploadStatus> getEncoder()
Return the BinaryMessageEncoder instance used by this class.
-
getDecoder
static BinaryMessageDecoder<UploadStatus> getDecoder()
Return the BinaryMessageDecoder instance used by this class.
-
createDecoder
static BinaryMessageDecoder<UploadStatus> createDecoder(SchemaStore resolver)
Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.
- Parameters:
resolver
- a SchemaStore used to find schemas by fingerprint
-
toByteBuffer
ByteBuffer toByteBuffer()
Serializes this UploadStatus to a ByteBuffer.
-
fromByteBuffer
static UploadStatus fromByteBuffer(ByteBuffer b)
Deserializes a UploadStatus from a ByteBuffer.
- Parameters:
b
- a byte buffer holding serialized data for an instance of this class
-
getSpecificData
SpecificData getSpecificData()
-
getSchema
Schema getSchema()
-
newBuilder
static UploadStatus.Builder newBuilder()
Creates a new UploadStatus RecordBuilder.
-
newBuilder
static UploadStatus.Builder newBuilder(UploadStatus.Builder other)
Creates a new UploadStatus RecordBuilder by copying an existing Builder.
- Parameters:
other
- The existing builder to copy.
-
newBuilder
static UploadStatus.Builder newBuilder(UploadStatus other)
Creates a new UploadStatus RecordBuilder by copying an existing UploadStatus instance.
- Parameters:
other
- The existing instance to copy.
-
writeExternal
void writeExternal(ObjectOutput out)
-
readExternal
void readExternal(ObjectInput in)
-
customEncode
void customEncode(Encoder out)
-
customDecode
void customDecode(ResolvingDecoder in)
-
-
-
-