This repository has been archived by the owner on Sep 29, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 233
/
RolloutOptions.java
230 lines (197 loc) · 6.42 KB
/
RolloutOptions.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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/*-
* -\-\-
* Helios Client
* --
* Copyright (C) 2016 Spotify AB
* --
* Licensed 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 com.spotify.helios.common.descriptors;
import static com.google.common.base.MoreObjects.firstNonNull;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import org.jetbrains.annotations.Nullable;
/**
* Represents a deployment group's rollout options.
*
* <p>An sample expression of it in JSON might be:
* <pre>
* {
* "migrate": false,
* "parallelism": 2,
* "timeout": 1000,
* "overlap": true,
* "token": "insecure-access-token",
* "ignoreFailures": false
* }
* </pre>
*/
@JsonIgnoreProperties(ignoreUnknown = true)
public class RolloutOptions {
private static final long DEFAULT_TIMEOUT = TimeUnit.MINUTES.toSeconds(5);
private static final int DEFAULT_PARALLELISM = 1;
static final boolean DEFAULT_MIGRATE = false;
private static final boolean DEFAULT_OVERLAP = false;
static final String DEFAULT_TOKEN = Job.EMPTY_TOKEN;
static final boolean DEFAULT_IGNORE_FAILURES = false;
private static final RolloutOptions DEFAULT = RolloutOptions.newBuilder()
.setTimeout(DEFAULT_TIMEOUT)
.setParallelism(DEFAULT_PARALLELISM)
.setMigrate(DEFAULT_MIGRATE)
.setOverlap(DEFAULT_OVERLAP)
.setToken(DEFAULT_TOKEN)
.setIgnoreFailures(DEFAULT_IGNORE_FAILURES)
.build();
private final Long timeout;
private final Integer parallelism;
private final Boolean migrate;
private final Boolean overlap;
private final String token;
private final Boolean ignoreFailures;
private RolloutOptions(@JsonProperty("timeout") @Nullable final Long timeout,
@JsonProperty("parallelism") @Nullable final Integer parallelism,
@JsonProperty("migrate") @Nullable final Boolean migrate,
@JsonProperty("overlap") @Nullable final Boolean overlap,
@JsonProperty("token") @Nullable final String token,
@JsonProperty("ignoreFailures") @Nullable final Boolean ignoreFailures) {
this.timeout = timeout;
this.parallelism = parallelism;
this.migrate = migrate;
this.overlap = overlap;
this.token = token;
this.ignoreFailures = ignoreFailures;
}
public static RolloutOptions getDefault() {
return DEFAULT;
}
public static Builder newBuilder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder()
.setTimeout(timeout)
.setParallelism(parallelism)
.setMigrate(migrate)
.setOverlap(overlap)
.setToken(token)
.setIgnoreFailures(ignoreFailures);
}
/**
* Return a new RolloutOptions instance by merging this instance with another one.
* @throws NullPointerException if any attribute in both instances are null.
*/
public RolloutOptions withFallback(final RolloutOptions that) {
return RolloutOptions.newBuilder()
.setTimeout(firstNonNull(timeout, that.timeout))
.setParallelism(firstNonNull(parallelism, that.parallelism))
.setMigrate(firstNonNull(migrate, that.migrate))
.setOverlap(firstNonNull(overlap, that.overlap))
.setToken(firstNonNull(token, that.token))
.setIgnoreFailures(firstNonNull(ignoreFailures, that.ignoreFailures))
.build();
}
@Nullable
public Long getTimeout() {
return timeout;
}
@Nullable
public Integer getParallelism() {
return parallelism;
}
@Nullable
public Boolean getMigrate() {
return migrate;
}
@Nullable
public Boolean getOverlap() {
return overlap;
}
@Nullable
public String getToken() {
return token;
}
@Nullable
public Boolean getIgnoreFailures() {
return ignoreFailures;
}
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
final RolloutOptions that = (RolloutOptions) obj;
return Objects.equals(this.migrate, that.migrate)
&& Objects.equals(this.parallelism, that.parallelism)
&& Objects.equals(this.timeout, that.timeout)
&& Objects.equals(this.overlap, that.overlap)
&& Objects.equals(this.token, that.token)
&& Objects.equals(this.ignoreFailures, that.ignoreFailures);
}
@Override
public int hashCode() {
return Objects.hash(timeout, parallelism, migrate, overlap, token, ignoreFailures);
}
@Override
public String toString() {
return "RolloutOptions{"
+ "timeout=" + timeout
+ ", parallelism=" + parallelism
+ ", migrate=" + migrate
+ ", overlap=" + overlap
+ ", token=" + token
+ ", ignoreFailures=" + ignoreFailures
+ '}';
}
public static class Builder {
private Long timeout;
private Integer parallelism;
private Boolean migrate;
private Boolean overlap;
private String token;
private Boolean ignoreFailures;
public Builder() { }
public Builder setTimeout(final Long timeout) {
this.timeout = timeout;
return this;
}
public Builder setParallelism(final Integer parallelism) {
this.parallelism = parallelism;
return this;
}
public Builder setMigrate(final Boolean migrate) {
this.migrate = migrate;
return this;
}
public Builder setOverlap(final Boolean overlap) {
this.overlap = overlap;
return this;
}
public Builder setToken(final String token) {
this.token = token;
return this;
}
public Builder setIgnoreFailures(final Boolean ignoreFailures) {
this.ignoreFailures = ignoreFailures;
return this;
}
public RolloutOptions build() {
return new RolloutOptions(timeout, parallelism, migrate, overlap, token, ignoreFailures);
}
}
}