Skip to content

Commit 13d1df3

Browse files
trollyxiaLixia Chengcf-owl-bot[bot]
authored
feat: Add admin APIs for AuthorizedView (#2175)
* feat: Add admin APIs for AuthorizedView Change-Id: Ie31eae6da61ed0d0462e029f6247924785b239bf * chore: Mark AuthorizedViewType as InternalApi Change-Id: If52e3a32c3259f652f1f7d34b013d1ec1fc0a773 * chore: Add tests and change AuthorizedViewType to InternalExtensionOnly Change-Id: I2e7f04d0f7815d014928a924d4a4f26adb2b655d * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Chore: fix a comment Change-Id: Iac28b6cbef3088e4e2d43d90655155369361c347 * setFamilySubset instead of add and use List rather than ImmutableList Change-Id: Ibdb2c8a62dc55c44059d5ec2296c57c7d430baa4 --------- Co-authored-by: Lixia Chen <[email protected]> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 4158094 commit 13d1df3

File tree

15 files changed

+2442
-0
lines changed

15 files changed

+2442
-0
lines changed

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClient.java‎

Lines changed: 535 additions & 0 deletions
Large diffs are not rendered by default.

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/internal/NameUtil.java‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ public class NameUtil {
3434
private static final Pattern BACKUP_PATTERN =
3535
Pattern.compile("projects/([^/]+)/instances/([^/]+)/clusters/([^/]+)/backups/([^/]+)");
3636

37+
private static final Pattern AUTHORIZED_VIEW_PATTERN =
38+
Pattern.compile("projects/([^/]+)/instances/([^/]+)/tables/([^/]+)/authorizedViews/([^/]+)");
39+
3740
public static String formatProjectName(String projectId) {
3841
return "projects/" + projectId;
3942
}
@@ -55,6 +58,11 @@ public static String formatBackupName(
5558
return formatClusterName(projectId, instanceId, clusterId) + "/backups/" + backupId;
5659
}
5760

61+
public static String formatAuthorizedViewName(
62+
String projectId, String instanceId, String tableId, String viewId) {
63+
return formatTableName(projectId, instanceId, tableId) + "/authorizedViews/" + viewId;
64+
}
65+
5866
public static String extractTableIdFromTableName(String fullTableName) {
5967
Matcher matcher = TABLE_PATTERN.matcher(fullTableName);
6068
if (!matcher.matches()) {
@@ -71,6 +79,15 @@ public static String extractBackupIdFromBackupName(String fullBackupName) {
7179
return matcher.group(4);
7280
}
7381

82+
public static String extractAuthorizedViewIdFromAuthorizedViewName(
83+
String fullAuthorizedViewName) {
84+
Matcher matcher = AUTHORIZED_VIEW_PATTERN.matcher(fullAuthorizedViewName);
85+
if (!matcher.matches()) {
86+
throw new IllegalArgumentException("Invalid authorized view name: " + fullAuthorizedViewName);
87+
}
88+
return matcher.group(4);
89+
}
90+
7491
public static String extractZoneIdFromLocationName(String fullLocationName) {
7592
Matcher matcher = LOCATION_PATTERN.matcher(fullLocationName);
7693
if (!matcher.matches()) {

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/AuthorizedView.java‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.cloud.bigtable.admin.v2.models;
18+
19+
import com.google.api.core.InternalApi;
20+
import com.google.api.core.InternalExtensionOnly;
21+
import com.google.bigtable.admin.v2.AuthorizedViewName;
22+
import com.google.common.base.Objects;
23+
import com.google.common.base.Preconditions;
24+
import javax.annotation.Nonnull;
25+
26+
/**
27+
* A class that wraps the {@link com.google.bigtable.admin.v2.AuthorizedView} protocol buffer
28+
* object.
29+
*
30+
* <p>An AuthorizedView represents subsets of a particular table based on rules. The access to each
31+
* AuthorizedView can be configured separately from the Table.
32+
*
33+
* <p>Users can perform read/write operation on an AuthorizedView by providing an authorizedView id
34+
* besides a table id, in which case the semantics remain identical as reading/writing on a Table
35+
* except that visibility is restricted to the subset of the Table that the AuthorizedView
36+
* represents.
37+
*/
38+
public final class AuthorizedView {
39+
private final com.google.bigtable.admin.v2.AuthorizedView proto;
40+
41+
/**
42+
* Wraps the protobuf. This method is considered an internal implementation detail and not meant
43+
* to be used by applications.
44+
*/
45+
@InternalApi
46+
public static AuthorizedView fromProto(
47+
@Nonnull com.google.bigtable.admin.v2.AuthorizedView proto) {
48+
return new AuthorizedView(proto);
49+
}
50+
51+
private AuthorizedView(@Nonnull com.google.bigtable.admin.v2.AuthorizedView proto) {
52+
Preconditions.checkNotNull(proto);
53+
Preconditions.checkArgument(!proto.getName().isEmpty(), "AuthorizedView must have a name");
54+
Preconditions.checkArgument(
55+
proto.hasSubsetView(), "AuthorizedView must have a subset_view field");
56+
this.proto = proto;
57+
}
58+
59+
/** Gets the authorized view's id. */
60+
public String getId() {
61+
// Constructor ensures that name is not null.
62+
AuthorizedViewName fullName = AuthorizedViewName.parse(proto.getName());
63+
64+
//noinspection ConstantConditions
65+
return fullName.getAuthorizedView();
66+
}
67+
68+
/** Gets the id of the table that owns this authorized view. */
69+
public String getTableId() {
70+
// Constructor ensures that name is not null.
71+
AuthorizedViewName fullName = AuthorizedViewName.parse(proto.getName());
72+
73+
//noinspection ConstantConditions
74+
return fullName.getTable();
75+
}
76+
77+
/** Returns whether this authorized view is deletion protected. */
78+
public boolean isDeletionProtected() {
79+
return proto.getDeletionProtection();
80+
}
81+
82+
/** Gets the type of this authorized view, which currently can only be a subset view. */
83+
public AuthorizedViewType getAuthorizedViewType() {
84+
if (proto.hasSubsetView()) {
85+
return SubsetView.fromProto(proto.getSubsetView());
86+
} else {
87+
// Should never happen because the constructor verifies that one must exist.
88+
throw new IllegalStateException("This AuthorizedView doesn't have a valid type specified");
89+
}
90+
}
91+
92+
/**
93+
* Creates the request protobuf. This method is considered an internal implementation detail and
94+
* not meant to be used by applications.
95+
*/
96+
@InternalApi
97+
public com.google.bigtable.admin.v2.AuthorizedView toProto() {
98+
return proto;
99+
}
100+
101+
@Override
102+
public boolean equals(Object o) {
103+
if (this == o) {
104+
return true;
105+
}
106+
if (o == null || getClass() != o.getClass()) {
107+
return false;
108+
}
109+
AuthorizedView that = (AuthorizedView) o;
110+
return Objects.equal(proto, that.proto);
111+
}
112+
113+
@Override
114+
public int hashCode() {
115+
return Objects.hashCode(proto);
116+
}
117+
118+
/**
119+
* Represents a subset of a Table. Please check the implementations of this interface for more
120+
* details.
121+
*/
122+
@InternalExtensionOnly
123+
public interface AuthorizedViewType {}
124+
}

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/CreateAuthorizedViewRequest.java‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
/*
2+
* Copyright 2024 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.cloud.bigtable.admin.v2.models;
18+
19+
import com.google.api.core.InternalApi;
20+
import com.google.cloud.bigtable.admin.v2.internal.NameUtil;
21+
import com.google.cloud.bigtable.admin.v2.models.AuthorizedView.AuthorizedViewType;
22+
import com.google.common.base.Objects;
23+
import com.google.common.base.Preconditions;
24+
import javax.annotation.Nonnull;
25+
26+
/**
27+
* Parameters for creating a new Cloud Bigtable {@link AuthorizedView}, which represents subsets of
28+
* a particular table.
29+
*
30+
* <p>Sample code:
31+
*
32+
* <pre>{@code
33+
* CreateAuthorizedViewRequest request =
34+
* CreateAuthorizedViewRequest.of("my-table", "my-new-authorized-view")
35+
* .setAuthorizedViewType(
36+
* SubsetView.create()
37+
* .addRowPrefix("row#")
38+
* .addFamilySubsets(
39+
* "my-family", FamilySubsets.create().addQualifier("column")));
40+
* }</pre>
41+
*
42+
* @see AuthorizedView for more details.
43+
*/
44+
public final class CreateAuthorizedViewRequest {
45+
private final String tableId;
46+
private final com.google.bigtable.admin.v2.CreateAuthorizedViewRequest.Builder requestBuilder =
47+
com.google.bigtable.admin.v2.CreateAuthorizedViewRequest.newBuilder();
48+
49+
public static CreateAuthorizedViewRequest of(
50+
@Nonnull String tableId, @Nonnull String authorizedViewId) {
51+
return new CreateAuthorizedViewRequest(tableId, authorizedViewId);
52+
}
53+
54+
private CreateAuthorizedViewRequest(@Nonnull String tableId, @Nonnull String authorizedViewId) {
55+
Preconditions.checkNotNull(tableId, "tableId must be set");
56+
Preconditions.checkNotNull(authorizedViewId, "authorizedViewId must be set");
57+
58+
this.tableId = tableId;
59+
requestBuilder.setAuthorizedViewId(authorizedViewId);
60+
}
61+
62+
/** Configures if the authorized view is deletion protected. */
63+
public CreateAuthorizedViewRequest setDeletionProtection(boolean deletionProtection) {
64+
requestBuilder.getAuthorizedViewBuilder().setDeletionProtection(deletionProtection);
65+
return this;
66+
}
67+
68+
/**
69+
* Sets the implementation for this authorized view.
70+
*
71+
* @see AuthorizedViewType for details.
72+
*/
73+
public CreateAuthorizedViewRequest setAuthorizedViewType(
74+
@Nonnull AuthorizedViewType authorizedViewType) {
75+
Preconditions.checkNotNull(authorizedViewType, "authorizedViewType must be set");
76+
77+
if (authorizedViewType instanceof SubsetView) {
78+
requestBuilder
79+
.getAuthorizedViewBuilder()
80+
.setSubsetView(((SubsetView) authorizedViewType).toProto());
81+
} else {
82+
throw new IllegalArgumentException("Unknown authorizedViewType: " + authorizedViewType);
83+
}
84+
85+
return this;
86+
}
87+
88+
@Override
89+
public boolean equals(Object o) {
90+
if (this == o) {
91+
return true;
92+
}
93+
if (o == null || getClass() != o.getClass()) {
94+
return false;
95+
}
96+
CreateAuthorizedViewRequest that = (CreateAuthorizedViewRequest) o;
97+
return Objects.equal(requestBuilder.build(), that.requestBuilder.build())
98+
&& Objects.equal(tableId, that.tableId);
99+
}
100+
101+
@Override
102+
public int hashCode() {
103+
return Objects.hashCode(requestBuilder.build(), tableId);
104+
}
105+
106+
/**
107+
* Creates the request protobuf. This method is considered an internal implementation detail and
108+
* not meant to be used by applications.
109+
*/
110+
@InternalApi
111+
public com.google.bigtable.admin.v2.CreateAuthorizedViewRequest toProto(
112+
@Nonnull String projectId, @Nonnull String instanceId) {
113+
return requestBuilder
114+
.setParent(NameUtil.formatTableName(projectId, instanceId, tableId))
115+
.build();
116+
}
117+
}

0 commit comments

Comments
 (0)