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

Class UssChangeTag

java.lang.Object

zowe.client.sdk.zosfiles.uss.methods.UssChangeTag

public class UssChangeTag
extends Object

Provides Unix System Services (USS) chtag functionality

z/OSMF REST API

Version:

4.0

Author:

James Kostrewski, Frank Giordano

Constructor Summary

Constructors

Constructor	Description
UssChangeTag(ZosConnection connection)	UssChangeTag Constructor

Method Summary

Modifier and Type	Method	Description
Response	binary(String fileNamePath)	Change the tag of a UNIX file to a binary type
Response	changeCommon(String fileNamePath, ChangeTagParams params)	Change tag of a UNIX file request driven by ChangeTagParams object settings
Response	get(String fileNamePath)	Retrieve existing UNIX file tag information
Response	remove(String fileNamePath)	Remove tag of a UNIX file
Response	text(String fileNamePath, String codeSet)	Change the tag of a UNIX file to a text type

Methods inherited from class java.lang.Object

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

Constructor Detail

UssChangeTag

public UssChangeTag(ZosConnection connection)

UssChangeTag Constructor

Parameters:

connection - for connection information, see ZosConnection object

Method Detail

binary

public Response binary(String fileNamePath)
                throws ZosmfRequestException

Change the tag of a UNIX file to a binary type

Parameters:

fileNamePath - file name with a path

Returns:

Response Object

Throws:

ZosmfRequestException - request error state

text

public Response text(String fileNamePath,
                     String codeSet)
              throws ZosmfRequestException

Change the tag of a UNIX file to a text type

Parameters:

fileNamePath - file name with a path

codeSet - code set name. i.e., IBM-1047

Returns:

Response Object

Throws:

ZosmfRequestException - request error state

remove

public Response remove(String fileNamePath)
                throws ZosmfRequestException

Remove tag of a UNIX file

Parameters:

fileNamePath - file name with a path

Returns:

Response Object

Throws:

ZosmfRequestException - request error state

get

public Response get(String fileNamePath)
             throws ZosmfRequestException

Retrieve existing UNIX file tag information

Parameters:

fileNamePath - file name with a path

Returns:

Response Object

Throws:

ZosmfRequestException - request error state

changeCommon

public Response changeCommon(String fileNamePath,
                             ChangeTagParams params)
                      throws ZosmfRequestException

Change tag of a UNIX file request driven by ChangeTagParams object settings

Parameters:

fileNamePath - file name with a path

params - for parameters for the change tag request, see ChangeTagParams object

Returns:

Response Object

Throws:

ZosmfRequestException - request error state