org.sagebionetworks.bridge.rest.model

Class Upload

java.lang.Object

org.sagebionetworks.bridge.rest.model.Upload

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class Upload
extends Object

Upload

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Upload.CompletedByEnum Currently the API has an endpoint for the client to call and mark an upload completed.

Constructor Summary

Constructors

Constructor and Description
Upload()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Upload.CompletedByEnum	getCompletedBy() Currently the API has an endpoint for the client to call and mark an upload completed.
DateTime	getCompletedOn() The date and time (ISO 8601 format) that the upload was completed.
Long	getContentLength() The size of the object in bytes.
String	getContentMd5() The base64-encoded, 128-bit MD5 digest of the upload.
String	getContentType() MIME content type.
String	getFilename() Name of the uploaded file.
HealthDataRecord	getHealthData() Get healthData
SynapseExporterStatus	getHealthRecordExporterStatus() Get healthRecordExporterStatus
String	getRecordId() The record ID of the upload in Synapse.
DateTime	getRequestedOn() The date and time (ISO 8601 format) that the client requested an URL to make an upload to the server.
String	getSchemaId() The ID of the schema for this upload.
Long	getSchemaRevision() The revision for the schema of this upload.
UploadStatus	getStatus() Get status
String	getType() Upload
String	getUploadId() The GUID assigned to this upoad.
List<String>	getValidationMessageList() An array of error messages if this upload did not pass validation.
int	hashCode()
Boolean	isEncrypted() True if the upload is encrypted.
Boolean	isZipped() True if the upload is zipped.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Upload

public Upload()

Method Detail

getUploadId

public String getUploadId()

The GUID assigned to this upoad.

Returns:

uploadId

isEncrypted

public Boolean isEncrypted()

True if the upload is encrypted. False if it is not encrypted.

Returns:

encrypted

getSchemaId

public String getSchemaId()

The ID of the schema for this upload.

Returns:

schemaId

getSchemaRevision

public Long getSchemaRevision()

The revision for the schema of this upload.

Returns:

schemaRevision

getRecordId

public String getRecordId()

The record ID of the upload in Synapse.

Returns:

recordId

getHealthData

public HealthDataRecord getHealthData()

Get healthData

Returns:

healthData

getContentLength

public Long getContentLength()

The size of the object in bytes. A standard HTTP header. For more information, go to [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13)

Returns:

contentLength

getContentMd5

public String getContentMd5()

The base64-encoded, 128-bit MD5 digest of the upload.

Returns:

contentMd5

getContentType

public String getContentType()

MIME content type.

Returns:

contentType

getFilename

public String getFilename()

Name of the uploaded file.

Returns:

filename

getStatus

public UploadStatus getStatus()

Get status

Returns:

status

getRequestedOn

public DateTime getRequestedOn()

The date and time (ISO 8601 format) that the client requested an URL to make an upload to the server.

Returns:

requestedOn

getCompletedOn

public DateTime getCompletedOn()

The date and time (ISO 8601 format) that the upload was completed.

Returns:

completedOn

getCompletedBy

public Upload.CompletedByEnum getCompletedBy()

Currently the API has an endpoint for the client to call and mark an upload completed. However, there is also a process that detects uploads to S3 and marks the uploads complete. This field indicates which client completed the upload.

Returns:

completedBy

getValidationMessageList

public List<String> getValidationMessageList()

An array of error messages if this upload did not pass validation.

Returns:

validationMessageList

getHealthRecordExporterStatus

public SynapseExporterStatus getHealthRecordExporterStatus()

Get healthRecordExporterStatus

Returns:

healthRecordExporterStatus

isZipped

public Boolean isZipped()

True if the upload is zipped. False if it is a single file.

Returns:

zipped

getType

public String getType()

Upload

Returns:

type

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object