Skip to content

Commit 6cc3611

Browse files
prwhelanprwhelan
committed
Rename to CrossProjectModeOptions
1 parent e15fc1a commit 6cc3611

File tree

4 files changed

+51
-49
lines changed

4 files changed

+51
-49
lines changed

‎server/src/main/java/org/elasticsearch/action/admin/indices/rollover/TransportRolloverAction.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ protected ClusterBlockException checkBlock(RolloverRequest request, ClusterState
160160
.matchClosed(request.indicesOptions().expandWildcardsClosed())
161161
.build(),
162162
IndicesOptions.GatekeeperOptions.DEFAULT,
163-
IndicesOptions.ResolutionModeOptions.DEFAULT
163+
IndicesOptions.CrossProjectModeOptions.DEFAULT
164164
);
165165
ResolvedExpression resolvedRolloverTarget = SelectorResolver.parseExpression(request.getRolloverTarget(), request.indicesOptions());
166166
final IndexAbstraction indexAbstraction = projectMetadata.getIndicesLookup().get(resolvedRolloverTarget.resource());
@@ -257,7 +257,7 @@ protected void masterOperation(
257257
IndicesOptions.ConcreteTargetOptions.ALLOW_UNAVAILABLE_TARGETS,
258258
IndicesOptions.WildcardOptions.builder().matchClosed(true).allowEmptyExpressions(false).build(),
259259
IndicesOptions.GatekeeperOptions.DEFAULT,
260-
IndicesOptions.ResolutionModeOptions.DEFAULT
260+
IndicesOptions.CrossProjectModeOptions.DEFAULT
261261
);
262262
// Make sure to recombine any selectors on the stats request
263263
IndicesStatsRequest statsRequest = new IndicesStatsRequest().indices(resolvedRolloverTarget.combined())

‎server/src/main/java/org/elasticsearch/action/support/IndicesOptions.java‎

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public record IndicesOptions(
5252
ConcreteTargetOptions concreteTargetOptions,
5353
WildcardOptions wildcardOptions,
5454
GatekeeperOptions gatekeeperOptions,
55-
ResolutionModeOptions resolutionModeOptions
55+
CrossProjectModeOptions crossProjectModeOptions
5656
) implements ToXContentFragment {
5757

5858
public static IndicesOptions.Builder builder() {
@@ -417,37 +417,37 @@ public static Builder builder(GatekeeperOptions gatekeeperOptions) {
417417
}
418418

419419
/**
420-
* The resolution mode options are internal-only options that apply on all indices that have been selected by the other Options. These
421-
* options may contextually change over the lifetime of the request.
422-
* @param crossProject determines that the index expression must be resolved for cross-project requests, defaults to false.
420+
* The cross-project mode options are internal-only options that apply on all indices that have been selected by the other Options.
421+
* These options may contextually change over the lifetime of the request.
422+
* @param resolveIndexExpression determines that the index expression must be resolved for cross-project requests, defaults to false.
423423
*/
424-
public record ResolutionModeOptions(boolean crossProject) implements ToXContentFragment, Writeable {
424+
public record CrossProjectModeOptions(boolean resolveIndexExpression) implements ToXContentFragment, Writeable {
425425

426-
public static final ResolutionModeOptions DEFAULT = new ResolutionModeOptions(false);
426+
public static final CrossProjectModeOptions DEFAULT = new CrossProjectModeOptions(false);
427427

428428
private static final TransportVersion INDICES_OPTIONS_RESOLUTION_MODE = TransportVersion.fromName(
429429
"indices_options_resolution_mode"
430430
);
431431

432-
private static final String CROSS_PROJECT_NAME = "resolve_cross_project";
432+
private static final String INDEX_EXPRESSION_NAME = "resolve_cross_project_index_expression";
433433

434434
@Override
435435
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
436-
return builder.field(CROSS_PROJECT_NAME, crossProject);
436+
return builder.field(INDEX_EXPRESSION_NAME, resolveIndexExpression);
437437
}
438438

439439
@Override
440440
public void writeTo(StreamOutput out) throws IOException {
441441
if (out.getTransportVersion().supports(INDICES_OPTIONS_RESOLUTION_MODE)) {
442-
out.writeBoolean(crossProject);
442+
out.writeBoolean(resolveIndexExpression);
443443
}
444444
}
445445

446-
public static ResolutionModeOptions readFrom(StreamInput in) throws IOException {
446+
public static CrossProjectModeOptions readFrom(StreamInput in) throws IOException {
447447
if (in.getTransportVersion().supports(INDICES_OPTIONS_RESOLUTION_MODE)) {
448-
return new ResolutionModeOptions(in.readBoolean());
448+
return new CrossProjectModeOptions(in.readBoolean());
449449
} else {
450-
return ResolutionModeOptions.DEFAULT;
450+
return CrossProjectModeOptions.DEFAULT;
451451
}
452452
}
453453
}
@@ -503,7 +503,7 @@ private enum Option {
503503
ConcreteTargetOptions.ERROR_WHEN_UNAVAILABLE_TARGETS,
504504
WildcardOptions.DEFAULT,
505505
GatekeeperOptions.DEFAULT,
506-
ResolutionModeOptions.DEFAULT
506+
CrossProjectModeOptions.DEFAULT
507507
);
508508

509509
public static final IndicesOptions STRICT_EXPAND_OPEN = IndicesOptions.builder()
@@ -900,8 +900,8 @@ public boolean ignoreThrottled() {
900900
/**
901901
* @return whether indices will resolve to the cross-project "flat world" expression
902902
*/
903-
public boolean resolveCrossProject() {
904-
return resolutionModeOptions().crossProject();
903+
public boolean resolveCrossProjectIndexExpression() {
904+
return crossProjectModeOptions().resolveIndexExpression();
905905
}
906906

907907
public void writeIndicesOptions(StreamOutput out) throws IOException {
@@ -964,7 +964,7 @@ public void writeIndicesOptions(StreamOutput out) throws IOException {
964964
out.writeByte((byte) 0); // ordinal 0 (::data selector)
965965
}
966966
}
967-
out.writeWriteable(resolutionModeOptions);
967+
out.writeWriteable(crossProjectModeOptions);
968968
}
969969

970970
public static IndicesOptions readIndicesOptions(StreamInput in) throws IOException {
@@ -1017,15 +1017,15 @@ public static IndicesOptions readIndicesOptions(StreamInput in) throws IOExcepti
10171017
: ConcreteTargetOptions.ERROR_WHEN_UNAVAILABLE_TARGETS,
10181018
wildcardOptions,
10191019
gatekeeperOptions,
1020-
ResolutionModeOptions.readFrom(in)
1020+
CrossProjectModeOptions.readFrom(in)
10211021
);
10221022
}
10231023

10241024
public static class Builder {
10251025
private ConcreteTargetOptions concreteTargetOptions;
10261026
private WildcardOptions wildcardOptions;
10271027
private GatekeeperOptions gatekeeperOptions;
1028-
private ResolutionModeOptions resolutionModeOptions;
1028+
private CrossProjectModeOptions crossProjectModeOptions;
10291029

10301030
Builder() {
10311031
this(DEFAULT);
@@ -1035,7 +1035,7 @@ public static class Builder {
10351035
concreteTargetOptions = indicesOptions.concreteTargetOptions;
10361036
wildcardOptions = indicesOptions.wildcardOptions;
10371037
gatekeeperOptions = indicesOptions.gatekeeperOptions;
1038-
resolutionModeOptions = indicesOptions.resolutionModeOptions;
1038+
crossProjectModeOptions = indicesOptions.crossProjectModeOptions;
10391039
}
10401040

10411041
public Builder concreteTargetOptions(ConcreteTargetOptions concreteTargetOptions) {
@@ -1063,13 +1063,13 @@ public Builder gatekeeperOptions(GatekeeperOptions.Builder generalOptions) {
10631063
return this;
10641064
}
10651065

1066-
public Builder resolutionModeOptions(ResolutionModeOptions resolutionModeOptions) {
1067-
this.resolutionModeOptions = resolutionModeOptions;
1066+
public Builder crossProjectModeOptions(CrossProjectModeOptions crossProjectModeOptions) {
1067+
this.crossProjectModeOptions = crossProjectModeOptions;
10681068
return this;
10691069
}
10701070

10711071
public IndicesOptions build() {
1072-
return new IndicesOptions(concreteTargetOptions, wildcardOptions, gatekeeperOptions, resolutionModeOptions);
1072+
return new IndicesOptions(concreteTargetOptions, wildcardOptions, gatekeeperOptions, crossProjectModeOptions);
10731073
}
10741074
}
10751075

@@ -1172,7 +1172,7 @@ public static IndicesOptions fromOptions(
11721172
ignoreUnavailable ? ConcreteTargetOptions.ALLOW_UNAVAILABLE_TARGETS : ConcreteTargetOptions.ERROR_WHEN_UNAVAILABLE_TARGETS,
11731173
wildcards,
11741174
gatekeeperOptions,
1175-
ResolutionModeOptions.DEFAULT
1175+
CrossProjectModeOptions.DEFAULT
11761176
);
11771177
}
11781178

@@ -1215,7 +1215,7 @@ public static boolean isIndicesOptions(String name) {
12151215
|| "ignoreThrottled".equals(name)
12161216
|| WildcardOptions.ALLOW_NO_INDICES.equals(name)
12171217
|| "allowNoIndices".equals(name)
1218-
|| ResolutionModeOptions.CROSS_PROJECT_NAME.equals(name);
1218+
|| CrossProjectModeOptions.INDEX_EXPRESSION_NAME.equals(name);
12191219
}
12201220

12211221
public static IndicesOptions fromParameters(
@@ -1260,15 +1260,15 @@ public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params par
12601260
concreteTargetOptions.toXContent(builder, params);
12611261
wildcardOptions.toXContent(builder, params);
12621262
gatekeeperOptions.toXContent(builder, params);
1263-
resolutionModeOptions.toXContent(builder, params);
1263+
crossProjectModeOptions.toXContent(builder, params);
12641264
return builder;
12651265
}
12661266

12671267
private static final ParseField EXPAND_WILDCARDS_FIELD = new ParseField(WildcardOptions.EXPAND_WILDCARDS);
12681268
private static final ParseField IGNORE_UNAVAILABLE_FIELD = new ParseField(ConcreteTargetOptions.IGNORE_UNAVAILABLE);
12691269
private static final ParseField IGNORE_THROTTLED_FIELD = new ParseField(GatekeeperOptions.IGNORE_THROTTLED).withAllDeprecated();
12701270
private static final ParseField ALLOW_NO_INDICES_FIELD = new ParseField(WildcardOptions.ALLOW_NO_INDICES);
1271-
private static final ParseField RESOLVE_CROSS_PROJECT = new ParseField(ResolutionModeOptions.CROSS_PROJECT_NAME);
1271+
private static final ParseField RESOLVE_CROSS_PROJECT = new ParseField(CrossProjectModeOptions.INDEX_EXPRESSION_NAME);
12721272

12731273
public static IndicesOptions fromXContent(XContentParser parser) throws IOException {
12741274
return fromXContent(parser, null);
@@ -1281,7 +1281,9 @@ public static IndicesOptions fromXContent(XContentParser parser, @Nullable Indic
12811281
.ignoreThrottled(defaults != null && defaults.gatekeeperOptions().ignoreThrottled());
12821282
Boolean allowNoIndices = defaults == null ? null : defaults.allowNoIndices();
12831283
Boolean ignoreUnavailable = defaults == null ? null : defaults.ignoreUnavailable();
1284-
boolean resolveCrossProject = defaults == null ? ResolutionModeOptions.DEFAULT.crossProject() : defaults.resolveCrossProject();
1284+
boolean resolveCrossProjectIndexExpression = defaults == null
1285+
? CrossProjectModeOptions.DEFAULT.resolveIndexExpression()
1286+
: defaults.resolveCrossProjectIndexExpression();
12851287
Token token = parser.currentToken() == Token.START_OBJECT ? parser.currentToken() : parser.nextToken();
12861288
String currentFieldName = null;
12871289
if (token != Token.START_OBJECT) {
@@ -1330,7 +1332,7 @@ public static IndicesOptions fromXContent(XContentParser parser, @Nullable Indic
13301332
} else if (IGNORE_THROTTLED_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
13311333
generalOptions.ignoreThrottled(parser.booleanValue());
13321334
} else if (RESOLVE_CROSS_PROJECT.match(currentFieldName, parser.getDeprecationHandler())) {
1333-
resolveCrossProject = parser.booleanValue();
1335+
resolveCrossProjectIndexExpression = parser.booleanValue();
13341336
} else {
13351337
throw new ElasticsearchParseException(
13361338
"could not read indices options. Unexpected index option [" + currentFieldName + "]"
@@ -1361,7 +1363,7 @@ public static IndicesOptions fromXContent(XContentParser parser, @Nullable Indic
13611363
.concreteTargetOptions(new ConcreteTargetOptions(ignoreUnavailable))
13621364
.wildcardOptions(wildcards)
13631365
.gatekeeperOptions(generalOptions)
1364-
.resolutionModeOptions(new ResolutionModeOptions(resolveCrossProject))
1366+
.crossProjectModeOptions(new CrossProjectModeOptions(resolveCrossProjectIndexExpression))
13651367
.build();
13661368
}
13671369

@@ -1523,8 +1525,8 @@ public String toString() {
15231525
+ allowSelectors()
15241526
+ ", include_failure_indices="
15251527
+ includeFailureIndices()
1526-
+ ", resolve_cross_project="
1527-
+ resolveCrossProject()
1528+
+ ", resolve_cross_project_index_expression="
1529+
+ resolveCrossProjectIndexExpression()
15281530
+ ']';
15291531
}
15301532
}

‎server/src/test/java/org/elasticsearch/action/support/IndicesOptionsTests.java‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
package org.elasticsearch.action.support;
1111

1212
import org.elasticsearch.action.support.IndicesOptions.ConcreteTargetOptions;
13+
import org.elasticsearch.action.support.IndicesOptions.CrossProjectModeOptions;
1314
import org.elasticsearch.action.support.IndicesOptions.GatekeeperOptions;
14-
import org.elasticsearch.action.support.IndicesOptions.ResolutionModeOptions;
1515
import org.elasticsearch.action.support.IndicesOptions.WildcardOptions;
1616
import org.elasticsearch.common.bytes.BytesReference;
1717
import org.elasticsearch.common.io.stream.BytesStreamOutput;
@@ -58,7 +58,7 @@ public void testSerialization() throws Exception {
5858
.allowClosedIndices(randomBoolean())
5959
.allowSelectors(randomBoolean())
6060
)
61-
.resolutionModeOptions(new ResolutionModeOptions(randomBoolean()))
61+
.crossProjectModeOptions(new CrossProjectModeOptions(randomBoolean()))
6262
.build();
6363

6464
BytesStreamOutput output = new BytesStreamOutput();
@@ -104,7 +104,7 @@ public void testFromOptions() {
104104
assertThat(indicesOptions.forbidClosedIndices(), equalTo(forbidClosedIndices));
105105
assertEquals(ignoreAliases, indicesOptions.ignoreAliases());
106106
assertEquals(ignoreThrottled, indicesOptions.ignoreThrottled());
107-
assertEquals(indicesOptions.resolveCrossProject(), ResolutionModeOptions.DEFAULT.crossProject());
107+
assertEquals(indicesOptions.resolveCrossProjectIndexExpression(), CrossProjectModeOptions.DEFAULT.resolveIndexExpression());
108108
}
109109

110110
public void testFromOptionsWithDefaultOptions() {
@@ -141,7 +141,7 @@ public void testFromOptionsWithDefaultOptions() {
141141
assertEquals(defaultOptions.allowAliasesToMultipleIndices(), indicesOptions.allowAliasesToMultipleIndices());
142142
assertEquals(defaultOptions.forbidClosedIndices(), indicesOptions.forbidClosedIndices());
143143
assertEquals(defaultOptions.ignoreAliases(), indicesOptions.ignoreAliases());
144-
assertEquals(defaultOptions.resolveCrossProject(), indicesOptions.resolveCrossProject());
144+
assertEquals(defaultOptions.resolveCrossProjectIndexExpression(), indicesOptions.resolveCrossProjectIndexExpression());
145145
}
146146

147147
public void testFromParameters() {
@@ -205,7 +205,7 @@ public void testFromParameters() {
205205
assertEquals(defaultOptions.allowAliasesToMultipleIndices(), updatedOptions.allowAliasesToMultipleIndices());
206206
assertEquals(defaultOptions.forbidClosedIndices(), updatedOptions.forbidClosedIndices());
207207
assertEquals(defaultOptions.ignoreAliases(), updatedOptions.ignoreAliases());
208-
assertEquals(defaultOptions.resolveCrossProject(), updatedOptions.resolveCrossProject());
208+
assertEquals(defaultOptions.resolveCrossProjectIndexExpression(), updatedOptions.resolveCrossProjectIndexExpression());
209209
}
210210

211211
public void testEqualityAndHashCode() {
@@ -335,7 +335,7 @@ public void testFromMap() {
335335
assertEquals(ignoreUnavailable == null ? defaults.ignoreUnavailable() : ignoreUnavailable, fromMap.ignoreUnavailable());
336336
assertEquals(allowNoIndices == null ? defaults.allowNoIndices() : allowNoIndices, fromMap.allowNoIndices());
337337
assertEquals(ignoreThrottled == null ? defaults.ignoreThrottled() : ignoreThrottled, fromMap.ignoreThrottled());
338-
assertEquals(fromMap.resolveCrossProject(), ResolutionModeOptions.DEFAULT.crossProject());
338+
assertEquals(fromMap.resolveCrossProjectIndexExpression(), CrossProjectModeOptions.DEFAULT.resolveIndexExpression());
339339
}
340340

341341
public void testToXContent() throws IOException {
@@ -354,13 +354,13 @@ public void testToXContent() throws IOException {
354354
randomBoolean(),
355355
randomBoolean()
356356
);
357-
ResolutionModeOptions resolutionModeOptions = new ResolutionModeOptions(randomBoolean());
357+
CrossProjectModeOptions crossProjectModeOptions = new CrossProjectModeOptions(randomBoolean());
358358

359359
IndicesOptions indicesOptions = new IndicesOptions(
360360
concreteTargetOptions,
361361
wildcardOptions,
362362
gatekeeperOptions,
363-
resolutionModeOptions
363+
crossProjectModeOptions
364364
);
365365

366366
XContentType type = randomFrom(XContentType.values());
@@ -376,7 +376,7 @@ public void testToXContent() throws IOException {
376376
assertThat(map.get("ignore_unavailable"), equalTo(concreteTargetOptions.allowUnavailableTargets()));
377377
assertThat(map.get("allow_no_indices"), equalTo(wildcardOptions.allowEmptyExpressions()));
378378
assertThat(map.get("ignore_throttled"), equalTo(gatekeeperOptions.ignoreThrottled()));
379-
assertThat(map.get("resolve_cross_project"), equalTo(resolutionModeOptions.crossProject()));
379+
assertThat(map.get("resolve_cross_project_index_expression"), equalTo(crossProjectModeOptions.resolveIndexExpression()));
380380
}
381381

382382
public void testFromXContent() throws IOException {
@@ -388,12 +388,12 @@ public void testFromXContent() throws IOException {
388388
randomBoolean()
389389
);
390390
ConcreteTargetOptions concreteTargetOptions = new ConcreteTargetOptions(randomBoolean());
391-
ResolutionModeOptions resolutionModeOptions = new ResolutionModeOptions(randomBoolean());
391+
CrossProjectModeOptions crossProjectModeOptions = new CrossProjectModeOptions(randomBoolean());
392392

393393
IndicesOptions indicesOptions = IndicesOptions.builder()
394394
.concreteTargetOptions(concreteTargetOptions)
395395
.wildcardOptions(wildcardOptions)
396-
.resolutionModeOptions(resolutionModeOptions)
396+
.crossProjectModeOptions(crossProjectModeOptions)
397397
.build();
398398

399399
XContentType type = randomFrom(XContentType.values());
@@ -412,7 +412,7 @@ public void testFromXContent() throws IOException {
412412
assertEquals(indicesOptions.ignoreUnavailable(), fromXContentOptions.ignoreUnavailable());
413413
assertEquals(indicesOptions.allowNoIndices(), fromXContentOptions.allowNoIndices());
414414
assertEquals(indicesOptions.ignoreThrottled(), fromXContentOptions.ignoreThrottled());
415-
assertEquals(indicesOptions.resolveCrossProject(), fromXContentOptions.resolveCrossProject());
415+
assertEquals(indicesOptions.resolveCrossProjectIndexExpression(), fromXContentOptions.resolveCrossProjectIndexExpression());
416416
}
417417

418418
public void testFromXContentWithWildcardSpecialValues() throws IOException {
@@ -439,7 +439,7 @@ public void testFromXContentWithWildcardSpecialValues() throws IOException {
439439
assertTrue(fromXContentOptions.expandWildcardsClosed());
440440
assertTrue(fromXContentOptions.expandWildcardsHidden());
441441
assertTrue(fromXContentOptions.expandWildcardsOpen());
442-
assertFalse(fromXContentOptions.resolveCrossProject());
442+
assertFalse(fromXContentOptions.resolveCrossProjectIndexExpression());
443443

444444
try (XContentBuilder builder = XContentFactory.contentBuilder(type)) {
445445
builder.startObject();
@@ -458,7 +458,7 @@ public void testFromXContentWithWildcardSpecialValues() throws IOException {
458458
assertFalse(fromXContentOptions.expandWildcardsClosed());
459459
assertFalse(fromXContentOptions.expandWildcardsHidden());
460460
assertFalse(fromXContentOptions.expandWildcardsOpen());
461-
assertFalse(fromXContentOptions.resolveCrossProject());
461+
assertFalse(fromXContentOptions.resolveCrossProjectIndexExpression());
462462
}
463463

464464
public void testFromXContentWithDefaults() throws Exception {
@@ -512,7 +512,7 @@ public void testFromXContentWithDefaults() throws Exception {
512512
}
513513
assertEquals(ignoreUnavailable, fromXContentOptions.ignoreUnavailable());
514514
assertEquals(expectedWildcardStates, fromXContentOptions.wildcardOptions());
515-
assertFalse(fromXContentOptions.resolveCrossProject());
515+
assertFalse(fromXContentOptions.resolveCrossProjectIndexExpression());
516516
}
517517

518518
private BytesReference toXContentBytes(IndicesOptions indicesOptions, XContentType type) throws IOException {

0 commit comments

Comments
 (0)