Package us.kbase.workspace

Class CloneWorkspaceParams

java.lang.Object

us.kbase.workspace.CloneWorkspaceParams

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

Original spec-file type: CloneWorkspaceParams

 Input parameters for the "clone_workspace" function.
                 Note that deleted objects are not cloned, although hidden objects are
                 and remain hidden in the new workspace.
                 Required arguments:
                 WorkspaceIdentity wsi - the workspace to be cloned.
                 ws_name workspace - name of the workspace to be cloned into. This must
                         be a non-existant workspace name.
                 Optional arguments:
                 permission globalread - 'r' to set the new workspace globally readable,
                         default 'n'.
                 string description - A free-text description of the new workspace, 1000
                         characters max. Longer strings will be mercilessly and brutally
                         truncated.
                 usermeta meta - arbitrary user-supplied metadata for the workspace.
                 list exclude - exclude the specified objects from the
                         cloned workspace. Either an object ID or a object name must be
                         specified in each ObjectIdentity - any supplied reference strings,
                         workspace names or IDs, and versions are ignored.
 

Constructor Summary

Constructors

Constructor	Description
CloneWorkspaceParams()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalProperties()
String	getDescription()
List<ObjectIdentity>	getExclude()
String	getGlobalread()
Map<String,String>	getMeta()
String	getWorkspace()
WorkspaceIdentity	getWsi()	Original spec-file type: WorkspaceIdentity
void	setAdditionalProperties(String name, Object value)
void	setDescription(String description)
void	setExclude(List<ObjectIdentity> exclude)
void	setGlobalread(String globalread)
void	setMeta(Map<String,String> meta)
void	setWorkspace(String workspace)
void	setWsi(WorkspaceIdentity wsi)	Original spec-file type: WorkspaceIdentity
String	toString()
CloneWorkspaceParams	withDescription(String description)
CloneWorkspaceParams	withExclude(List<ObjectIdentity> exclude)
CloneWorkspaceParams	withGlobalread(String globalread)
CloneWorkspaceParams	withMeta(Map<String,String> meta)
CloneWorkspaceParams	withWorkspace(String workspace)
CloneWorkspaceParams	withWsi(WorkspaceIdentity wsi)

Methods inherited from class java.lang.Object

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

Constructor Detail

CloneWorkspaceParams

public CloneWorkspaceParams()

Method Detail

getWsi

public WorkspaceIdentity getWsi()

Original spec-file type: WorkspaceIdentity

 A workspace identifier.
                 Select a workspace by one, and only one, of the numerical id or name.
                 ws_id id - the numerical ID of the workspace.
                 ws_name workspace - the name of the workspace.
 

setWsi

public void setWsi(WorkspaceIdentity wsi)

Original spec-file type: WorkspaceIdentity

 A workspace identifier.
                 Select a workspace by one, and only one, of the numerical id or name.
                 ws_id id - the numerical ID of the workspace.
                 ws_name workspace - the name of the workspace.
 

withWsi

public CloneWorkspaceParams withWsi(WorkspaceIdentity wsi)

getWorkspace

public String getWorkspace()

setWorkspace

public void setWorkspace(String workspace)

withWorkspace

public CloneWorkspaceParams withWorkspace(String workspace)

getGlobalread

public String getGlobalread()

setGlobalread

public void setGlobalread(String globalread)

withGlobalread

public CloneWorkspaceParams withGlobalread(String globalread)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

withDescription

public CloneWorkspaceParams withDescription(String description)

getMeta

public Map<String,String> getMeta()

setMeta

public void setMeta(Map<String,String> meta)

withMeta

public CloneWorkspaceParams withMeta(Map<String,String> meta)

getExclude

public List<ObjectIdentity> getExclude()

setExclude

public void setExclude(List<ObjectIdentity> exclude)

withExclude

public CloneWorkspaceParams withExclude(List<ObjectIdentity> exclude)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperties

public void setAdditionalProperties(String name,
                                    Object value)

toString

public String toString()

Overrides:

toString in class Object