Skip to content

Commit 8df138b

Browse files
committed
Rename id to generatedId for Dns resources
1 parent d4faad3 commit 8df138b

File tree

16 files changed

+175
-168
lines changed

16 files changed

+175
-168
lines changed

gcloud-java-dns/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ ZoneInfo zoneInfo = ZoneInfo.of(zoneName, domainName, description);
125125

126126
// Create zone in Google Cloud DNS
127127
Zone zone = dns.create(zoneInfo);
128-
System.out.printf("Zone was created and assigned ID %s.%n", zone.id());
128+
System.out.printf("Zone was created and assigned ID %s.%n", zone.generatedId());
129129
```
130130

131131
You now have an empty zone hosted in Google Cloud DNS which is ready to be populated with
@@ -226,7 +226,7 @@ while (ChangeRequestInfo.Status.PENDING.equals(changeRequest.status())) {
226226
} catch (InterruptedException e) {
227227
System.err.println("The thread was interrupted while waiting...");
228228
}
229-
changeRequest = dns.getChangeRequest(zone.name(), changeRequest.id());
229+
changeRequest = dns.getChangeRequest(zone.name(), changeRequest.generatedId());
230230
}
231231
System.out.println("The change request has been applied.");
232232
```
@@ -315,7 +315,7 @@ if (!changeRequest.deletions().isEmpty()) {
315315
}
316316

317317
// Update the change, but fetch only change ID and status
318-
changeRequest = dns.getChangeRequest(zoneName, changeRequest.id(), option);
318+
changeRequest = dns.getChangeRequest(zoneName, changeRequest.generatedId(), option);
319319
}
320320
}
321321

gcloud-java-dns/src/main/java/com/google/gcloud/dns/ChangeRequest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ public Builder removeDeletion(RecordSet recordSet) {
103103
}
104104

105105
@Override
106-
Builder id(String id) {
107-
infoBuilder.id(id);
106+
Builder generatedId(String generatedId) {
107+
infoBuilder.generatedId(generatedId);
108108
return this;
109109
}
110110

gcloud-java-dns/src/main/java/com/google/gcloud/dns/ChangeRequestInfo.java

+20-20
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ public ChangeRequestInfo apply(Change pb) {
4747
return ChangeRequestInfo.fromPb(pb);
4848
}
4949
};
50-
private static final long serialVersionUID = -9027378042756366333L;
50+
private static final long serialVersionUID = -6029143477639439169L;
5151
private final List<RecordSet> additions;
5252
private final List<RecordSet> deletions;
53-
private final String id;
53+
private final String generatedId;
5454
private final Long startTimeMillis;
5555
private final ChangeRequestInfo.Status status;
5656

@@ -119,9 +119,9 @@ public abstract static class Builder {
119119
public abstract Builder removeDeletion(RecordSet recordSet);
120120

121121
/**
122-
* Associates a server-assigned id to this {@code ChangeRequestInfo}.
122+
* Associates a service-generated id to this {@code ChangeRequestInfo}.
123123
*/
124-
abstract Builder id(String id);
124+
abstract Builder generatedId(String generatedId);
125125

126126
/**
127127
* Sets the time when this change request was started by a server.
@@ -143,7 +143,7 @@ public abstract static class Builder {
143143
static class BuilderImpl extends Builder {
144144
private List<RecordSet> additions;
145145
private List<RecordSet> deletions;
146-
private String id;
146+
private String generatedId;
147147
private Long startTimeMillis;
148148
private ChangeRequestInfo.Status status;
149149

@@ -155,7 +155,7 @@ static class BuilderImpl extends Builder {
155155
BuilderImpl(ChangeRequestInfo info) {
156156
this.additions = Lists.newLinkedList(info.additions());
157157
this.deletions = Lists.newLinkedList(info.deletions());
158-
this.id = info.id();
158+
this.generatedId = info.generatedId;
159159
this.startTimeMillis = info.startTimeMillis;
160160
this.status = info.status;
161161
}
@@ -214,8 +214,8 @@ public ChangeRequestInfo build() {
214214
}
215215

216216
@Override
217-
Builder id(String id) {
218-
this.id = checkNotNull(id);
217+
Builder generatedId(String generatedId) {
218+
this.generatedId = checkNotNull(generatedId);
219219
return this;
220220
}
221221

@@ -235,7 +235,7 @@ Builder status(ChangeRequestInfo.Status status) {
235235
ChangeRequestInfo(BuilderImpl builder) {
236236
this.additions = ImmutableList.copyOf(builder.additions);
237237
this.deletions = ImmutableList.copyOf(builder.deletions);
238-
this.id = builder.id;
238+
this.generatedId = builder.generatedId;
239239
this.startTimeMillis = builder.startTimeMillis;
240240
this.status = builder.status;
241241
}
@@ -271,22 +271,22 @@ public List<RecordSet> deletions() {
271271
}
272272

273273
/**
274-
* Returns the id assigned to this {@code ChangeRequest} by the server.
274+
* Returns the service-generated id for this change request.
275275
*/
276-
public String id() {
277-
return id;
276+
public String generatedId() {
277+
return generatedId;
278278
}
279279

280280
/**
281-
* Returns the time when this {@code ChangeRequest} was started by the server.
281+
* Returns the time when this change request was started by the server.
282282
*/
283283
public Long startTimeMillis() {
284284
return startTimeMillis;
285285
}
286286

287287
/**
288-
* Returns the status of this {@code ChangeRequest}. If the change request has not been applied
289-
* yet, the status is {@code PENDING}.
288+
* Returns the status of this change request. If the change request has not been applied yet, the
289+
* status is {@code PENDING}.
290290
*/
291291
public ChangeRequestInfo.Status status() {
292292
return status;
@@ -295,8 +295,8 @@ public ChangeRequestInfo.Status status() {
295295
Change toPb() {
296296
Change pb = new Change();
297297
// set id
298-
if (id() != null) {
299-
pb.setId(id());
298+
if (generatedId() != null) {
299+
pb.setId(generatedId());
300300
}
301301
// set timestamp
302302
if (startTimeMillis() != null) {
@@ -316,7 +316,7 @@ Change toPb() {
316316
static ChangeRequestInfo fromPb(Change pb) {
317317
Builder builder = builder();
318318
if (pb.getId() != null) {
319-
builder.id(pb.getId());
319+
builder.generatedId(pb.getId());
320320
}
321321
if (pb.getStartTime() != null) {
322322
builder.startTimeMillis(DateTime.parse(pb.getStartTime()).getMillis());
@@ -342,15 +342,15 @@ public boolean equals(Object other) {
342342

343343
@Override
344344
public int hashCode() {
345-
return Objects.hash(additions, deletions, id, startTimeMillis, status);
345+
return Objects.hash(additions, deletions, generatedId, startTimeMillis, status);
346346
}
347347

348348
@Override
349349
public String toString() {
350350
return MoreObjects.toStringHelper(this)
351351
.add("additions", additions)
352352
.add("deletions", deletions)
353-
.add("id", id)
353+
.add("generatedId", generatedId)
354354
.add("startTimeMillis", startTimeMillis)
355355
.add("status", status)
356356
.toString();

gcloud-java-dns/src/main/java/com/google/gcloud/dns/Zone.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ public Builder name(String name) {
6161
}
6262

6363
@Override
64-
Builder id(String id) {
65-
infoBuilder.id(id);
64+
Builder generatedId(String generatedId) {
65+
infoBuilder.generatedId(generatedId);
6666
return this;
6767
}
6868

gcloud-java-dns/src/main/java/com/google/gcloud/dns/ZoneInfo.java

+18-18
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838
*/
3939
public class ZoneInfo implements Serializable {
4040

41-
private static final long serialVersionUID = 201601191647L;
41+
private static final long serialVersionUID = -5313169712036079818L;
4242
private final String name;
43-
private final String id;
43+
private final String generatedId;
4444
private final Long creationTimeMillis;
4545
private final String dnsName;
4646
private final String description;
@@ -57,9 +57,9 @@ public abstract static class Builder {
5757
public abstract Builder name(String name);
5858

5959
/**
60-
* Sets an id for the zone which is assigned to the zone by the server.
60+
* Sets service-generated id for the zone.
6161
*/
62-
abstract Builder id(String id);
62+
abstract Builder generatedId(String generatedId);
6363

6464
/**
6565
* Sets the time when this zone was created.
@@ -98,7 +98,7 @@ public abstract static class Builder {
9898

9999
static class BuilderImpl extends Builder {
100100
private String name;
101-
private String id;
101+
private String generatedId;
102102
private Long creationTimeMillis;
103103
private String dnsName;
104104
private String description;
@@ -114,7 +114,7 @@ private BuilderImpl(String name) {
114114
*/
115115
BuilderImpl(ZoneInfo info) {
116116
this.name = info.name;
117-
this.id = info.id;
117+
this.generatedId = info.generatedId;
118118
this.creationTimeMillis = info.creationTimeMillis;
119119
this.dnsName = info.dnsName;
120120
this.description = info.description;
@@ -131,8 +131,8 @@ public Builder name(String name) {
131131
}
132132

133133
@Override
134-
Builder id(String id) {
135-
this.id = id;
134+
Builder generatedId(String generatedId) {
135+
this.generatedId = generatedId;
136136
return this;
137137
}
138138

@@ -175,7 +175,7 @@ public ZoneInfo build() {
175175

176176
ZoneInfo(BuilderImpl builder) {
177177
this.name = builder.name;
178-
this.id = builder.id;
178+
this.generatedId = builder.generatedId;
179179
this.creationTimeMillis = builder.creationTimeMillis;
180180
this.dnsName = builder.dnsName;
181181
this.description = builder.description;
@@ -199,10 +199,10 @@ public String name() {
199199
}
200200

201201
/**
202-
* Returns the read-only zone id assigned by the server.
202+
* Returns the service-generated id for this zone.
203203
*/
204-
public String id() {
205-
return id;
204+
public String generatedId() {
205+
return generatedId;
206206
}
207207

208208
/**
@@ -253,8 +253,8 @@ com.google.api.services.dns.model.ManagedZone toPb() {
253253
new com.google.api.services.dns.model.ManagedZone();
254254
pb.setDescription(this.description());
255255
pb.setDnsName(this.dnsName());
256-
if (this.id() != null) {
257-
pb.setId(new BigInteger(this.id()));
256+
if (this.generatedId() != null) {
257+
pb.setId(new BigInteger(this.generatedId()));
258258
}
259259
pb.setName(this.name());
260260
pb.setNameServers(this.nameServers); // do use real attribute value which may be null
@@ -276,7 +276,7 @@ static ZoneInfo fromPb(com.google.api.services.dns.model.ManagedZone pb) {
276276
builder.dnsName(pb.getDnsName());
277277
}
278278
if (pb.getId() != null) {
279-
builder.id(pb.getId().toString());
279+
builder.generatedId(pb.getId().toString());
280280
}
281281
if (pb.getNameServers() != null) {
282282
builder.nameServers(pb.getNameServers());
@@ -298,15 +298,15 @@ public boolean equals(Object obj) {
298298

299299
@Override
300300
public int hashCode() {
301-
return Objects.hash(name, id, creationTimeMillis, dnsName,
302-
description, nameServerSet, nameServers);
301+
return Objects.hash(name, generatedId, creationTimeMillis, dnsName, description, nameServerSet,
302+
nameServers);
303303
}
304304

305305
@Override
306306
public String toString() {
307307
return MoreObjects.toStringHelper(this)
308308
.add("name", name())
309-
.add("id", id())
309+
.add("generatedId", generatedId())
310310
.add("description", description())
311311
.add("dnsName", dnsName())
312312
.add("nameServerSet", nameServerSet())

gcloud-java-dns/src/test/java/com/google/gcloud/dns/ChangeRequestInfoTest.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
public class ChangeRequestInfoTest {
3333

34-
private static final String ID = "cr-id-1";
34+
private static final String GENERATED_ID = "cr-id-1";
3535
private static final Long START_TIME_MILLIS = 12334567890L;
3636
private static final ChangeRequest.Status STATUS = ChangeRequest.Status.PENDING;
3737
private static final String NAME1 = "dns1";
@@ -51,7 +51,7 @@ public class ChangeRequestInfoTest {
5151
.delete(RECORD3)
5252
.startTimeMillis(START_TIME_MILLIS)
5353
.status(STATUS)
54-
.id(ID)
54+
.generatedId(GENERATED_ID)
5555
.build();
5656

5757
@Test
@@ -65,7 +65,7 @@ public void testEmptyBuilder() {
6565

6666
@Test
6767
public void testBuilder() {
68-
assertEquals(ID, CHANGE.id());
68+
assertEquals(GENERATED_ID, CHANGE.generatedId());
6969
assertEquals(STATUS, CHANGE.status());
7070
assertEquals(START_TIME_MILLIS, CHANGE.startTimeMillis());
7171
assertEquals(ADDITIONS, CHANGE.additions());
@@ -85,7 +85,7 @@ public void testEqualsAndNotEquals() {
8585
assertEquals(CHANGE, clone);
8686
clone = ChangeRequest.fromPb(CHANGE.toPb());
8787
assertEquals(CHANGE, clone);
88-
clone = CHANGE.toBuilder().id("some-other-id").build();
88+
clone = CHANGE.toBuilder().generatedId("some-other-id").build();
8989
assertNotEquals(CHANGE, clone);
9090
clone = CHANGE.toBuilder().startTimeMillis(CHANGE.startTimeMillis() + 1).build();
9191
assertNotEquals(CHANGE, clone);
@@ -112,7 +112,7 @@ public void testToAndFromPb() {
112112
assertEquals(CHANGE, ChangeRequest.fromPb(CHANGE.toPb()));
113113
ChangeRequestInfo partial = ChangeRequest.builder().build();
114114
assertEquals(partial, ChangeRequest.fromPb(partial.toPb()));
115-
partial = ChangeRequest.builder().id(ID).build();
115+
partial = ChangeRequest.builder().generatedId(GENERATED_ID).build();
116116
assertEquals(partial, ChangeRequest.fromPb(partial.toPb()));
117117
partial = ChangeRequest.builder().add(RECORD1).build();
118118
assertEquals(partial, ChangeRequest.fromPb(partial.toPb()));
@@ -133,7 +133,7 @@ public void testToBuilder() {
133133
assertEquals(CHANGE, CHANGE.toBuilder().build());
134134
ChangeRequestInfo partial = ChangeRequest.builder().build();
135135
assertEquals(partial, partial.toBuilder().build());
136-
partial = ChangeRequest.builder().id(ID).build();
136+
partial = ChangeRequest.builder().generatedId(GENERATED_ID).build();
137137
assertEquals(partial, partial.toBuilder().build());
138138
partial = ChangeRequest.builder().add(RECORD1).build();
139139
assertEquals(partial, partial.toBuilder().build());

gcloud-java-dns/src/test/java/com/google/gcloud/dns/ChangeRequestTest.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public void setUp() throws Exception {
5353
changeRequest = new ChangeRequest(dns, ZONE_NAME, new ChangeRequestInfo.BuilderImpl(
5454
CHANGE_REQUEST_INFO.toBuilder()
5555
.startTimeMillis(132L)
56-
.id("12")
56+
.generatedId("12")
5757
.status(ChangeRequest.Status.DONE)
5858
.build()));
5959
changeRequestPartial = new ChangeRequest(dns, ZONE_NAME,
@@ -104,8 +104,8 @@ public void testBuilder() {
104104
// one for each build() call because it invokes a constructor
105105
expect(dns.options()).andReturn(OPTIONS).times(9);
106106
replay(dns);
107-
String id = changeRequest.id() + "aaa";
108-
assertEquals(id, changeRequest.toBuilder().id(id).build().id());
107+
String id = changeRequest.generatedId() + "aaa";
108+
assertEquals(id, changeRequest.toBuilder().generatedId(id).build().generatedId());
109109
ChangeRequest modified =
110110
changeRequest.toBuilder().status(ChangeRequest.Status.PENDING).build();
111111
assertEquals(ChangeRequest.Status.PENDING, modified.status());

0 commit comments

Comments
 (0)