Describe public interface of Fingerprint

This commit is contained in:
Alex Dadgar 2018-08-20 15:19:08 -07:00
parent 98a67938a0
commit 9ac7dcd1ee
1 changed files with 4 additions and 0 deletions

View File

@ -20,6 +20,10 @@ type devicePluginClient struct {
client proto.DevicePluginClient
}
// Fingerprint is used to retrieve the set of devices and their health from the
// device plugin. An error may be immediately returned if the fingerprint call
// could not be made or as part of the streaming response. If the context is
// cancelled, the error will be propogated.
func (d *devicePluginClient) Fingerprint(ctx context.Context) (<-chan *FingerprintResponse, error) {
var req proto.FingerprintRequest
stream, err := d.client.Fingerprint(ctx, &req)