com.citrix.sharefile.api.models

Class SFUploadSpecification

java.lang.Object

com.citrix.sharefile.api.models.SFODataObject

com.citrix.sharefile.api.models.SFUploadSpecification

public class SFUploadSpecification
extends SFODataObject

Constructor Summary

Constructors

Constructor and Description
SFUploadSpecification()

Method Summary

Methods

Modifier and Type	Method and Description
java.net.URI	getChunkUri() Specifies the URI the client must send the file data to
java.net.URI	getFinishUri() If provided, specifies the final call the client must perform to finish the upload process
java.lang.Boolean	getIsResume() Specifies a Resumable upload is supproted.
SFSafeEnum<SFUploadMethod>	getMethod() The Upload method that must be used for this upload
java.net.URI	getPrepareUri() If provided, clients must issue a request to this Uri before uploading any data.
java.lang.String	getProgressData() Allows the client to check progress of standard uploads
java.lang.String	getResumeFileHash() Specifies the MD5 hash of the first ResumeOffset bytes of the partial file found at the server
java.lang.Long	getResumeIndex() Specifies the initial index for resuming, if IsResume is true.
java.lang.Long	getResumeOffset() Specifies the initial file offset by bytes, if IsResume is true
void	setChunkUri(java.net.URI chunkuri) Specifies the URI the client must send the file data to
void	setFinishUri(java.net.URI finishuri) If provided, specifies the final call the client must perform to finish the upload process
void	setIsResume(java.lang.Boolean isresume) Specifies a Resumable upload is supproted.
void	setMethod(SFSafeEnum<SFUploadMethod> method) The Upload method that must be used for this upload
void	setPrepareUri(java.net.URI prepareuri) If provided, clients must issue a request to this Uri before uploading any data.
void	setProgressData(java.lang.String progressdata) Allows the client to check progress of standard uploads
void	setResumeFileHash(java.lang.String resumefilehash) Specifies the MD5 hash of the first ResumeOffset bytes of the partial file found at the server
void	setResumeIndex(java.lang.Long resumeindex) Specifies the initial index for resuming, if IsResume is true.
void	setResumeOffset(java.lang.Long resumeoffset) Specifies the initial file offset by bytes, if IsResume is true

Methods inherited from class com.citrix.sharefile.api.models.SFODataObject

addProperty, get__type, getId, getMetadataUrl, getProperties, geturl, set__type, setId, setMetadataUrl, setProperties, seturl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFUploadSpecification

public SFUploadSpecification()

Method Detail

getMethod

public SFSafeEnum<SFUploadMethod> getMethod()

The Upload method that must be used for this upload

setMethod

public void setMethod(SFSafeEnum<SFUploadMethod> method)

The Upload method that must be used for this upload

getPrepareUri

public java.net.URI getPrepareUri()

If provided, clients must issue a request to this Uri before uploading any data.

setPrepareUri

public void setPrepareUri(java.net.URI prepareuri)

If provided, clients must issue a request to this Uri before uploading any data.

getChunkUri

public java.net.URI getChunkUri()

Specifies the URI the client must send the file data to

setChunkUri

public void setChunkUri(java.net.URI chunkuri)

Specifies the URI the client must send the file data to

getFinishUri

public java.net.URI getFinishUri()

If provided, specifies the final call the client must perform to finish the upload process

setFinishUri

public void setFinishUri(java.net.URI finishuri)

If provided, specifies the final call the client must perform to finish the upload process

getProgressData

public java.lang.String getProgressData()

Allows the client to check progress of standard uploads

setProgressData

public void setProgressData(java.lang.String progressdata)

Allows the client to check progress of standard uploads

getIsResume

public java.lang.Boolean getIsResume()

Specifies a Resumable upload is supproted.

setIsResume

public void setIsResume(java.lang.Boolean isresume)

Specifies a Resumable upload is supproted.

getResumeIndex

public java.lang.Long getResumeIndex()

Specifies the initial index for resuming, if IsResume is true.

setResumeIndex

public void setResumeIndex(java.lang.Long resumeindex)

Specifies the initial index for resuming, if IsResume is true.

getResumeOffset

public java.lang.Long getResumeOffset()

Specifies the initial file offset by bytes, if IsResume is true

setResumeOffset

public void setResumeOffset(java.lang.Long resumeoffset)

Specifies the initial file offset by bytes, if IsResume is true

getResumeFileHash

public java.lang.String getResumeFileHash()

Specifies the MD5 hash of the first ResumeOffset bytes of the partial file found at the server

setResumeFileHash

public void setResumeFileHash(java.lang.String resumefilehash)

Specifies the MD5 hash of the first ResumeOffset bytes of the partial file found at the server