Package us.kbase.workspace

Class GetObjects2Params

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

    Original spec-file type: GetObjects2Params

     Input parameters for the get_objects2 function.
                 Required parameters:
                 list objects - the list of object specifications
                         for the objects to return (via reference chain and as a subset if
                         specified).
                 Optional parameters:
                 boolean ignoreErrors - Don't throw an exception if an object cannot
                         be accessed; return null for that object's information instead.
                         Default false.
                 boolean infostruct - return the object information as a structure rather than a tuple.
                         Default false. If true, ObjectData.path will be null as it is provided in
                         the ObjectInfo data.
                 boolean no_data - return the provenance, references, and
                         object_info for this object without the object data. Default false.
                 boolean skip_external_system_updates - if the objects contain any external IDs, don't
                         contact external systems to perform any updates for those IDs (often ACL updates,
                         e.g. for handle / blobstore / sample IDs). In some cases this can speed up fetching the
                         data. Default false.
                 boolean batch_external_system_updates - if the objects contain any external IDs,
                         send all external system updates in a batch to each external system when possible
                         rather than object by object. This can potentially speed up the updates, but the
                         drawback is that if the external update fails for any object, all the objects that
                         required updates for that system will be marked as having a failed update.
                         Has no effect if skip_external_system_updates is true. Default false.

    • Constructor Detail

      • GetObjects2Params

        public GetObjects2Params()

    • Method Detail

      • getIgnoreErrors

        public Long getIgnoreErrors()

      • setIgnoreErrors

        public void setIgnoreErrors​(Long ignoreErrors)

      • getInfostruct

        public Long getInfostruct()

      • setInfostruct

        public void setInfostruct​(Long infostruct)

      • getNoData

        public Long getNoData()

      • setNoData

        public void setNoData​(Long noData)

      • getSkipExternalSystemUpdates

        public Long getSkipExternalSystemUpdates()

      • setSkipExternalSystemUpdates

        public void setSkipExternalSystemUpdates​(Long skipExternalSystemUpdates)

      • withSkipExternalSystemUpdates

        public GetObjects2Params withSkipExternalSystemUpdates​(Long skipExternalSystemUpdates)

      • getBatchExternalSystemUpdates

        public Long getBatchExternalSystemUpdates()

      • setBatchExternalSystemUpdates

        public void setBatchExternalSystemUpdates​(Long batchExternalSystemUpdates)

      • withBatchExternalSystemUpdates

        public GetObjects2Params withBatchExternalSystemUpdates​(Long batchExternalSystemUpdates)

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperties

        public void setAdditionalProperties​(String name,
                                    Object value)