-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathWsLargeDataIO.html
1 lines (1 loc) · 40.3 KB
/
WsLargeDataIO.html
1
<!DOCTYPE html><html><head><title>WsLargeDataIO</title><link rel="stylesheet" href="KIDLspec.css"></head><body><div class="module"><div class="comment"><div>/*</div><div><span class="space"></span><span>*</span><span class="space"></span><span>A KBase module: WsLargeDataIO</span></div><div><span class="space"></span><span>*/</span></div></div><span class="keyword">module</span><span class="space"></span><span class="name">WsLargeDataIO</span><span class="space"></span><span>{</span><br><br><div><span class="typedef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>A boolean - 0 for false, 1 for true.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="annotation">@range</span><span class="space"></span><span>(0, 1)</span></span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">typedef</span><span class="space"></span><span class="primitive">int</span><span class="space"></span><span class="name" id="typedefWsLargeDataIO.boolean">boolean</span><span>;</span></span></div><br><div><span class="typedef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Information about an object, including user provided metadata.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>objid - the numerical id of the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>name - the name of the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>type - the type of the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>save_date - the save date of the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>ver - the version of the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>saved_by - the user that saved or copied the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>wsid - the id of the workspace containing the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>workspace - the name of the workspace containing the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>chsum - the md5 checksum of the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>size - the size of the object in bytes.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>meta - arbitrary user-supplied metadata about</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">typedef</span><span class="space"></span><span><span class="primitive">tuple</span><span><</span><span class="primitive">int</span><span class="space"></span><span class="name">objid</span><span>,</span><span class="space"></span><span class="primitive">string</span><span class="space"></span><span class="name">name</span><span>,</span><span class="space"></span><span class="primitive">string</span><span class="space"></span><span class="name">type</span><span>,</span><span class="space"></span><span class="primitive">string</span><span class="space"></span><span class="name">save_date</span><span>,</span><span class="space"></span><span class="primitive">int</span><span class="space"></span><span class="name">version</span><span>,</span><span class="space"></span><span class="primitive">string</span><span class="space"></span><span class="name">saved_by</span><span>,</span><span class="space"></span><span class="primitive">int</span><span class="space"></span><span class="name">wsid</span><span>,</span><span class="space"></span><span class="primitive">string</span><span class="space"></span><span class="name">workspace</span><span>,</span><span class="space"></span><span class="primitive">string</span><span class="space"></span><span class="name">chsum</span><span>,</span><span class="space"></span><span class="primitive">int</span><span class="space"></span><span class="name">size</span><span>,</span><span class="space"></span><span><span class="primitive">mapping</span><span><</span><span class="primitive">string</span><span>,</span><span class="space"></span><span class="primitive">string</span><span>></span></span><span class="space"></span><span class="name">meta</span><span>></span></span><span class="space"></span><span class="name" id="typedefWsLargeDataIO.object_info">object_info</span><span>;</span></span></div><br><div><span class="typedef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>An object and associated data required for saving.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>Required parameters:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>type - the workspace type string for the object. Omit the version</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>information to use the latest version.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>data_json_file - the path to a JSON file containing the object data.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>Optional parameters:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>One of an object name or id. If no name or id is provided the name</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>will be set to 'auto' with the object id appended as a string,</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>possibly with -\d+ appended if that object id already exists as a</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>name.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>name - the name of the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>objid - the id of the object to save over.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>meta - arbitrary user-supplied metadata for the object,</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>not to exceed 16kb; if the object type specifies automatic</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>metadata extraction with the 'meta ws' annotation, and your</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>metadata name conflicts, then your metadata will be silently</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>overwritten.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>hidden - true if this object should not be listed when listing</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>workspace objects.</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">typedef</span><span class="space"></span><span><span class="primitive">structure</span><span class="space"></span><span>{</span><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">string</span><span class="space"></span><span class="name">type</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">string</span><span class="space"></span><span class="name">data_json_file</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">string</span><span class="space"></span><span class="name">name</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">int</span><span class="space"></span><span class="name">objid</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span><span class="primitive">mapping</span><span><</span><span class="primitive">string</span><span>,</span><span class="space"></span><span class="primitive">string</span><span>></span></span><span class="space"></span><span class="name">meta</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.boolean">boolean</a></span><span class="space"></span><span class="name">hidden</span><span>;</span></span></div><span class="tab"></span><span>}</span></span><span class="space"></span><span class="name" id="typedefWsLargeDataIO.ObjectSaveData">ObjectSaveData</span><span>;</span></span></div><br><div><span class="typedef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Input parameters for the "save_objects" function.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>Required parameters:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>id - the numerical ID of the workspace.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>workspace - optional workspace name alternative to id.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>objects - the objects to save.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>The object provenance is automatically pulled from the SDK runner.</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">typedef</span><span class="space"></span><span><span class="primitive">structure</span><span class="space"></span><span>{</span><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">int</span><span class="space"></span><span class="name">id</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">string</span><span class="space"></span><span class="name">workspace</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span><span class="primitive">list</span><span><</span><span class="name"><a href="#typedefWsLargeDataIO.ObjectSaveData">ObjectSaveData</a></span><span>></span></span><span class="space"></span><span class="name">objects</span><span>;</span></span></div><span class="tab"></span><span>}</span></span><span class="space"></span><span class="name" id="typedefWsLargeDataIO.SaveObjectsParams">SaveObjectsParams</span><span>;</span></span></div><br><div><span class="funcdef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Save objects to the workspace. Saving over a deleted object undeletes</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>it.</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">funcdef</span><span class="space"></span><span class="name" id="funcdefWsLargeDataIO.save_objects">save_objects</span><span>(</span><span class="parameters"><span class="parameter"><span class="name"><a href="#typedefWsLargeDataIO.SaveObjectsParams">SaveObjectsParams</a></span><span class="space"></span><span class="name">params</span></span></span><span>)</span><span class="space"></span><span class="keyword">returns</span><span>(</span><span class="returns"><span class="parameter"><span><span class="primitive">list</span><span><</span><span class="name"><a href="#typedefWsLargeDataIO.object_info">object_info</a></span><span>></span></span><span class="space"></span><span class="name">info</span></span></span><span>)</span><span class="space"></span><span class="keyword">authentication</span><span class="space"></span><span class="keyword">required</span><span>;</span></span></div><br><div><span class="typedef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>An Object Specification (OS). Inherits from ObjectIdentity.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Specifies which object, and which parts of that object, to retrieve</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>from the Workspace Service.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>The fields wsid, workspace, objid, name, ver, and ref are identical to</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>the ObjectIdentity fields.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>REFERENCE FOLLOWING:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Reference following guarantees that a user that has access to an</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>object can always see a) objects that are referenced inside the object</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>and b) objects that are referenced in the object's provenance. This</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>ensures that the user has visibility into the entire provenance of the</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>object and the object's object dependencies (e.g. references).</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>The user must have at least read access to the object specified in this</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>SO, but need not have access to any further objects in the reference</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>chain, and those objects may be deleted.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Optional reference following fields:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>list<string> obj_ref_path - a path to the desired object from the object</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>specified in this OS. In other words, the object specified in this</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>OS is assumed to be accessible to the user, and the objects in</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>the object path represent a chain of references to the desired</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>object at the end of the object path. If the references are all</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>valid, the desired object will be returned.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>OBJECT SUBSETS:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>When selecting a subset of an array in an object, the returned</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>array is compressed to the size of the subset, but the ordering of</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>the array is maintained. For example, if the array stored at the</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>'feature' key of a Genome object has 4000 entries, and the object paths</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>provided are:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>/feature/7</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>/feature/3015</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>/feature/700</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>The returned feature array will be of length three and the entries will</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>consist, in order, of the 7th, 700th, and 3015th entries of the</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>original array.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Optional object subset fields:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>list<string> included - the portions of the object to include</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>in the object subset.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>boolean strict_maps - if true, throw an exception if the subset</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>specification traverses a non-existant map key (default false)</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>boolean strict_arrays - if true, throw an exception if the subset</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>specification exceeds the size of an array (default true)</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">typedef</span><span class="space"></span><span><span class="primitive">structure</span><span class="space"></span><span>{</span><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">string</span><span class="space"></span><span class="name">workspace</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">int</span><span class="space"></span><span class="name">wsid</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">string</span><span class="space"></span><span class="name">name</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">int</span><span class="space"></span><span class="name">objid</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">int</span><span class="space"></span><span class="name">ver</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">string</span><span class="space"></span><span class="name">ref</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span><span class="primitive">list</span><span><</span><span class="primitive">string</span><span>></span></span><span class="space"></span><span class="name">obj_ref_path</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span><span class="primitive">list</span><span><</span><span class="primitive">string</span><span>></span></span><span class="space"></span><span class="name">included</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.boolean">boolean</a></span><span class="space"></span><span class="name">strict_maps</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.boolean">boolean</a></span><span class="space"></span><span class="name">strict_arrays</span><span>;</span></span></div><span class="tab"></span><span>}</span></span><span class="space"></span><span class="name" id="typedefWsLargeDataIO.ObjectSpecification">ObjectSpecification</span><span>;</span></span></div><br><div><span class="typedef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Input parameters for the "get_objects" function.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>Required parameters:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>object_refs - a list of object references in the form X/Y/Z, where X is</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>the workspace name or id, Y is the object name or id, and Z is the</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>(optional) object version. In general, always use ids rather than</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>names if possible to avoid race conditions.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>Optional parameters:</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>ignore_errors - ignore any errors that occur when fetching an object</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>and instead insert a null into the returned list.</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">typedef</span><span class="space"></span><span><span class="primitive">structure</span><span class="space"></span><span>{</span><div><span><span class="tab"></span><span class="tab"></span><span><span class="primitive">list</span><span><</span><span class="name"><a href="#typedefWsLargeDataIO.ObjectSpecification">ObjectSpecification</a></span><span>></span></span><span class="space"></span><span class="name">objects</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.boolean">boolean</a></span><span class="space"></span><span class="name">ignore_errors</span><span>;</span></span></div><span class="tab"></span><span>}</span></span><span class="space"></span><span class="name" id="typedefWsLargeDataIO.GetObjectsParams">GetObjectsParams</span><span>;</span></span></div><br><div><span class="typedef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>The data and supplemental info for an object.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>UnspecifiedObject data - the object's data or subset data.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>object_info info - information about the object.</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">typedef</span><span class="space"></span><span><span class="primitive">structure</span><span class="space"></span><span>{</span><div><span><span class="tab"></span><span class="tab"></span><span class="primitive">string</span><span class="space"></span><span class="name">data_json_file</span><span>;</span></span></div><div><span><span class="tab"></span><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.object_info">object_info</a></span><span class="space"></span><span class="name">info</span><span>;</span></span></div><span class="tab"></span><span>}</span></span><span class="space"></span><span class="name" id="typedefWsLargeDataIO.ObjectData">ObjectData</span><span>;</span></span></div><br><div><span class="typedef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Results from the get_objects function.</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span></span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span><span class="space"></span><span class="space"></span><span class="space"></span><span class="space"></span>list<ObjectData> data - the returned objects.</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">typedef</span><span class="space"></span><span><span class="primitive">structure</span><span class="space"></span><span>{</span><div><span><span class="tab"></span><span class="tab"></span><span><span class="primitive">list</span><span><</span><span class="name"><a href="#typedefWsLargeDataIO.ObjectData">ObjectData</a></span><span>></span></span><span class="space"></span><span class="name">data</span><span>;</span></span></div><span class="tab"></span><span>}</span></span><span class="space"></span><span class="name" id="typedefWsLargeDataIO.GetObjectsResults">GetObjectsResults</span><span>;</span></span></div><br><div><span class="funcdef"><div class="comment"><div><span class="tab"></span><span>/*</span></div><div><span class="tab"></span><span class="space"></span><span>*</span><span class="space"></span><span>Get objects from the workspace.</span></div><div><span class="tab"></span><span class="space"></span><span>*/</span></div></div><span class="tab"></span><span class="keyword">funcdef</span><span class="space"></span><span class="name" id="funcdefWsLargeDataIO.get_objects">get_objects</span><span>(</span><span class="parameters"><span class="parameter"><span class="name"><a href="#typedefWsLargeDataIO.GetObjectsParams">GetObjectsParams</a></span><span class="space"></span><span class="name">params</span></span></span><span>)</span><span class="space"></span><span class="keyword">returns</span><span>(</span><span class="returns"><span class="parameter"><span class="name"><a href="#typedefWsLargeDataIO.GetObjectsResults">GetObjectsResults</a></span><span class="space"></span><span class="name">results</span></span></span><span>)</span><span class="space"></span><span class="keyword">authentication</span><span class="space"></span><span class="keyword">required</span><span>;</span></span></div><span>}</span><span>;</span></div><div class="index"><h2>Function Index</h2><div><span class="tab"></span><span class="name"><a href="#funcdefWsLargeDataIO.get_objects">get_objects</a></span></div><div><span class="tab"></span><span class="name"><a href="#funcdefWsLargeDataIO.save_objects">save_objects</a></span></div><h2>Type Index</h2><div><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.boolean">boolean</a></span></div><div><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.GetObjectsParams">GetObjectsParams</a></span></div><div><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.GetObjectsResults">GetObjectsResults</a></span></div><div><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.object_info">object_info</a></span></div><div><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.ObjectData">ObjectData</a></span></div><div><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.ObjectSaveData">ObjectSaveData</a></span></div><div><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.ObjectSpecification">ObjectSpecification</a></span></div><div><span class="tab"></span><span class="name"><a href="#typedefWsLargeDataIO.SaveObjectsParams">SaveObjectsParams</a></span></div></div></body></html>