Visitar URL original
samples: Schema evolution (#1499) · googleapis/java-pubsub@18e9c3b · GitHub
Skip to content
This repository was archived by the owner on Aug 13, 2026. It is now read-only.

Commit 18e9c3b

Browse files
kamalaboulhosngcf-owl-bot[bot]
kamalaboulhosn
and
gcf-owl-bot[bot]
committed
samples: Schema evolution (#1499)
* samples: schema evolution * samples: schema evolution * Format fixes * Fix documentation for field. * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Add back in working asserts * Formatting fixes * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Version/delete fixes * samples: schema evolution * samples: schema evolution * Format fixes * Fix documentation for field. * Add back in working asserts * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Formatting fixes * Version/delete fixes --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 94fa8ab commit 18e9c3b

15 files changed

Lines changed: 835 additions & 18 deletions

‎README.md‎

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

‎samples/snippets/src/main/java/pubsub/CommitAvroSchemaExample.java‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright 2023 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+
* http://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 pubsub;
18+
19+
// [START pubsub_commit_avro_schema]
20+
21+
import com.google.api.gax.rpc.AlreadyExistsException;
22+
import com.google.cloud.pubsub.v1.SchemaServiceClient;
23+
import com.google.pubsub.v1.ProjectName;
24+
import com.google.pubsub.v1.Schema;
25+
import com.google.pubsub.v1.SchemaName;
26+
import java.io.IOException;
27+
import java.nio.file.Files;
28+
import java.nio.file.Paths;
29+
30+
public class CommitAvroSchemaExample {
31+
32+
public static void main(String... args) throws Exception {
33+
// TODO(developer): Replace these variables before running the sample.
34+
String projectId = "your-project-id";
35+
String schemaId = "your-schema-id";
36+
String avscFile = "path/to/an/avro/schema/file/(.avsc)/formatted/in/json";
37+
38+
commitAvroSchemaExample(projectId, schemaId, avscFile);
39+
}
40+
41+
public static Schema commitAvroSchemaExample(String projectId, String schemaId, String avscFile)
42+
throws IOException {
43+
44+
ProjectName projectName = ProjectName.of(projectId);
45+
SchemaName schemaName = SchemaName.of(projectId, schemaId);
46+
47+
// Read an Avro schema file formatted in JSON as a string.
48+
String avscSource = new String(Files.readAllBytes(Paths.get(avscFile)));
49+
50+
try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
51+
52+
Schema schema =
53+
schemaServiceClient.commitSchema(
54+
schemaName.toString(),
55+
Schema.newBuilder()
56+
.setName(schemaName.toString())
57+
.setType(Schema.Type.AVRO)
58+
.setDefinition(avscSource)
59+
.build());
60+
61+
System.out.println("Committed a schema using an Avro schema:\n" + schema);
62+
return schema;
63+
} catch (AlreadyExistsException e) {
64+
System.out.println(schemaName + "already exists.");
65+
return null;
66+
}
67+
}
68+
}
69+
// [END pubsub_commit_avro_schema]

‎samples/snippets/src/main/java/pubsub/CommitProtoSchemaExample.java‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright 2023 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+
* http://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 pubsub;
18+
19+
// [START pubsub_commit_proto_schema]
20+
21+
import com.google.api.gax.rpc.AlreadyExistsException;
22+
import com.google.cloud.pubsub.v1.SchemaServiceClient;
23+
import com.google.pubsub.v1.ProjectName;
24+
import com.google.pubsub.v1.Schema;
25+
import com.google.pubsub.v1.SchemaName;
26+
import java.io.IOException;
27+
import java.nio.file.Files;
28+
import java.nio.file.Paths;
29+
30+
public class CommitProtoSchemaExample {
31+
32+
public static void main(String... args) throws Exception {
33+
// TODO(developer): Replace these variables before running the sample.
34+
String projectId = "your-project-id";
35+
String schemaId = "your-schema-id";
36+
String protoFile = "path/to/a/proto/file/(.proto)/formatted/in/protocol/buffers";
37+
38+
commitProtoSchemaExample(projectId, schemaId, protoFile);
39+
}
40+
41+
public static Schema commitProtoSchemaExample(String projectId, String schemaId, String protoFile)
42+
throws IOException {
43+
44+
ProjectName projectName = ProjectName.of(projectId);
45+
SchemaName schemaName = SchemaName.of(projectId, schemaId);
46+
47+
// Read a proto file as a string.
48+
String protoSource = new String(Files.readAllBytes(Paths.get(protoFile)));
49+
50+
try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
51+
52+
Schema schema =
53+
schemaServiceClient.commitSchema(
54+
schemaName.toString(),
55+
Schema.newBuilder()
56+
.setName(schemaName.toString())
57+
.setType(Schema.Type.PROTOCOL_BUFFER)
58+
.setDefinition(protoSource)
59+
.build());
60+
61+
System.out.println("Committed a schema using a protobuf schema:\n" + schema);
62+
return schema;
63+
} catch (AlreadyExistsException e) {
64+
System.out.println(schemaName + "already exists.");
65+
return null;
66+
}
67+
}
68+
}
69+
// [END pubsub_commit_proto_schema]

‎samples/snippets/src/main/java/pubsub/CreateAvroSchemaExample.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public static void main(String... args) throws Exception {
3838
createAvroSchemaExample(projectId, schemaId, avscFile);
3939
}
4040

41-
public static void createAvroSchemaExample(String projectId, String schemaId, String avscFile)
41+
public static Schema createAvroSchemaExample(String projectId, String schemaId, String avscFile)
4242
throws IOException {
4343

4444
ProjectName projectName = ProjectName.of(projectId);
@@ -60,8 +60,10 @@ public static void createAvroSchemaExample(String projectId, String schemaId, St
6060
schemaId);
6161

6262
System.out.println("Created a schema using an Avro schema:\n" + schema);
63+
return schema;
6364
} catch (AlreadyExistsException e) {
6465
System.out.println(schemaName + "already exists.");
66+
return null;
6567
}
6668
}
6769
}

‎samples/snippets/src/main/java/pubsub/CreateProtoSchemaExample.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public static void main(String... args) throws Exception {
3838
createProtoSchemaExample(projectId, schemaId, protoFile);
3939
}
4040

41-
public static void createProtoSchemaExample(String projectId, String schemaId, String protoFile)
41+
public static Schema createProtoSchemaExample(String projectId, String schemaId, String protoFile)
4242
throws IOException {
4343

4444
ProjectName projectName = ProjectName.of(projectId);
@@ -60,8 +60,10 @@ public static void createProtoSchemaExample(String projectId, String schemaId, S
6060
schemaId);
6161

6262
System.out.println("Created a schema using a protobuf schema:\n" + schema);
63+
return schema;
6364
} catch (AlreadyExistsException e) {
6465
System.out.println(schemaName + "already exists.");
66+
return null;
6567
}
6668
}
6769
}

‎samples/snippets/src/main/java/pubsub/CreateTopicWithSchemaRevisionsExample.java‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/*
2+
* Copyright 2023 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+
* http://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 pubsub;
18+
19+
// [START pubsub_create_topic_with_schema_revisions]
20+
21+
import com.google.api.gax.rpc.AlreadyExistsException;
22+
import com.google.cloud.pubsub.v1.TopicAdminClient;
23+
import com.google.pubsub.v1.Encoding;
24+
import com.google.pubsub.v1.SchemaName;
25+
import com.google.pubsub.v1.SchemaSettings;
26+
import com.google.pubsub.v1.Topic;
27+
import com.google.pubsub.v1.TopicName;
28+
import java.io.IOException;
29+
30+
public class CreateTopicWithSchemaRevisionsExample {
31+
32+
public static void main(String... args) throws Exception {
33+
// TODO(developer): Replace these variables before running the sample.
34+
String projectId = "your-project-id";
35+
String topicId = "your-topic-id";
36+
// Use an existing schema.
37+
String schemaId = "your-schema-id";
38+
// Choose either BINARY or JSON message serialization in this topic.
39+
Encoding encoding = Encoding.BINARY;
40+
// Set the minimum and maximum revsion ID
41+
String firstRevisionId = "your-revision-id";
42+
String lastRevisionId = "your-revision-id";
43+
44+
createTopicWithSchemaRevisionsExample(
45+
projectId, topicId, schemaId, firstRevisionId, lastRevisionId, encoding);
46+
}
47+
48+
public static void createTopicWithSchemaRevisionsExample(
49+
String projectId,
50+
String topicId,
51+
String schemaId,
52+
String firstRevisionid,
53+
String lastRevisionId,
54+
Encoding encoding)
55+
throws IOException {
56+
TopicName topicName = TopicName.of(projectId, topicId);
57+
SchemaName schemaName = SchemaName.of(projectId, schemaId);
58+
59+
SchemaSettings schemaSettings =
60+
SchemaSettings.newBuilder()
61+
.setSchema(schemaName.toString())
62+
.setFirstRevisionId(firstRevisionid)
63+
.setLastRevisionId(lastRevisionId)
64+
.setEncoding(encoding)
65+
.build();
66+
67+
try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
68+
69+
Topic topic =
70+
topicAdminClient.createTopic(
71+
Topic.newBuilder()
72+
.setName(topicName.toString())
73+
.setSchemaSettings(schemaSettings)
74+
.build());
75+
76+
System.out.println("Created topic with schema: " + topic.getName());
77+
} catch (AlreadyExistsException e) {
78+
System.out.println(schemaName + "already exists.");
79+
}
80+
}
81+
}
82+
// [END pubsub_create_topic_with_schema_revisions]

‎samples/snippets/src/main/java/pubsub/DeleteSchemaRevisionExample.java‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/*
2+
* Copyright 2023 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+
* http://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 pubsub;
18+
19+
// [START pubsub_delete_schema_revision]
20+
21+
import com.google.api.gax.rpc.NotFoundException;
22+
import com.google.cloud.pubsub.v1.SchemaServiceClient;
23+
import com.google.pubsub.v1.DeleteSchemaRevisionRequest;
24+
import com.google.pubsub.v1.SchemaName;
25+
import java.io.IOException;
26+
27+
public class DeleteSchemaRevisionExample {
28+
29+
public static void main(String... args) throws Exception {
30+
// TODO(developer): Replace these variables before running the sample.
31+
String projectId = "your-project-id";
32+
String schemaId = "your-schema-id@your-revision-id";
33+
34+
deleteSchemaRevisionExample(projectId, schemaId);
35+
}
36+
37+
public static void deleteSchemaRevisionExample(String projectId, String schemaId)
38+
throws IOException {
39+
SchemaName schemaName = SchemaName.of(projectId, schemaId);
40+
41+
try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
42+
43+
DeleteSchemaRevisionRequest request =
44+
DeleteSchemaRevisionRequest.newBuilder().setName(schemaName.toString()).build();
45+
46+
schemaServiceClient.deleteSchemaRevision(request);
47+
48+
System.out.println("Deleted a schema revision:" + schemaName);
49+
50+
} catch (NotFoundException e) {
51+
System.out.println(schemaName + "not found.");
52+
}
53+
}
54+
}
55+
// [END pubsub_delete_schema_revision]

‎samples/snippets/src/main/java/pubsub/GetSchemaRevisionExample.java‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/*
2+
* Copyright 2023 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+
* http://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 pubsub;
18+
19+
// [START pubsub_get_schema_revision]
20+
21+
import com.google.api.gax.rpc.NotFoundException;
22+
import com.google.cloud.pubsub.v1.SchemaServiceClient;
23+
import com.google.pubsub.v1.Schema;
24+
import com.google.pubsub.v1.SchemaName;
25+
import java.io.IOException;
26+
27+
public class GetSchemaRevisionExample {
28+
29+
public static void main(String... args) throws Exception {
30+
// TODO(developer): Replace these variables before running the sample.
31+
String projectId = "your-project-id";
32+
String schemaId = "your-schema-id@your-schema-revision";
33+
34+
getSchemaRevisionExample(projectId, schemaId);
35+
}
36+
37+
public static void getSchemaRevisionExample(String projectId, String schemaId)
38+
throws IOException {
39+
SchemaName schemaName = SchemaName.of(projectId, schemaId);
40+
41+
try (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
42+
43+
Schema schema = schemaServiceClient.getSchema(schemaName);
44+
45+
System.out.println("Got a schema:\n" + schema);
46+
47+
} catch (NotFoundException e) {
48+
System.out.println(schemaName + "not found.");
49+
}
50+
}
51+
}
52+
// [END pubsub_get_schema_revision]

0 commit comments

Comments
 (0)