Skip to content

Commit 307f9f0

Browse files
mziccardmziccard
authored
Rename setters/getters/builders for Dns classes to meet proto conventions (#1316)
* Rename setters/getters/builders for Dns classes to meet proto conventions * Update Dns examples, snippets and READMEs to use renamed getters/setters/builders
1 parent 7bcfe3e commit 307f9f0

32 files changed

Lines changed: 1846 additions & 1254 deletions

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -359,19 +359,19 @@ Dns dns = DnsOptions.defaultInstance().service();
359359
String zoneName = "my-unique-zone";
360360
Zone zone = dns.getZone(zoneName);
361361
String ip = "12.13.14.15";
362-
RecordSet toCreate = RecordSet.builder("www.someexampledomain.com.", RecordSet.Type.A)
363-
.ttl(24, TimeUnit.HOURS)
362+
RecordSet toCreate = RecordSet.newBuilder("www.someexampledomain.com.", RecordSet.Type.A)
363+
.setTtl(24, TimeUnit.HOURS)
364364
.addRecord(ip)
365365
.build();
366-
ChangeRequestInfo.Builder changeBuilder = ChangeRequestInfo.builder().add(toCreate);
366+
ChangeRequestInfo.Builder changeBuilder = ChangeRequestInfo.newBuilder().add(toCreate);
367367
368368
// Verify that the record does not exist yet.
369369
// If it does exist, we will overwrite it with our prepared record.
370370
Iterator<RecordSet> recordSetIterator = zone.listRecordSets().iterateAll();
371371
while (recordSetIterator.hasNext()) {
372372
RecordSet current = recordSetIterator.next();
373-
if (toCreate.name().equals(current.name()) &&
374-
toCreate.type().equals(current.type())) {
373+
if (toCreate.name().equals(current.getName()) &&
374+
toCreate.type().equals(current.getType())) {
375375
changeBuilder.delete(current);
376376
}
377377
}

‎TESTING.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,11 @@ You can test against an in-memory local DNS by following these steps:
131131
The `delay` parameter determines if change requests should be processed synchronously
132132
(value `0`) or in a separate thread with a minimum of delay of `delay` milliseconds.
133133

134-
2. In your program, create the DNS service by using the helper's `options()` method. For example:
134+
2. In your program, create the DNS service by using the helper's `getOptions()` method.
135+
For example:
135136

136137
```java
137-
Dns dns = LocalDnsHelper.options().service();
138+
Dns dns = LocalDnsHelper.getOptions().service();
138139
```
139140

140141
3. Run your tests.

‎google-cloud-dns/README.md‎

Lines changed: 14 additions & 12 deletions
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.generatedId());
128+
System.out.printf("Zone was created and assigned ID %s.%n", zone.getGeneratedId());
129129
```
130130

131131
You now have an empty zone hosted in Google Cloud DNS which is ready to be populated with
@@ -142,7 +142,7 @@ and then add
142142

143143
```java
144144
// Print assigned name servers
145-
List<String> nameServers = zone.nameServers();
145+
List<String> nameServers = zone.getNameServers();
146146
for(String nameServer : nameServers) {
147147
System.out.println(nameServer);
148148
}
@@ -170,13 +170,13 @@ and proceed with:
170170
```java
171171
// Prepare a www.someexampledomain.com. type A record set with ttl of 24 hours
172172
String ip = "12.13.14.15";
173-
RecordSet toCreate = RecordSet.builder("www." + zone.dnsName(), RecordSet.Type.A)
174-
.ttl(24, TimeUnit.HOURS)
173+
RecordSet toCreate = RecordSet.newBuilder("www." + zone.dnsName(), RecordSet.Type.A)
174+
.setTtl(24, TimeUnit.HOURS)
175175
.addRecord(ip)
176176
.build();
177177

178178
// Make a change
179-
ChangeRequestInfo changeRequest = ChangeRequestInfo.builder().add(toCreate).build();
179+
ChangeRequestInfo changeRequest = ChangeRequestInfo.newBuilder().add(toCreate).build();
180180

181181
// Build and apply the change request to our zone
182182
changeRequest = zone.applyChangeRequest(changeRequest);
@@ -205,7 +205,8 @@ ChangeRequestInfo.Builder changeBuilder = ChangeRequestInfo.builder().add(toCrea
205205
Iterator<RecordSet> recordSetIterator = zone.listRecordSets().iterateAll();
206206
while (recordSetIterator.hasNext()) {
207207
RecordSet current = recordSetIterator.next();
208-
if (toCreate.name().equals(current.name()) && toCreate.type().equals(current.type())) {
208+
if (toCreate.getName().equals(current.getName())
209+
&& toCreate.getType().equals(current.getType())) {
209210
changeBuilder.delete(current);
210211
}
211212
}
@@ -255,7 +256,7 @@ while (zoneIterator.hasNext()) {
255256

256257
// List the record sets in a particular zone
257258
recordSetIterator = zone.listRecordSets().iterateAll();
258-
System.out.println(String.format("Record sets inside %s:", zone.name()));
259+
System.out.println(String.format("Record sets inside %s:", zone.getName()));
259260
while (recordSetIterator.hasNext()) {
260261
System.out.println(recordSetIterator.next());
261262
}
@@ -274,7 +275,7 @@ and then:
274275

275276
// List the change requests applied to a particular zone
276277
Iterator<ChangeRequest> changeIterator = zone.listChangeRequests().iterateAll();
277-
System.out.println(String.format("The history of changes in %s:", zone.name()));
278+
System.out.println(String.format("The history of changes in %s:", zone.getName()));
278279
while (changeIterator.hasNext()) {
279280
System.out.println(changeIterator.next());
280281
}
@@ -287,18 +288,19 @@ First, you need to empty the zone by deleting all its records except for the def
287288

288289
```java
289290
// Make a change for deleting the record sets
290-
changeBuilder = ChangeRequestInfo.builder();
291+
changeBuilder = ChangeRequestInfo.newBuilder();
291292
while (recordIterator.hasNext()) {
292293
RecordSet current = recordIterator.next();
293294
// SOA and NS records cannot be deleted
294-
if (!RecordSet.Type.SOA.equals(current.type()) && !RecordSet.Type.NS.equals(current.type())) {
295+
if (!RecordSet.Type.SOA.equals(current.getType())
296+
&& !RecordSet.Type.NS.equals(current.getType())) {
295297
changeBuilder.delete(current);
296298
}
297299
}
298300

299301
// Build and apply the change request to our zone if it contains records to delete
300302
ChangeRequestInfo changeRequest = changeBuilder.build();
301-
if (!changeRequest.deletions().isEmpty()) {
303+
if (!changeRequest.getDeletions().isEmpty()) {
302304
ChangeRequest pendingRequest = dns.applyChangeRequest(zoneName, changeRequest);
303305

304306
// Wait for the change request to complete
@@ -325,7 +327,7 @@ if (result) {
325327
#### Complete Source Code
326328

327329
We composed some of the aforementioned snippets into complete executable code samples. In
328-
[CreateZones.java](../google-cloud-examples/src/main/java/com/google/cloud/examples/dns/snippets/CreateZone.java)
330+
[CreateZone.java](../google-cloud-examples/src/main/java/com/google/cloud/examples/dns/snippets/CreateZone.java)
329331
we create a zone. In [CreateOrUpdateRecordSets.java](../google-cloud-examples/src/main/java/com/google/cloud/examples/dns/snippets/CreateOrUpdateRecordSets.java)
330332
we create a type A record set for a zone, or update an existing type A record set to a new IP address. We
331333
demonstrate how to delete a zone in [DeleteZone.java](../google-cloud-examples/src/main/java/com/google/cloud/examples/dns/snippets/DeleteZone.java).

‎google-cloud-dns/src/main/java/com/google/cloud/dns/ChangeRequest.java‎

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,26 @@ private Builder(ChangeRequest cr) {
5555
}
5656

5757
@Override
58+
@Deprecated
5859
public Builder additions(List<RecordSet> additions) {
59-
infoBuilder.additions(additions);
60+
return setAdditions(additions);
61+
}
62+
63+
@Override
64+
public Builder setAdditions(List<RecordSet> additions) {
65+
infoBuilder.setAdditions(additions);
6066
return this;
6167
}
6268

6369
@Override
70+
@Deprecated
6471
public Builder deletions(List<RecordSet> deletions) {
65-
infoBuilder.deletions(deletions);
72+
return setDeletions(deletions);
73+
}
74+
75+
@Override
76+
public Builder setDeletions(List<RecordSet> deletions) {
77+
infoBuilder.setDeletions(deletions);
6678
return this;
6779
}
6880

@@ -103,20 +115,20 @@ public Builder removeDeletion(RecordSet recordSet) {
103115
}
104116

105117
@Override
106-
Builder generatedId(String generatedId) {
107-
infoBuilder.generatedId(generatedId);
118+
Builder setGeneratedId(String generatedId) {
119+
infoBuilder.setGeneratedId(generatedId);
108120
return this;
109121
}
110122

111123
@Override
112-
Builder startTimeMillis(long startTimeMillis) {
113-
infoBuilder.startTimeMillis(startTimeMillis);
124+
Builder setStartTime(long startTimeMillis) {
125+
infoBuilder.setStartTime(startTimeMillis);
114126
return this;
115127
}
116128

117129
@Override
118-
Builder status(Status status) {
119-
infoBuilder.status(status);
130+
Builder setStatus(Status status) {
131+
infoBuilder.setStatus(status);
120132
return this;
121133
}
122134

@@ -137,13 +149,27 @@ public ChangeRequest build() {
137149
* Returns the name of the {@link Zone} associated with this change request.
138150
*/
139151
public String zone() {
152+
return getZone();
153+
}
154+
155+
/**
156+
* Returns the name of the {@link Zone} associated with this change request.
157+
*/
158+
public String getZone() {
140159
return this.zone;
141160
}
142161

143162
/**
144163
* Returns the change request's {@code Dns} object used to issue requests.
145164
*/
146165
public Dns dns() {
166+
return getDns();
167+
}
168+
169+
/**
170+
* Returns the change request's {@code Dns} object used to issue requests.
171+
*/
172+
public Dns getDns() {
147173
return dns;
148174
}
149175

@@ -168,7 +194,7 @@ public ChangeRequest applyTo(String zoneName, Dns.ChangeRequestOption... options
168194
* @throws DnsException upon failure of the API call or if the associated zone was not found
169195
*/
170196
public ChangeRequest reload(Dns.ChangeRequestOption... options) {
171-
return dns.getChangeRequest(zone, generatedId(), options);
197+
return dns.getChangeRequest(zone, getGeneratedId(), options);
172198
}
173199

174200
/**

0 commit comments

Comments
 (0)