-
Notifications
You must be signed in to change notification settings - Fork 13k
/
SavepointRestoreSettings.java
194 lines (166 loc) · 6.99 KB
/
SavepointRestoreSettings.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF 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.apache.flink.runtime.jobgraph;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.ReadableConfig;
import org.apache.flink.configuration.StateRecoveryOptions;
import org.apache.flink.core.execution.RestoreMode;
import javax.annotation.Nonnull;
import java.io.Serializable;
import java.util.Objects;
import static org.apache.flink.util.Preconditions.checkNotNull;
/** Savepoint restore settings. */
public class SavepointRestoreSettings implements Serializable {
private static final long serialVersionUID = 87377506900849777L;
/** No restore should happen. */
private static final SavepointRestoreSettings NONE =
new SavepointRestoreSettings(null, false, RestoreMode.NO_CLAIM);
/** Savepoint restore path. */
private final String restorePath;
/**
* Flag indicating whether non restored state is allowed if the savepoint contains state for an
* operator that is not part of the job.
*/
private final boolean allowNonRestoredState;
private final @Nonnull RestoreMode restoreMode;
/**
* Creates the restore settings.
*
* @param restorePath Savepoint restore path.
* @param allowNonRestoredState Ignore unmapped state.
* @param restoreMode how to restore from the savepoint
*/
private SavepointRestoreSettings(
String restorePath, boolean allowNonRestoredState, @Nonnull RestoreMode restoreMode) {
this.restorePath = restorePath;
this.allowNonRestoredState = allowNonRestoredState;
this.restoreMode = restoreMode;
}
/**
* Returns whether to restore from savepoint.
*
* @return <code>true</code> if should restore from savepoint.
*/
public boolean restoreSavepoint() {
return restorePath != null;
}
/**
* Returns the path to the savepoint to restore from.
*
* @return Path to the savepoint to restore from or <code>null</code> if should not restore.
*/
public String getRestorePath() {
return restorePath;
}
/**
* Returns whether non restored state is allowed if the savepoint contains state that cannot be
* mapped back to the job.
*
* @return <code>true</code> if non restored state is allowed if the savepoint contains state
* that cannot be mapped back to the job.
*/
public boolean allowNonRestoredState() {
return allowNonRestoredState;
}
/** Tells how to restore from the given savepoint. */
public @Nonnull RestoreMode getRestoreMode() {
return restoreMode;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
SavepointRestoreSettings that = (SavepointRestoreSettings) o;
return allowNonRestoredState == that.allowNonRestoredState
&& Objects.equals(restorePath, that.restorePath)
&& Objects.equals(restoreMode, that.restoreMode);
}
@Override
public int hashCode() {
int result = restorePath != null ? restorePath.hashCode() : 0;
result = 31 * result + restoreMode.hashCode();
result = 31 * result + (allowNonRestoredState ? 1 : 0);
return result;
}
@Override
public String toString() {
if (restoreSavepoint()) {
return "SavepointRestoreSettings.forPath("
+ "restorePath='"
+ restorePath
+ '\''
+ ", allowNonRestoredState="
+ allowNonRestoredState
+ ", restoreMode="
+ restoreMode
+ ')';
} else {
return "SavepointRestoreSettings.none()";
}
}
// ------------------------------------------------------------------------
public static SavepointRestoreSettings none() {
return NONE;
}
public static SavepointRestoreSettings forPath(String savepointPath) {
return forPath(
savepointPath,
StateRecoveryOptions.SAVEPOINT_IGNORE_UNCLAIMED_STATE.defaultValue());
}
public static SavepointRestoreSettings forPath(
String savepointPath, boolean allowNonRestoredState) {
checkNotNull(savepointPath, "Savepoint restore path.");
return new SavepointRestoreSettings(
savepointPath,
allowNonRestoredState,
StateRecoveryOptions.RESTORE_MODE.defaultValue());
}
public static SavepointRestoreSettings forPath(
String savepointPath, boolean allowNonRestoredState, @Nonnull RestoreMode restoreMode) {
checkNotNull(savepointPath, "Savepoint restore path.");
return new SavepointRestoreSettings(savepointPath, allowNonRestoredState, restoreMode);
}
// -------------------------- Parsing to and from a configuration object
// ------------------------------------
public static void toConfiguration(
final SavepointRestoreSettings savepointRestoreSettings,
final Configuration configuration) {
configuration.set(
StateRecoveryOptions.SAVEPOINT_IGNORE_UNCLAIMED_STATE,
savepointRestoreSettings.allowNonRestoredState());
configuration.set(
StateRecoveryOptions.RESTORE_MODE, savepointRestoreSettings.getRestoreMode());
final String savepointPath = savepointRestoreSettings.getRestorePath();
if (savepointPath != null) {
configuration.set(StateRecoveryOptions.SAVEPOINT_PATH, savepointPath);
}
}
public static SavepointRestoreSettings fromConfiguration(final ReadableConfig configuration) {
final String savepointPath = configuration.get(StateRecoveryOptions.SAVEPOINT_PATH);
final boolean allowNonRestored =
configuration.get(StateRecoveryOptions.SAVEPOINT_IGNORE_UNCLAIMED_STATE);
final RestoreMode restoreMode = configuration.get(StateRecoveryOptions.RESTORE_MODE);
return savepointPath == null
? SavepointRestoreSettings.none()
: SavepointRestoreSettings.forPath(savepointPath, allowNonRestored, restoreMode);
}
}