Skip to content

Commit 9c0efb7

Browse files
mziccardmziccard
authored
Rename setters/getters/builders for ResourceManager classes to meet proto conventions (#1321)
* Rename setters/getters/builders for ResourceManager classes to meet proto conventions * Update ResourceManager examples, snippets and READMEs to use renamed getters/setters/builders
1 parent 8bf9eab commit 9c0efb7

File tree

18 files changed

+442
-246
lines changed

18 files changed

+442
-246
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -512,13 +512,13 @@ if (project != null) {
512512
.addLabel("launch-status", "in-development")
513513
.build()
514514
.replace();
515-
System.out.println("Updated the labels of project " + newProject.projectId()
516-
+ " to be " + newProject.labels());
515+
System.out.println("Updated the labels of project " + newProject.getProjectId()
516+
+ " to be " + newProject.getLabels());
517517
}
518518
Iterator<Project> projectIterator = resourceManager.list().iterateAll();
519519
System.out.println("Projects I can view:");
520520
while (projectIterator.hasNext()) {
521-
System.out.println(projectIterator.next().projectId());
521+
System.out.println(projectIterator.next().getProjectId());
522522
}
523523
```
524524

‎google-cloud-examples/src/main/java/com/google/cloud/examples/resourcemanager/ResourceManagerExample.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public void run(ResourceManager resourceManager, String... args) {
6464
}
6565
}
6666
Project project =
67-
resourceManager.create(ProjectInfo.builder(projectId).labels(labels).build());
67+
resourceManager.create(ProjectInfo.newBuilder(projectId).setLabels(labels).build());
6868
System.out.printf(
6969
"Successfully created project '%s': %s.%n", projectId, projectDetails(project));
7070
}
@@ -160,15 +160,15 @@ public String[] getOptionalParams() {
160160
private static String projectDetails(ProjectInfo project) {
161161
return new StringBuilder()
162162
.append("{projectId:")
163-
.append(project.projectId())
163+
.append(project.getProjectId())
164164
.append(", projectNumber:")
165-
.append(project.projectNumber())
165+
.append(project.getProjectNumber())
166166
.append(", createTimeMillis:")
167-
.append(project.createTimeMillis())
167+
.append(project.getCreateTimeMillis())
168168
.append(", state:")
169-
.append(project.state())
169+
.append(project.getState())
170170
.append(", labels:")
171-
.append(project.labels())
171+
.append(project.getLabels())
172172
.append("}")
173173
.toString();
174174
}

‎google-cloud-examples/src/main/java/com/google/cloud/examples/resourcemanager/snippets/GetOrCreateProject.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ public static void main(String... args) {
4242
Project project = resourceManager.get(projectId);
4343
if (project == null) {
4444
// Create a project.
45-
project = resourceManager.create(ProjectInfo.builder(projectId).build());
45+
project = resourceManager.create(ProjectInfo.newBuilder(projectId).build());
4646
}
47-
System.out.println("Got project " + project.projectId() + " from the server.");
47+
System.out.println("Got project " + project.getProjectId() + " from the server.");
4848
}
4949
}

‎google-cloud-examples/src/main/java/com/google/cloud/examples/resourcemanager/snippets/UpdateAndListProjects.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,15 @@ public static void main(String... args) {
4848
.addLabel("launch-status", "in-development")
4949
.build()
5050
.replace();
51-
System.out.println("Updated the labels of project " + newProject.projectId()
52-
+ " to be " + newProject.labels());
51+
System.out.println("Updated the labels of project " + newProject.getProjectId()
52+
+ " to be " + newProject.getLabels());
5353
}
5454

5555
// List all the projects you have permission to view.
5656
Iterator<Project> projectIterator = resourceManager.list().iterateAll();
5757
System.out.println("Projects I can view:");
5858
while (projectIterator.hasNext()) {
59-
System.out.println(projectIterator.next().projectId());
59+
System.out.println(projectIterator.next().getProjectId());
6060
}
6161
}
6262
}

‎google-cloud-resourcemanager/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ project ID).
117117

118118
```java
119119
String projectId = "my-globally-unique-project-id"; // Change to a unique project ID
120-
Project project = resourceManager.create(ProjectInfo.builder(projectId).build());
120+
Project project = resourceManager.create(ProjectInfo.newBuilder(projectId).build());
121121
```
122122

123123
Note that the return value from `create` is a `Project` that includes additional read-only
@@ -159,7 +159,7 @@ Then add the following code to print a list of projects you can view:
159159
Iterator<Project> projectIterator = resourceManager.list().iterateAll();
160160
System.out.println("Projects I can view:");
161161
while (projectIterator.hasNext()) {
162-
System.out.println(projectIterator.next().projectId());
162+
System.out.println(projectIterator.next().getProjectId());
163163
}
164164
```
165165

‎google-cloud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/Option.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ abstract class Option implements Serializable {
3939
this.value = value;
4040
}
4141

42-
ResourceManagerRpc.Option rpcOption() {
42+
ResourceManagerRpc.Option getRpcOption() {
4343
return rpcOption;
4444
}
4545

46-
Object value() {
46+
Object getValue() {
4747
return value;
4848
}
4949

‎google-cloud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/Project.java‎

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,26 @@ public static class Builder extends ProjectInfo.Builder {
5454
}
5555

5656
@Override
57+
@Deprecated
5758
public Builder name(String name) {
58-
infoBuilder.name(name);
59+
return setName(name);
60+
}
61+
62+
@Override
63+
public Builder setName(String name) {
64+
infoBuilder.setName(name);
5965
return this;
6066
}
6167

6268
@Override
69+
@Deprecated
6370
public Builder projectId(String projectId) {
64-
infoBuilder.projectId(projectId);
71+
return setProjectId(projectId);
72+
}
73+
74+
@Override
75+
public Builder setProjectId(String projectId) {
76+
infoBuilder.setProjectId(projectId);
6577
return this;
6678
}
6779

@@ -84,32 +96,38 @@ public Builder clearLabels() {
8496
}
8597

8698
@Override
99+
@Deprecated
87100
public Builder labels(Map<String, String> labels) {
88-
infoBuilder.labels(labels);
101+
return setLabels(labels);
102+
}
103+
104+
@Override
105+
public Builder setLabels(Map<String, String> labels) {
106+
infoBuilder.setLabels(labels);
89107
return this;
90108
}
91109

92110
@Override
93-
Builder projectNumber(Long projectNumber) {
94-
infoBuilder.projectNumber(projectNumber);
111+
Builder setProjectNumber(Long projectNumber) {
112+
infoBuilder.setProjectNumber(projectNumber);
95113
return this;
96114
}
97115

98116
@Override
99-
Builder state(State state) {
100-
infoBuilder.state(state);
117+
Builder setState(State state) {
118+
infoBuilder.setState(state);
101119
return this;
102120
}
103121

104122
@Override
105-
Builder createTimeMillis(Long createTimeMillis) {
106-
infoBuilder.createTimeMillis(createTimeMillis);
123+
Builder setCreateTimeMillis(Long createTimeMillis) {
124+
infoBuilder.setCreateTimeMillis(createTimeMillis);
107125
return this;
108126
}
109127

110128
@Override
111-
Builder parent(ResourceId parent) {
112-
infoBuilder.parent(parent);
129+
Builder setParent(ResourceId parent) {
130+
infoBuilder.setParent(parent);
113131
return this;
114132
}
115133

@@ -128,7 +146,15 @@ public Project build() {
128146
/**
129147
* Returns the {@link ResourceManager} service object associated with this Project.
130148
*/
149+
@Deprecated
131150
public ResourceManager resourceManager() {
151+
return getResourceManager();
152+
}
153+
154+
/**
155+
* Returns the {@link ResourceManager} service object associated with this Project.
156+
*/
157+
public ResourceManager getResourceManager() {
132158
return resourceManager;
133159
}
134160

@@ -140,7 +166,7 @@ public ResourceManager resourceManager() {
140166
* @throws ResourceManagerException upon failure
141167
*/
142168
public Project reload() {
143-
return resourceManager.get(projectId());
169+
return resourceManager.get(getProjectId());
144170
}
145171

146172
/**
@@ -166,7 +192,7 @@ public Project reload() {
166192
* Resource Manager delete</a>
167193
*/
168194
public void delete() {
169-
resourceManager.delete(projectId());
195+
resourceManager.delete(getProjectId());
170196
}
171197

172198
/**
@@ -183,7 +209,7 @@ public void delete() {
183209
* Resource Manager undelete</a>
184210
*/
185211
public void undelete() {
186-
resourceManager.undelete(projectId());
212+
resourceManager.undelete(getProjectId());
187213
}
188214

189215
/**
@@ -212,7 +238,7 @@ public Project replace() {
212238
* Resource Manager getIamPolicy</a>
213239
*/
214240
public Policy getPolicy() {
215-
return resourceManager.getPolicy(projectId());
241+
return resourceManager.getPolicy(getProjectId());
216242
}
217243

218244
/**
@@ -227,7 +253,7 @@ public Policy getPolicy() {
227253
* Resource Manager setIamPolicy</a>
228254
*/
229255
public Policy replacePolicy(Policy newPolicy) {
230-
return resourceManager.replacePolicy(projectId(), newPolicy);
256+
return resourceManager.replacePolicy(getProjectId(), newPolicy);
231257
}
232258

233259
/**
@@ -250,7 +276,7 @@ public Policy replacePolicy(Policy newPolicy) {
250276
* Services</a>
251277
*/
252278
List<Boolean> testPermissions(List<String> permissions) {
253-
return resourceManager.testPermissions(projectId(), permissions);
279+
return resourceManager.testPermissions(getProjectId(), permissions);
254280
}
255281

256282
@Override

0 commit comments

Comments
 (0)