com.hds.hcpaw.fss.api.model

Class LinkFileCreateRequest

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.LinkRequestBase

com.hds.hcpaw.fss.api.model.LinkFileCreateRequest

public abstract class LinkFileCreateRequest
extends LinkRequestBase

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.LinkRequestBase

accessCode, itemName, linkToken

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkFileCreateRequest	create(FssApiVersion apiVersion, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.Long size, java.lang.String hash, java.lang.Boolean createParents, java.lang.Long atime, java.lang.Long ctime, java.lang.Long mtime, java.io.InputStream input)
java.lang.Long	getATime() Returns the Last Accessed time of the file created.
java.lang.Boolean	getCreateParents() Returns true if parents of path should be created if they do not exist; false otherwise.
java.lang.Long	getCTime() Returns the created time of the file created.
static java.lang.Class<? extends LinkFileCreateRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkFileCreateRequest that corresponds to the specified apiVersion.
java.lang.String	getHash() Returns the SHA-384 hash of the file to be created, represented as a hex string.
java.io.InputStream	getInput() Returns the InputStream containing the contents of the file to be created.
java.lang.Long	getMTime() Returns the modified time of the file created.
java.lang.String	getPath() Returns the path of the file to be created.
java.lang.Long	getSize() Returns the size (in bytes) of the file to be created.
protected void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.LinkRequestBase

getAccessCode, getItemName, getLinkToken

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

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

Method Detail

getFssApiClass

public static java.lang.Class<? extends LinkFileCreateRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                       throws AwUnsupportedApiVersionException

Returns the Class of the LinkFileCreateRequest that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkFileCreateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkFileCreateRequest create(FssApiVersion apiVersion,
                                           java.lang.String linkToken,
                                           java.lang.String itemName,
                                           java.lang.String accessCode,
                                           java.lang.String path,
                                           java.lang.Long size,
                                           java.lang.String hash,
                                           java.lang.Boolean createParents,
                                           java.lang.Long atime,
                                           java.lang.Long ctime,
                                           java.lang.Long mtime,
                                           java.io.InputStream input)
                                    throws AwUnsupportedApiVersionException

Parameters:

apiVersion -

linkToken -

itemName -

accessCode -

path -

size -

hash -

createParents -

input -

Returns:

Throws:

AwUnsupportedApiVersionException

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

Description copied from class: LinkRequestBase

Validates this object.

Overrides:

validate in class LinkRequestBase

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur

See Also:

BaseFssApiResource.validate(String, BaseFssApiResource)

getPath

public java.lang.String getPath()

Returns the path of the file to be created.

Returns:

the path of the file to be created

getSize

public java.lang.Long getSize()

Returns the size (in bytes) of the file to be created.

Returns:

size (in bytes) of the file to be created

getHash

public java.lang.String getHash()

Returns the SHA-384 hash of the file to be created, represented as a hex string.

Returns:

the SHA-384 hash of the file to be created, represented as a hex string

getCreateParents

public java.lang.Boolean getCreateParents()

Returns true if parents of path should be created if they do not exist; false otherwise.

Returns:

true if parents of path should be created if they do not exist; false otherwise

getInput

public java.io.InputStream getInput()

Returns the InputStream containing the contents of the file to be created.

Returns:

the InputStream containing the contents of the file to be created

getMTime

public java.lang.Long getMTime()

Returns the modified time of the file created.

Returns:

the modified time of the file created.

getCTime

public java.lang.Long getCTime()

Returns the created time of the file created.

Returns:

the created time of the file created.

getATime

public java.lang.Long getATime()

Returns the Last Accessed time of the file created.

Returns:

the Last Accessed time of the file created.