com.hds.hcpaw.fss.api.model

Class FileCreateRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.FileCreateRequest

public abstract class FileCreateRequest
extends BaseFssApiResource

A request to create a file.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static FileCreateRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Long size, java.lang.String hash, java.lang.Boolean createParents, java.lang.Long mtime, java.lang.Long ctime, java.lang.Long atime, java.io.InputStream input) Returns a versioned FileCreateRequest that is compatible with the specified apiVersion.
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 FileCreateRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FileCreateRequest 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.
void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

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 FileCreateRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FileCreateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

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

Returns a versioned FileCreateRequest that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the FileCreateRequest

path - path of the file to be created

size - size (in bytes) of the file to be created (optional)

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

createParents - if true, then any parent folders of path that do not already exist should be created. If false, then the operation should fail if any parent folders of path do not exist

input - InputStream containing the new file contents

Returns:

the constructed FileCreateRequest

Throws:

AwUnsupportedApiVersionException

validate

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

Validates this object.

Specified by:

validate in class BaseFssApiResource

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

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

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

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.

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