From 60f2a2b21d52e430a8ee479b210b660b28edd40d Mon Sep 17 00:00:00 2001 From: melaniedejong <35782177+melaniedejong@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:25:55 -0800 Subject: [PATCH 1/6] Update Quickstart.java comments Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format. --- iam/snippets/src/main/java/Quickstart.java | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/iam/snippets/src/main/java/Quickstart.java b/iam/snippets/src/main/java/Quickstart.java index 2dd987029f1..6b566f65121 100644 --- a/iam/snippets/src/main/java/Quickstart.java +++ b/iam/snippets/src/main/java/Quickstart.java @@ -34,8 +34,9 @@ public static void main(String[] args) throws IOException { String projectId = "your-project"; // TODO: Replace with your service account name. String serviceAccount = "your-service-account"; - // TODO: Replace with the ID of your member in the form "user:member@example.com" - String member = "your-member"; + // TODO: Replace with the ID of your principal. + // For examples, see https://cloud.google.com/iam/docs/principal-identifiers + String member = "your-principal"; // The role to be granted. String role = "roles/logging.logWriter"; @@ -56,10 +57,10 @@ public static void quickstart(String projectId, String serviceAccount, // This client only needs to be created once, and can be reused for multiple requests. try (IAMClient iamClient = IAMClient.create()) { - // Grants your member the "Log writer" role for your project. + // Grants your principal the "Log writer" role for your project. addBinding(iamClient, projectId, serviceAccount, member, role); - // Get the project's policy and print all members with the "Log Writer" role + // Get the project's policy and print all principals with the "Log Writer" role Policy policy = getPolicy(iamClient, projectId, serviceAccount); Binding binding = null; @@ -80,7 +81,7 @@ public static void quickstart(String projectId, String serviceAccount, } System.out.println(); - // Removes member from the "Log writer" role. + // Removes principal from the "Log writer" role. removeMember(iamClient, projectId, serviceAccount, member, role); } } @@ -107,7 +108,7 @@ public static void addBinding(IAMClient iamClient, String projectId, String serv } if (binding != null) { - // If binding already exists, adds member to binding. + // If binding already exists, adds principal to binding. binding.getMembersList().add(member); } else { // If binding does not exist, adds binding to policy. @@ -127,7 +128,7 @@ public static void removeMember(IAMClient iamClient, String projectId, String se // Gets the project's policy. Policy.Builder policy = getPolicy(iamClient, projectId, serviceAccount).toBuilder(); - // Removes the member from the role. + // Removes the principal from the role. Binding binding = null; for (Binding b : policy.getBindingsList()) { if (b.getRole().equals(role)) { From 0a34be5cc8fae1bdadb09e7d7b162c3f67674af8 Mon Sep 17 00:00:00 2001 From: melaniedejong <35782177+melaniedejong@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:29:14 -0800 Subject: [PATCH 2/6] Update AddMember.java comments (#9886) Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format. --- iam/snippets/src/main/java/AddMember.java | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/iam/snippets/src/main/java/AddMember.java b/iam/snippets/src/main/java/AddMember.java index 81e2f52ee9a..a44e65ccbd9 100644 --- a/iam/snippets/src/main/java/AddMember.java +++ b/iam/snippets/src/main/java/AddMember.java @@ -26,13 +26,14 @@ public static void main(String[] args) { Policy policy = Policy.newBuilder().build(); // TODO: Replace with your role. String role = "roles/existing-role"; - // TODO: Replace with your member. - String member = "user:member-to-add@example.com"; + // TODO: Replace with your principal. + // For examples, see https://cloud.google.com/iam/docs/principal-identifiers + String member = "principal-id"; addMember(policy, role, member); } - // Adds a member to a pre-existing role. + // Adds a principal to a pre-existing role. public static Policy addMember(Policy policy, String role, String member) { List newBindingsList = new ArrayList<>(); @@ -44,7 +45,7 @@ public static Policy addMember(Policy policy, String role, String member) { } } - // Update the policy to add the member. + // Update the policy to add the principal. Policy updatedPolicy = policy.toBuilder() .clearBindings() .addAllBindings(newBindingsList) From 781911389281e5008e570c6826672841042576d9 Mon Sep 17 00:00:00 2001 From: melaniedejong <35782177+melaniedejong@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:30:53 -0800 Subject: [PATCH 3/6] Update AddBinding.java Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format. melaniedejong-patch-1 (#4895) --- iam/snippets/src/main/java/AddBinding.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/iam/snippets/src/main/java/AddBinding.java b/iam/snippets/src/main/java/AddBinding.java index ade1e167801..2cfc6f93517 100644 --- a/iam/snippets/src/main/java/AddBinding.java +++ b/iam/snippets/src/main/java/AddBinding.java @@ -27,13 +27,14 @@ public static void main(String[] args) { Policy policy = Policy.newBuilder().build(); // TODO: Replace with your role. String role = "roles/role-to-add"; - // TODO: Replace with your members. - List members = Collections.singletonList("user:member-to-add@example.com"); + // TODO: Replace with your principals. + // For examples, see https://cloud.google.com/iam/docs/principal-identifiers + List members = Collections.singletonList("principal-id"); addBinding(policy, role, members); } - // Adds a member to a role. + // Adds a principals to a role. public static Policy addBinding(Policy policy, String role, List members) { Binding binding = Binding.newBuilder() .setRole(role) From 6fd7142d2d90c418f66695327f452e97559cbb1a Mon Sep 17 00:00:00 2001 From: melaniedejong <35782177+melaniedejong@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:34:35 -0800 Subject: [PATCH 4/6] Update RemoveMember.java comments Includes changing "member" to "principal" and linking to principal identifiers page instead of specifying recommended format. --- iam/snippets/src/main/java/RemoveMember.java | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/iam/snippets/src/main/java/RemoveMember.java b/iam/snippets/src/main/java/RemoveMember.java index e249e7fb40e..568f531177e 100644 --- a/iam/snippets/src/main/java/RemoveMember.java +++ b/iam/snippets/src/main/java/RemoveMember.java @@ -27,13 +27,14 @@ public static void main(String[] args) throws IOException { Policy policy = Policy.newBuilder().build(); // TODO: Replace with your role. String role = "roles/existing-role"; - // TODO: Replace with your member. - String member = "user:member-to-add@example.com"; + // TODO: Replace with your principal. + // For examples, see https://cloud.google.com/iam/docs/principal-identifiers + String member = "principal-id"; removeMember(policy, role, member); } - // Removes member from a role; removes binding if binding contains no members. + // Removes principal from a role; removes binding if binding contains no members. public static Policy removeMember(Policy policy, String role, String member) { // Creating new builder with all values copied from origin policy Policy.Builder policyBuilder = policy.toBuilder(); @@ -49,12 +50,12 @@ public static Policy removeMember(Policy policy, String role, String member) { if (binding != null && binding.getMembersList().contains(member)) { List newMemberList = new ArrayList<>(binding.getMembersList()); - // Removing member from a role + // Removing principal from the role newMemberList.remove(member); System.out.println("Member " + member + " removed from " + role); - // Adding all remaining members to create new binding + // Adding all remaining principals to create new binding Binding newBinding = binding.toBuilder() .clearMembers() .addAllMembers(newMemberList) @@ -70,14 +71,14 @@ public static Policy removeMember(Policy policy, String role, String member) { newBindingList.add(newBinding); } - // Update the policy to remove the member. + // Update the policy to remove the principal. policyBuilder.clearBindings() .addAllBindings(newBindingList); } Policy updatedPolicy = policyBuilder.build(); - System.out.println("Exising members: " + updatedPolicy.getBindingsList()); + System.out.println("Exising principals: " + updatedPolicy.getBindingsList()); return updatedPolicy; } From fac2a1da210a9ee1622ce97fd5fd236c8aa165a0 Mon Sep 17 00:00:00 2001 From: melaniedejong <35782177+melaniedejong@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:36:03 -0800 Subject: [PATCH 5/6] Update Quickstart.java --- iam/snippets/src/main/java/Quickstart.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/iam/snippets/src/main/java/Quickstart.java b/iam/snippets/src/main/java/Quickstart.java index 6b566f65121..c36ae434247 100644 --- a/iam/snippets/src/main/java/Quickstart.java +++ b/iam/snippets/src/main/java/Quickstart.java @@ -74,7 +74,7 @@ public static void quickstart(String projectId, String serviceAccount, } System.out.println("Role: " + binding.getRole()); - System.out.print("Members: "); + System.out.print("Principals: "); for (String m : binding.getMembersList()) { System.out.print("[" + m + "] "); From cba79af339c4cb0e820de49dcbdc7339c12f208b Mon Sep 17 00:00:00 2001 From: melaniedejong <35782177+melaniedejong@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:36:24 -0800 Subject: [PATCH 6/6] Update AddMember.java --- iam/snippets/src/main/java/AddMember.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/iam/snippets/src/main/java/AddMember.java b/iam/snippets/src/main/java/AddMember.java index a44e65ccbd9..b50fada1eab 100644 --- a/iam/snippets/src/main/java/AddMember.java +++ b/iam/snippets/src/main/java/AddMember.java @@ -51,7 +51,7 @@ public static Policy addMember(Policy policy, String role, String member) { .addAllBindings(newBindingsList) .build(); - System.out.println("Added member: " + updatedPolicy.getBindingsList()); + System.out.println("Added principal: " + updatedPolicy.getBindingsList()); return updatedPolicy; }