com.hds.hcpaw.fss.api.model

Class PathMetadataGetRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.PathMetadataGetRequest

public abstract class PathMetadataGetRequest
extends BaseFssApiResource

A request to get information (metadata) about 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 PathMetadataGetRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a PathMetadataGetRequest from the JSON string representation contained in the reader.
static PathMetadataGetRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Boolean includeDeleted) Returns a versioned PathMetadataGetRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends PathMetadataGetRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the PathMetadataGetRequest that corresponds to the specified apiVersion.
java.lang.Boolean	getIncludeDeleted()
java.lang.String	getPath() Returns the path of the file or folder that you are getting metadata about.
protected 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 PathMetadataGetRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                        throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the PathMetadataGetRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static PathMetadataGetRequest create(FssApiVersion apiVersion,
                                            java.lang.String path,
                                            java.lang.Boolean includeDeleted)
                                     throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the PathMetadataGetRequest

path - path of the file or folder which you are getting metadata about

includeDeleted - whether to include deleted item

Returns:

the constructed PathMetadataGetRequest

Throws:

AwUnsupportedApiVersionException

create

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

Constructs a PathMetadataGetRequest from the JSON string representation contained in the reader.

Parameters:

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

reader - contains the JSON string representation of a PathMetadataGetRequest

Returns:

the constructed PathMetadataGetRequest

Throws:

AwJsonException

AwUnsupportedApiVersionException

getPath

public java.lang.String getPath()

Returns the path of the file or folder that you are getting metadata about.

Returns:

the path of the file or folder that you are getting metadata about

getIncludeDeleted

public java.lang.Boolean getIncludeDeleted()

validate

protected 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)