Package us.kbase.workspace

Class ObjectData

  • @Generated("com.googlecode.jsonschema2pojo")
public class ObjectData
extends java.lang.Object

    Original spec-file type: ObjectData

     The data and supplemental info for an object.
                 UnspecifiedObject data - the object's data or subset data.
                 object_info info - information about the object.
                 ObjectInfo infostruct - information about the object as a structure rather than a tuple.
                 list path - the path to the object through the object reference graph. All the
                         references in the path are absolute.
                 list provenance - the object's provenance.
                 username creator - the user that first saved the object to the workspace.
                 ws_id orig_wsid - the id of the workspace in which this object was
                                 originally saved. Missing for objects saved prior to version
                                 0.4.1.
                 timestamp created - the date the object was first saved to the
                         workspace.
                 epoch epoch - the date the object was first saved to the
                         workspace.
                 list refs - the references contained within the object.
                 obj_ref copied - the reference of the source object if this object is
                         a copy and the copy source exists and is accessible.
                         null otherwise.
                 boolean copy_source_inaccessible - true if the object was copied from
                         another object, but that object is no longer accessible to the
                         user. False otherwise.
                 mapping> extracted_ids - any ids extracted
                         from the object.
                 string handle_error - if an error occurs while setting ACLs on
                         embedded external IDs, it will be reported here. If not for historical reasons the
                         parameter would be called "external_id_error".
                 string handle_stacktrace - the stacktrace for handle_error. As above, the parameter
                         should be called "external_id_stacktrace".

    • Constructor Detail

      • ObjectData

        public ObjectData()

    • Method Detail

      • getData

        public UObject getData()

      • setData

        public void setData​(UObject data)

      • getInfo

        public Tuple11<java.lang.Long,​java.lang.String,​java.lang.String,​java.lang.String,​java.lang.Long,​java.lang.String,​java.lang.Long,​java.lang.String,​java.lang.String,​java.lang.Long,​java.util.Map<java.lang.String,​java.lang.String>> getInfo()

      • setInfo

        public void setInfo​(Tuple11<java.lang.Long,​java.lang.String,​java.lang.String,​java.lang.String,​java.lang.Long,​java.lang.String,​java.lang.Long,​java.lang.String,​java.lang.String,​java.lang.Long,​java.util.Map<java.lang.String,​java.lang.String>> info)

      • withInfo

        public ObjectData withInfo​(Tuple11<java.lang.Long,​java.lang.String,​java.lang.String,​java.lang.String,​java.lang.Long,​java.lang.String,​java.lang.Long,​java.lang.String,​java.lang.String,​java.lang.Long,​java.util.Map<java.lang.String,​java.lang.String>> info)

      • getInfostruct

        public ObjectInfo getInfostruct()

        Original spec-file type: ObjectInfo

         Information about an object as a struct rather than a tuple.
 This allows adding fields in a backward compatible way in the future.
 Includes more fields than object_info.
 obj_id objid - the numerical id of the object.
 obj_name name - the name of the object.
 type_string type - the type of the object.
 timestamp save_date - the save date of the object.
 obj_ver ver - the version of the object.
 username saved_by - the user that saved or copied the object.
 ws_id wsid - the workspace containing the object.
 ws_name workspace - the workspace containing the object.
 string chsum - the md5 checksum of the object.
 int size - the size of the object in bytes.
 usermeta meta - arbitrary user-supplied metadata about the object.
 usermeta adminmeta - service administrator metadata set on an object. Unlike most
         other object fields, admin metadata is mutable.
 list path - the path to the object.

      • setInfostruct

        public void setInfostruct​(ObjectInfo infostruct)

        Original spec-file type: ObjectInfo

         Information about an object as a struct rather than a tuple.
 This allows adding fields in a backward compatible way in the future.
 Includes more fields than object_info.
 obj_id objid - the numerical id of the object.
 obj_name name - the name of the object.
 type_string type - the type of the object.
 timestamp save_date - the save date of the object.
 obj_ver ver - the version of the object.
 username saved_by - the user that saved or copied the object.
 ws_id wsid - the workspace containing the object.
 ws_name workspace - the workspace containing the object.
 string chsum - the md5 checksum of the object.
 int size - the size of the object in bytes.
 usermeta meta - arbitrary user-supplied metadata about the object.
 usermeta adminmeta - service administrator metadata set on an object. Unlike most
         other object fields, admin metadata is mutable.
 list path - the path to the object.

      • getPath

        public java.util.List<java.lang.String> getPath()

      • setPath

        public void setPath​(java.util.List<java.lang.String> path)

      • withPath

        public ObjectData withPath​(java.util.List<java.lang.String> path)

      • setProvenance

        public void setProvenance​(java.util.List<ProvenanceAction> provenance)

      • getCreator

        public java.lang.String getCreator()

      • setCreator

        public void setCreator​(java.lang.String creator)

      • withCreator

        public ObjectData withCreator​(java.lang.String creator)

      • getOrigWsid

        public java.lang.Long getOrigWsid()

      • setOrigWsid

        public void setOrigWsid​(java.lang.Long origWsid)

      • withOrigWsid

        public ObjectData withOrigWsid​(java.lang.Long origWsid)

      • getCreated

        public java.lang.String getCreated()

      • setCreated

        public void setCreated​(java.lang.String created)

      • withCreated

        public ObjectData withCreated​(java.lang.String created)

      • getEpoch

        public java.lang.Long getEpoch()

      • setEpoch

        public void setEpoch​(java.lang.Long epoch)

      • withEpoch

        public ObjectData withEpoch​(java.lang.Long epoch)

      • getRefs

        public java.util.List<java.lang.String> getRefs()

      • setRefs

        public void setRefs​(java.util.List<java.lang.String> refs)

      • withRefs

        public ObjectData withRefs​(java.util.List<java.lang.String> refs)

      • getCopied

        public java.lang.String getCopied()

      • setCopied

        public void setCopied​(java.lang.String copied)

      • withCopied

        public ObjectData withCopied​(java.lang.String copied)

      • getCopySourceInaccessible

        public java.lang.Long getCopySourceInaccessible()

      • setCopySourceInaccessible

        public void setCopySourceInaccessible​(java.lang.Long copySourceInaccessible)

      • withCopySourceInaccessible

        public ObjectData withCopySourceInaccessible​(java.lang.Long copySourceInaccessible)

      • getExtractedIds

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getExtractedIds()

      • setExtractedIds

        public void setExtractedIds​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> extractedIds)

      • withExtractedIds

        public ObjectData withExtractedIds​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> extractedIds)

      • getHandleError

        public java.lang.String getHandleError()

      • setHandleError

        public void setHandleError​(java.lang.String handleError)

      • withHandleError

        public ObjectData withHandleError​(java.lang.String handleError)

      • getHandleStacktrace

        public java.lang.String getHandleStacktrace()

      • setHandleStacktrace

        public void setHandleStacktrace​(java.lang.String handleStacktrace)

      • withHandleStacktrace

        public ObjectData withHandleStacktrace​(java.lang.String handleStacktrace)

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • setAdditionalProperties

        public void setAdditionalProperties​(java.lang.String name,
                                    java.lang.Object value)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object