All Classes and Interfaces
Class
Description
Adds a set of principals to a security group.
Command for obtaining information about the current assay definitions
in a particular folder.
Response class for the
AssayListCommand.Common methods implemented by SelectRowsCommand and ExecuteSqlCommand
Utility class to parse a .properties file and produce reasonable exceptions if required properties aren't present.
Command<ResponseType extends CommandResponse,RequestType extends org.apache.hc.client5.http.classic.methods.HttpUriRequest>
Abstract base class for all API commands.
An enum of common parameter names used in API URLs.
Response class allows clients to get an InputStream, consume lazily, and close the connection when complete.
Represents an exception that occurs while executing a command.
Represents the details of a response returned from the LabKey Server.
Bean class for defining a conditional format for a field.
Grids will conditionally apply the specified styling to the associated field.
Grids will conditionally apply the specified styling to the associated field.
Bean defining a filter used to control when conditional formatting should be applied to a field.
Represents connection information for a particular LabKey Server.
Represents a container filter that can be used with the
ExecuteSqlCommand and the SelectRowsCommand.Create a new LabKey Freezer Manager storage item that can be used in the creation of a storage hierarchy.
Create a container (project/folder/workbook) on the server
Command class for creating a new domain.
Similar to CreateContainerCommand, but supports creating folders from a template
Creates a new user group.
Similar to CreateContainerCommand, but supports the "Project Creator" role and creating projects from a template
Create a new user account on the server.
Represents a data file that may be used in a run.
Delete an existing LabKey Freezer Manager storage item.
Delete a container (project/folder/workbook) and all of its children.
Response from a DeleteContainerResponse.
Deletes the existing group corresponding to the group id.
Command for deleting rows from a read-write schema.
Deletes existing users based on userIds
If it executed without exception, the users have been deleted
Assumes a running LabKey Server with an "API Test" project containing:
- The People list imported from People.xls in this repository
- A wiki page named "home".
Bean that defines a domain for creating, updating, or reading.
Response object for commands that expect the server to return a serialized domain.
Command to delete a domain.
Simply ensures that the connection is associated with an authenticated user.
Command for executing arbitrary LabKey SQL.
Base class for experiment objects, including Run, Data, Batch, etc
Notifies the server that files may have become available for the pipeline to process.
Server response from FileNotificationCommand.
Represents a filter definition for a query
Command for obtaining information about a run in a particular folder.
Base class for all commands that use get
Command for obtaining the list of queries available within a given schema.
Represents the response from a GetQueriesCommand.
Command for obtaining the list of queries available within a given schema.
Represents the response from a GetQueriesCommand.
Command to obtain the list of schemas available in a given folder path.
Represents the response of a GetSchemasCommand.
Returns a list of users given selection criteria.
The result of a GetUsersCommand request.
Information about a single user that matched the request
Base class for AddGroupMembersCommand and RemoveGroupMembersCommand
A credentials provider that provides no credentials.
For site-admins or project-admins only, start impersonating a user.
Import data in bulk from a text, local file, or a file
contained within a module on the LabKey Server.
Import a new assay run.
Command for inserting rows into a table in a read-write schema.
Command for obtaining information about the current batch in a particular folder.
Ends the current HTTP session, if any is active.
Command for moving rows from a compatible schema table.
Demo code that accepts one or more CSV files on the command line.
Command for obtaining information about the current assay definitions
in a particular folder.
Response class for the
NAbRunsCommand.Attempts to find a .netrc or _netrc file and entry for the given host.
A client-side representation of a participant group from a study on the server.
Demo code that notifies server that files may become available under a pipeline root, which releases
queued pipeline jobs that are blocked awaiting those files.
Base class for all commands that need to post data to the server, rather than providing parameters
in the query string.
Removes a set of principals from a security group.
Rename a container on the server
Renames an existing group.
Resets the stored state of an ETL, allowing it to be rerun from scratch by forgetting any retained last modified dates
or similar.
Base class for objects mapped from subsets of response JSON
Provides a format-neutral way of obtaining a row's value.
Provides an iterable interface over the response rows that hides
the differences between the simple and extended response formats.
Represents a single assay run
Queues an ETL to run on the server.
Saves an assay batch on the server.
Five command line args:
1.
Saves runs on the server.
Base class for commands that make changes to rows exposed from a given
query in a given schema.
Response object used for commands that derive from SaveRowsCommand.
Command for selecting data from any LabKey schema/query exposed on the
server identified by the Connection object supplied to the
Command.execute(org.labkey.remoteapi.Connection, String) method.The command response class returned from the
Command.execute(org.labkey.remoteapi.Connection, String)
method.An enumeration of the possible column data types
Represents a particular sort order entry,
which consists of a column name and an optional direction
Command for executing arbitrary LabKey SQL.
Initiates an MS2 search.
The set of supported search engines, which may or may not be available on any given server
Stop impersonating a user, group, or role(s).
Command for truncating a table from a read-write schema.
Response object used for commands that derive from TruncateTableCommand.
Update an existing LabKey Freezer Manager storage item to change its properties or location within the freezer hierarchy.
Request to be sent to the server to update an existing participant group
Special subclass that allows specifying just participants that should be added
or removed, without needing to specify the full set of participants.
Result of making a request to the server to update an existing participant group
Command for updating rows into a table in a read-write schema.