com.hds.hcpaw.fss.api.model

Class DeletePathRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.DeletePathRequest

public abstract class DeletePathRequest
extends BaseFssApiResource

A request to delete a file or folder.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static DeletePathRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a DeletePathRequest from the JSON string representation contained in the specified reader.
static DeletePathRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Boolean recursive, java.lang.String etag) Returns a versioned DeletePathRequest that is compatible with the specified apiVersion.
java.lang.String	getEtag() Returns the etag that should correspond to the current entry at path.
static java.lang.Class<? extends DeletePathRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the DeletePathRequest that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path of the entry to delete.
java.lang.Boolean	isRecursive() If the entry is a folder, whether to recursively delete all the contents of the folder.
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 DeletePathRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the DeletePathRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static DeletePathRequest create(FssApiVersion apiVersion,
                                       java.lang.String path,
                                       java.lang.Boolean recursive,
                                       java.lang.String etag)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the DeletePathRequest

path - path of the file or folder to delete

recursive - true indicates that the files and folders of the provided path should be recursively deleted. False indicates that the files and folders of the provided path should not be recursively deleted.

etag - the etag of the entry currently at the specified path

Returns:

the constructed DeletePathRequest

Throws:

AwUnsupportedApiVersionException

create

public static DeletePathRequest create(FssApiVersion apiVersion,
                                       java.io.InputStreamReader reader)
                                throws AwJsonException,
                                       AwUnsupportedApiVersionException

Constructs a DeletePathRequest from the JSON string representation contained in the specified reader.

Parameters:

apiVersion - API version of the object to be read from reader

reader - contains the JSON string representation of a DeletePathRequest

Returns:

the constructed DeletePathRequest

Throws:

AwJsonException

AwUnsupportedApiVersionException

validate

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

Validates this object. Implementers of this method should call the various validate methods in this class for the fields in the class. For example, if an implementing class has a required field called foo and an optional field called bar, then this method should call BaseFssApiResource.validateRequiredField(String, BaseFssApiResource, String) for foo, and BaseFssApiResource.validateOptionalField(String, BaseFssApiResource) for bar.

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

getPath

public java.lang.String getPath()

Returns the path of the entry to delete.

isRecursive

public java.lang.Boolean isRecursive()

If the entry is a folder, whether to recursively delete all the contents of the folder. Ignored for files.

Returns:

true indicates that the files and folders of the provided path should be recursively deleted. False indicates that the files and folders of the provided path should not be recursively deleted.

getEtag

public java.lang.String getEtag()

Returns the etag that should correspond to the current entry at path.