Package us.kbase.workspace

Class RenameObjectParams

java.lang.Object

us.kbase.workspace.RenameObjectParams

@Generated("com.googlecode.jsonschema2pojo")
public class RenameObjectParams
extends Object

Original spec-file type: RenameObjectParams

 Input parameters for the 'rename_object' function.
                 Required arguments:
                 ObjectIdentity obj - the object to rename.
                 obj_name new_name - the new name for the object.
 

Constructor Summary

Constructors

Constructor	Description
RenameObjectParams()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalProperties()
String	getNewName()
ObjectIdentity	getObj()	Original spec-file type: ObjectIdentity
void	setAdditionalProperties(String name, Object value)
void	setNewName(String newName)
void	setObj(ObjectIdentity obj)	Original spec-file type: ObjectIdentity
String	toString()
RenameObjectParams	withNewName(String newName)
RenameObjectParams	withObj(ObjectIdentity obj)

Methods inherited from class java.lang.Object

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

Constructor Detail

RenameObjectParams

public RenameObjectParams()

Method Detail

getObj

public ObjectIdentity getObj()

Original spec-file type: ObjectIdentity

 An object identifier.
                 Select an object by either:
                         One, and only one, of the numerical id or name of the workspace.
                                 ws_id wsid - the numerical ID of the workspace.
                                 ws_name workspace - the name of the workspace.
                         AND
                         One, and only one, of the numerical id or name of the object.
                                 obj_id objid- the numerical ID of the object.
                                 obj_name name - name of the object.
                         OPTIONALLY
                                 obj_ver ver - the version of the object.
                 OR an object reference string:
                         obj_ref ref - an object reference string.
 

setObj

public void setObj(ObjectIdentity obj)

Original spec-file type: ObjectIdentity

 An object identifier.
                 Select an object by either:
                         One, and only one, of the numerical id or name of the workspace.
                                 ws_id wsid - the numerical ID of the workspace.
                                 ws_name workspace - the name of the workspace.
                         AND
                         One, and only one, of the numerical id or name of the object.
                                 obj_id objid- the numerical ID of the object.
                                 obj_name name - name of the object.
                         OPTIONALLY
                                 obj_ver ver - the version of the object.
                 OR an object reference string:
                         obj_ref ref - an object reference string.
 

withObj

public RenameObjectParams withObj(ObjectIdentity obj)

getNewName

public String getNewName()

setNewName

public void setNewName(String newName)

withNewName

public RenameObjectParams withNewName(String newName)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperties

public void setAdditionalProperties(String name,
                                    Object value)

toString

public String toString()

Overrides:

toString in class Object