Package zowe.client.sdk.zosfiles.uss.methods

Class UssDelete

java.lang.Object

zowe.client.sdk.zosfiles.uss.methods.UssDelete

public class UssDelete
extends Object

Provides Unix System Services (USS) delete object functionality

z/OSMF REST API

Version:

3.0

Author:

James Kostrewski

Constructor Summary

Constructors

Constructor	Description
UssDelete(ZosConnection connection)	UssDelete Constructor
UssDelete(ZosConnection connection, ZosmfRequest request)	Alternative UssDelete constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
Response	delete(String targetPath)	Perform UNIX delete file or directory name request
Response	delete(String targetPath, boolean recursive)	Perform UNIX delete file or directory name request with recursive flag
Response	deleteZfs(String fileSystemName)	Delete UNIX zFS Filesystem

Methods inherited from class java.lang.Object

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

Constructor Detail

UssDelete

public UssDelete(ZosConnection connection)

UssDelete Constructor

Parameters:

connection - connection information, see ZosConnection object

UssDelete

public UssDelete(ZosConnection connection,
                 ZosmfRequest request)

Alternative UssDelete constructor with ZoweRequest object. This is mainly used for internal code unit testing with mockito, and it is not recommended to be used by the larger community.

Parameters:

connection - connection information, see ZosConnection object

request - any compatible ZoweRequest Interface object

Method Detail

delete

public Response delete(String targetPath)
                throws ZosmfRequestException

Perform UNIX delete file or directory name request

Parameters:

targetPath - the name of the file or directory you are going to delete

Returns:

Response object

Throws:

ZosmfRequestException - request error state

delete

public Response delete(String targetPath,
                       boolean recursive)
                throws ZosmfRequestException

Perform UNIX delete file or directory name request with recursive flag

Parameters:

targetPath - the name of the file or directory you are going to delete

recursive - flag indicates if contents of directory should also be deleted

Returns:

Response object

Throws:

ZosmfRequestException - request error state

deleteZfs

public Response deleteZfs(String fileSystemName)
                   throws ZosmfRequestException

Delete UNIX zFS Filesystem

Parameters:

fileSystemName - file system name

Returns:

Response object

Throws:

ZosmfRequestException - request error state