node-deadline/lib/slaves/README.md

Module to interface with Deadline Compute Management System by Thinkbox Software

#Deadline.slaves NOT IMPLEMENTED

Ownes all functionality related to deadline slaves.

###Deadline.slaves.get( options, callback )

Base function for retrieving slave information from Deadline, takes an options object defining which slaves to get.
With no options or an empty options object, this function returns all slaves.

**NOTE:** Deadline.slaves.get is also provided under Deadline.get.slaves for better code clarity if desired.
(ie: `deadline.slaves.get.by.id === deadline.get.jobs.by.id`)

####Options

**id:** *get only slaves with the given names(s)* ( string | array[string] )
```
{ name: "Slave01" }
{ name: ["Slave01", "Slave02"] }
```

####Callback

Called when the query is complete, takes two parameters: error and results

- **error:** a Deadline.Error object or null if OK<br/>
- **results:** an array of jobs mathing the request, empty if none found, null if there was a fatal error

###Deadline.slaves.get.by

This object provides all of the above available options in Deadline.slaves.get
as individual functions for better code clarity, if applicable

```javascript
deadline.slaves.get.by.id( "55b911f1ec46630980bba101" );
```

###Deadline.slaves.get.any( properties, callback )

The same as Deadline.slaves.get() but mathches any of the given properties rather than all of them.

####Callback

Called when the query is complete, takes two parameters: error and results

- **error:** a Deadline.Error object or null if OK<br/>
- **results:** an array of slaves mathing the request, empty if none found, null if there was a fatal error

###Deadline.slaves.get.find( query, callback )

Accepts a raw MongoDB query to use in the
[collection.find](http://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#find) method.
*This methond is used internally by all other get methods, and should not be used when another suitable get method exists for
the query in question*

##Deadline.slaves.Slave

Represents a singular ative slave from the Deadline database ( [readme](./Slave.md) ).