forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HLRC: create base timed request class (elastic#33216)
There are many requests that allow the user to set a few timeouts on. This class will allow requests impl'd in HLRC to extend from, and allow users to set those values without significant work to add them to every request.
- Loading branch information
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
client/rest-high-level/src/main/java/org/elasticsearch/client/TimedRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
package org.elasticsearch.client; | ||
|
||
import org.elasticsearch.common.unit.TimeValue; | ||
|
||
/** | ||
* A base request for any requests that supply timeouts. | ||
* | ||
* Please note, any requests that use a ackTimeout should set timeout as they | ||
* represent the same backing field on the server. | ||
*/ | ||
public class TimedRequest implements Validatable { | ||
|
||
private TimeValue timeout; | ||
private TimeValue masterTimeout; | ||
|
||
public void setTimeout(TimeValue timeout) { | ||
this.timeout = timeout; | ||
|
||
} | ||
|
||
public void setMasterTimeout(TimeValue masterTimeout) { | ||
this.masterTimeout = masterTimeout; | ||
} | ||
|
||
/** | ||
* Returns the request timeout | ||
*/ | ||
public TimeValue timeout() { | ||
return timeout; | ||
} | ||
|
||
/** | ||
* Returns the timeout for the request to be completed on the master node | ||
*/ | ||
public TimeValue masterNodeTimeout() { | ||
return masterTimeout; | ||
} | ||
} |