Skip to content

Commit 8202f0b

Browse files
committed
update godoc string for UpdateAlloc
1 parent 6e1f1d8 commit 8202f0b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

nomad/node_endpoint.go

+5-2
Original file line numberDiff line numberDiff line change
@@ -1189,8 +1189,11 @@ func (n *Node) GetClientAllocs(args *structs.NodeSpecificRequest,
11891189
// UpdateAlloc is used to update the client status of an allocation. It should
11901190
// only be called by clients.
11911191
//
1192-
// Clients must first register and heartbeat successfully before they are able
1193-
// to call this method.
1192+
// Calling this method returns an error when:
1193+
// - The node is not registered in the server yet. Clients must first call the
1194+
// Register method.
1195+
// - The node status is down or disconnected. Clients must call the
1196+
// UpdateStatus method to update its status in the server.
11941197
func (n *Node) UpdateAlloc(args *structs.AllocUpdateRequest, reply *structs.GenericResponse) error {
11951198
// Ensure the connection was initiated by another client if TLS is used.
11961199
err := validateTLSCertificateLevel(n.srv, n.ctx, tlsCertificateLevelClient)

0 commit comments

Comments
 (0)