Package us.kbase.workspace

Class CopyObjectParams

java.lang.Object

us.kbase.workspace.CopyObjectParams

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

Original spec-file type: CopyObjectParams

 Input parameters for the 'copy_object' function.
                 If the 'from' ObjectIdentity includes no version and the object is
                 copied to a new name, the entire version history of the object is
                 copied. In all other cases only the version specified, or the latest
                 version if no version is specified, is copied.
                 The version from the 'to' ObjectIdentity is always ignored.
                 Required arguments:
                 ObjectIdentity from - the object to copy.
                 ObjectIdentity to - where to copy the object.
 

Constructor Summary

Constructors

Constructor	Description
CopyObjectParams()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalProperties()
ObjectIdentity	getFrom()	Original spec-file type: ObjectIdentity
ObjectIdentity	getTo()	Original spec-file type: ObjectIdentity
void	setAdditionalProperties(String name, Object value)
void	setFrom(ObjectIdentity from)	Original spec-file type: ObjectIdentity
void	setTo(ObjectIdentity to)	Original spec-file type: ObjectIdentity
String	toString()
CopyObjectParams	withFrom(ObjectIdentity from)
CopyObjectParams	withTo(ObjectIdentity to)

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyObjectParams

public CopyObjectParams()

Method Detail

getFrom

public ObjectIdentity getFrom()

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.
 

setFrom

public void setFrom(ObjectIdentity from)

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.
 

withFrom

public CopyObjectParams withFrom(ObjectIdentity from)

getTo

public ObjectIdentity getTo()

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.
 

setTo

public void setTo(ObjectIdentity to)

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.
 

withTo

public CopyObjectParams withTo(ObjectIdentity to)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperties

public void setAdditionalProperties(String name,
                                    Object value)

toString

public String toString()

Overrides:

toString in class Object