Skip to content

Commit 2bf269e

Browse files
committed
Fix docs for MappingUpdatedAction
Follow-up to #31140
1 parent f707fa9 commit 2bf269e

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

server/src/main/java/org/elasticsearch/cluster/action/index/MappingUpdatedAction.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
package org.elasticsearch.cluster.action.index;
2121

2222
import org.elasticsearch.action.admin.indices.mapping.put.PutMappingRequestBuilder;
23+
import org.elasticsearch.action.support.master.MasterNodeRequest;
2324
import org.elasticsearch.client.Client;
2425
import org.elasticsearch.client.IndicesAdminClient;
2526
import org.elasticsearch.common.inject.Inject;
@@ -78,11 +79,12 @@ public void updateMappingOnMaster(Index index, String type, Mapping mappingUpdat
7879
}
7980

8081
/**
81-
* Update mappings synchronously on the master node, waiting for at most
82-
* {@code timeout}. When this method returns successfully mappings have
83-
* been applied to the master node and propagated to data nodes.
82+
* Update mappings on the master node, waiting for the change to be committed,
83+
* but not for the mapping update to be applied on all nodes. The timeout specified by
84+
* {@code timeout} is the master node timeout ({@link MasterNodeRequest#masterNodeTimeout()}),
85+
* potentially waiting for a master node to be available.
8486
*/
85-
public void updateMappingOnMaster(Index index, String type, Mapping mappingUpdate, TimeValue timeout) {
86-
updateMappingRequest(index, type, mappingUpdate, timeout).get();
87+
public void updateMappingOnMaster(Index index, String type, Mapping mappingUpdate, TimeValue masterNodeTimeout) {
88+
updateMappingRequest(index, type, mappingUpdate, masterNodeTimeout).get();
8789
}
8890
}

0 commit comments

Comments
 (0)