Skip to content

Commit 61b1981

Browse files
dpcollins-googledpcollins-google
authored
docs: Update samples for v0.3.0 (#235)
* docs: Update samples for v0.3.0 * fix: Fix build error. * Bump readme version
1 parent e8be2b9 commit 61b1981

20 files changed

+137
-152
lines changed

‎.readme-partials.yaml‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ custom_content: |
2121
Integer partitions = 1;
2222
2323
TopicPath topicPath =
24-
TopicPaths.newBuilder()
25-
.setProjectNumber(ProjectNumber.of(projectNumber))
26-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
27-
.setTopicName(TopicName.of(topicId))
24+
TopicPath.newBuilder()
25+
.setProject(ProjectNumber.of(projectNumber))
26+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
27+
.setName(TopicName.of(topicId))
2828
.build();
2929
3030
Topic topic =
@@ -45,7 +45,7 @@ custom_content: |
4545
// beyond this value, older messages will be dropped to make room for
4646
// newer ones, regardless of the value of `period`.
4747
.setPerPartitionBytes(30 * 1024 * 1024 * 1024L))
48-
.setName(topicPath.value())
48+
.setName(topicPath.toString())
4949
.build();
5050
5151
AdminClientSettings adminClientSettings =
@@ -81,10 +81,10 @@ custom_content: |
8181
int messageCount = 100;
8282
8383
TopicPath topicPath =
84-
TopicPaths.newBuilder()
85-
.setProjectNumber(ProjectNumber.of(projectNumber))
86-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
87-
.setTopicName(TopicName.of(topicId))
84+
TopicPath.newBuilder()
85+
.setProject(ProjectNumber.of(projectNumber))
86+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
87+
.setName(TopicName.of(topicId))
8888
.build();
8989
Publisher publisher = null;
9090
List<ApiFuture<String>> futures = new ArrayList<>();
@@ -149,17 +149,17 @@ custom_content: |
149149
String subscriptionId = "your-subscription-id";
150150
151151
TopicPath topicPath =
152-
TopicPaths.newBuilder()
153-
.setProjectNumber(ProjectNumber.of(projectNumber))
154-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
155-
.setTopicName(TopicName.of(topicId))
152+
TopicPath.newBuilder()
153+
.setProject(ProjectNumber.of(projectNumber))
154+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
155+
.setName(TopicName.of(topicId))
156156
.build();
157157
158158
SubscriptionPath subscriptionPath =
159-
SubscriptionPaths.newBuilder()
160-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
161-
.setProjectNumber(ProjectNumber.of(projectNumber))
162-
.setSubscriptionName(SubscriptionName.of(subscriptionId))
159+
SubscriptionPath.newBuilder()
160+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
161+
.setProject(ProjectNumber.of(projectNumber))
162+
.setName(SubscriptionName.of(subscriptionId))
163163
.build();
164164
165165
Subscription subscription =
@@ -172,8 +172,8 @@ custom_content: |
172172
// may be a gap at that offset.
173173
DeliveryConfig.newBuilder()
174174
.setDeliveryRequirement(DeliveryRequirement.DELIVER_IMMEDIATELY))
175-
.setName(subscriptionPath.value())
176-
.setTopic(topicPath.value())
175+
.setName(subscriptionPath.toString())
176+
.setTopic(topicPath.toString())
177177
.build();
178178
179179
AdminClientSettings adminClientSettings =
@@ -212,10 +212,10 @@ custom_content: |
212212
String subscriptionId = "your-subscription-id";
213213
214214
SubscriptionPath subscriptionPath =
215-
SubscriptionPaths.newBuilder()
216-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
217-
.setProjectNumber(ProjectNumber.of(projectNumber))
218-
.setSubscriptionName(SubscriptionName.of(subscriptionId))
215+
SubscriptionPath.newBuilder()
216+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
217+
.setProject(ProjectNumber.of(projectNumber))
218+
.setName(SubscriptionName.of(subscriptionId))
219219
.build();
220220
221221
// The message stream is paused based on the maximum size or number of messages that the
@@ -248,7 +248,7 @@ custom_content: |
248248
// Start the subscriber. Upon successful starting, its state will become RUNNING.
249249
subscriber.startAsync().awaitRunning();
250250
251-
System.out.println("Listening to messages on " + subscriptionPath.value() + "...");
251+
System.out.println("Listening to messages on " + subscriptionPath.toString() + "...");
252252
253253
try {
254254
System.out.println(subscriber.state());

‎README.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you are using Maven, add this to your pom.xml file:
2020
<dependency>
2121
<groupId>com.google.cloud</groupId>
2222
<artifactId>google-cloud-pubsublite</artifactId>
23-
<version>0.2.0</version>
23+
<version>0.3.0</version>
2424
</dependency>
2525
<dependency>
2626
<groupId>com.google.cloud</groupId>
@@ -108,10 +108,10 @@ String topicId = "your-topic-id";
108108
Integer partitions = 1;
109109

110110
TopicPath topicPath =
111-
TopicPaths.newBuilder()
112-
.setProjectNumber(ProjectNumber.of(projectNumber))
113-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
114-
.setTopicName(TopicName.of(topicId))
111+
TopicPath.newBuilder()
112+
.setProject(ProjectNumber.of(projectNumber))
113+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
114+
.setName(TopicName.of(topicId))
115115
.build();
116116

117117
Topic topic =
@@ -132,7 +132,7 @@ Topic topic =
132132
// beyond this value, older messages will be dropped to make room for
133133
// newer ones, regardless of the value of `period`.
134134
.setPerPartitionBytes(30 * 1024 * 1024 * 1024L))
135-
.setName(topicPath.value())
135+
.setName(topicPath.toString())
136136
.build();
137137

138138
AdminClientSettings adminClientSettings =
@@ -168,10 +168,10 @@ String topicId = "your-topic-id";
168168
int messageCount = 100;
169169

170170
TopicPath topicPath =
171-
TopicPaths.newBuilder()
172-
.setProjectNumber(ProjectNumber.of(projectNumber))
173-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
174-
.setTopicName(TopicName.of(topicId))
171+
TopicPath.newBuilder()
172+
.setProject(ProjectNumber.of(projectNumber))
173+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
174+
.setName(TopicName.of(topicId))
175175
.build();
176176
Publisher publisher = null;
177177
List<ApiFuture<String>> futures = new ArrayList<>();
@@ -236,17 +236,17 @@ String topicId = "your-topic-id";
236236
String subscriptionId = "your-subscription-id";
237237

238238
TopicPath topicPath =
239-
TopicPaths.newBuilder()
240-
.setProjectNumber(ProjectNumber.of(projectNumber))
241-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
242-
.setTopicName(TopicName.of(topicId))
239+
TopicPath.newBuilder()
240+
.setProject(ProjectNumber.of(projectNumber))
241+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
242+
.setName(TopicName.of(topicId))
243243
.build();
244244

245245
SubscriptionPath subscriptionPath =
246-
SubscriptionPaths.newBuilder()
247-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
248-
.setProjectNumber(ProjectNumber.of(projectNumber))
249-
.setSubscriptionName(SubscriptionName.of(subscriptionId))
246+
SubscriptionPath.newBuilder()
247+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
248+
.setProject(ProjectNumber.of(projectNumber))
249+
.setName(SubscriptionName.of(subscriptionId))
250250
.build();
251251

252252
Subscription subscription =
@@ -259,8 +259,8 @@ Subscription subscription =
259259
// may be a gap at that offset.
260260
DeliveryConfig.newBuilder()
261261
.setDeliveryRequirement(DeliveryRequirement.DELIVER_IMMEDIATELY))
262-
.setName(subscriptionPath.value())
263-
.setTopic(topicPath.value())
262+
.setName(subscriptionPath.toString())
263+
.setTopic(topicPath.toString())
264264
.build();
265265

266266
AdminClientSettings adminClientSettings =
@@ -299,10 +299,10 @@ String topicId = "your-topic-id";
299299
String subscriptionId = "your-subscription-id";
300300

301301
SubscriptionPath subscriptionPath =
302-
SubscriptionPaths.newBuilder()
303-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
304-
.setProjectNumber(ProjectNumber.of(projectNumber))
305-
.setSubscriptionName(SubscriptionName.of(subscriptionId))
302+
SubscriptionPath.newBuilder()
303+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
304+
.setProject(ProjectNumber.of(projectNumber))
305+
.setName(SubscriptionName.of(subscriptionId))
306306
.build();
307307

308308
// The message stream is paused based on the maximum size or number of messages that the
@@ -335,7 +335,7 @@ Subscriber subscriber = Subscriber.create(subscriberSettings);
335335
// Start the subscriber. Upon successful starting, its state will become RUNNING.
336336
subscriber.startAsync().awaitRunning();
337337

338-
System.out.println("Listening to messages on " + subscriptionPath.value() + "...");
338+
System.out.println("Listening to messages on " + subscriptionPath.toString() + "...");
339339

340340
try {
341341
System.out.println(subscriber.state());

‎google-cloud-pubsublite/src/main/java/com/google/cloud/pubsublite/internal/AdminClientImpl.java‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,12 @@ public ApiFuture<Long> getTopicPartitionCount(TopicPath path) {
139139
@Override
140140
public ApiFuture<List<Topic>> listTopics(LocationPath path) {
141141
return RetryingExecutorUtil.runWithRetries(
142-
() -> stub.listTopics(
143-
ListTopicsRequest.newBuilder()
144-
.setParent(ProjectLookupUtils.toCannonical(path).toString())
145-
.build())
146-
.getTopicsList(),
142+
() ->
143+
stub.listTopics(
144+
ListTopicsRequest.newBuilder()
145+
.setParent(ProjectLookupUtils.toCannonical(path).toString())
146+
.build())
147+
.getTopicsList(),
147148
listTopicsRetryingExecutor);
148149
}
149150

@@ -226,11 +227,12 @@ public ApiFuture<Subscription> getSubscription(SubscriptionPath path) {
226227
@Override
227228
public ApiFuture<List<Subscription>> listSubscriptions(LocationPath path) {
228229
return RetryingExecutorUtil.runWithRetries(
229-
() -> stub.listSubscriptions(
230-
ListSubscriptionsRequest.newBuilder()
231-
.setParent(ProjectLookupUtils.toCannonical(path).toString())
232-
.build())
233-
.getSubscriptionsList(),
230+
() ->
231+
stub.listSubscriptions(
232+
ListSubscriptionsRequest.newBuilder()
233+
.setParent(ProjectLookupUtils.toCannonical(path).toString())
234+
.build())
235+
.getSubscriptionsList(),
234236
listSubscriptionsRetryingExecutor);
235237
}
236238

‎samples/snippets/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
<dependency>
4747
<groupId>com.google.cloud</groupId>
4848
<artifactId>google-cloud-pubsublite</artifactId>
49-
<version>0.2.0</version>
49+
<version>0.3.0</version>
5050
</dependency>
5151
<dependency>
5252
<groupId>com.google.cloud</groupId>

‎samples/snippets/src/main/java/pubsublite/CreateSubscriptionExample.java‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@
2424
import com.google.cloud.pubsublite.ProjectNumber;
2525
import com.google.cloud.pubsublite.SubscriptionName;
2626
import com.google.cloud.pubsublite.SubscriptionPath;
27-
import com.google.cloud.pubsublite.SubscriptionPaths;
2827
import com.google.cloud.pubsublite.TopicName;
2928
import com.google.cloud.pubsublite.TopicPath;
30-
import com.google.cloud.pubsublite.TopicPaths;
3129
import com.google.cloud.pubsublite.proto.Subscription;
3230
import com.google.cloud.pubsublite.proto.Subscription.DeliveryConfig;
3331
import com.google.cloud.pubsublite.proto.Subscription.DeliveryConfig.DeliveryRequirement;
@@ -50,17 +48,17 @@ public static void createSubscriptionExample(
5048
throws Exception {
5149

5250
TopicPath topicPath =
53-
TopicPaths.newBuilder()
54-
.setProjectNumber(ProjectNumber.of(projectNumber))
55-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
56-
.setTopicName(TopicName.of(topicId))
51+
TopicPath.newBuilder()
52+
.setProject(ProjectNumber.of(projectNumber))
53+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
54+
.setName(TopicName.of(topicId))
5755
.build();
5856

5957
SubscriptionPath subscriptionPath =
60-
SubscriptionPaths.newBuilder()
61-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
62-
.setProjectNumber(ProjectNumber.of(projectNumber))
63-
.setSubscriptionName(SubscriptionName.of(subscriptionId))
58+
SubscriptionPath.newBuilder()
59+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
60+
.setProject(ProjectNumber.of(projectNumber))
61+
.setName(SubscriptionName.of(subscriptionId))
6462
.build();
6563

6664
Subscription subscription =
@@ -73,8 +71,8 @@ public static void createSubscriptionExample(
7371
// may be a gap at that offset.
7472
DeliveryConfig.newBuilder()
7573
.setDeliveryRequirement(DeliveryRequirement.DELIVER_IMMEDIATELY))
76-
.setName(subscriptionPath.value())
77-
.setTopic(topicPath.value())
74+
.setName(subscriptionPath.toString())
75+
.setTopic(topicPath.toString())
7876
.build();
7977

8078
AdminClientSettings adminClientSettings =

‎samples/snippets/src/main/java/pubsublite/CreateTopicExample.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import com.google.cloud.pubsublite.ProjectNumber;
2525
import com.google.cloud.pubsublite.TopicName;
2626
import com.google.cloud.pubsublite.TopicPath;
27-
import com.google.cloud.pubsublite.TopicPaths;
2827
import com.google.cloud.pubsublite.proto.Topic;
2928
import com.google.cloud.pubsublite.proto.Topic.PartitionConfig;
3029
import com.google.cloud.pubsublite.proto.Topic.RetentionConfig;
@@ -48,10 +47,10 @@ public static void createTopicExample(
4847
throws Exception {
4948

5049
TopicPath topicPath =
51-
TopicPaths.newBuilder()
52-
.setProjectNumber(ProjectNumber.of(projectNumber))
53-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
54-
.setTopicName(TopicName.of(topicId))
50+
TopicPath.newBuilder()
51+
.setProject(ProjectNumber.of(projectNumber))
52+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
53+
.setName(TopicName.of(topicId))
5554
.build();
5655

5756
Topic topic =
@@ -72,7 +71,7 @@ public static void createTopicExample(
7271
// beyond this value, older messages will be dropped to make room for
7372
// newer ones, regardless of the value of `period`.
7473
.setPerPartitionBytes(30 * 1024 * 1024 * 1024L))
75-
.setName(topicPath.value())
74+
.setName(topicPath.toString())
7675
.build();
7776

7877
AdminClientSettings adminClientSettings =

‎samples/snippets/src/main/java/pubsublite/DeleteSubscriptionExample.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import com.google.cloud.pubsublite.ProjectNumber;
2525
import com.google.cloud.pubsublite.SubscriptionName;
2626
import com.google.cloud.pubsublite.SubscriptionPath;
27-
import com.google.cloud.pubsublite.SubscriptionPaths;
2827

2928
public class DeleteSubscriptionExample {
3029

@@ -43,18 +42,18 @@ public static void deleteSubscriptionExample(
4342
String cloudRegion, char zoneId, long projectNumber, String subscriptionId) throws Exception {
4443

4544
SubscriptionPath subscriptionPath =
46-
SubscriptionPaths.newBuilder()
47-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
48-
.setProjectNumber(ProjectNumber.of(projectNumber))
49-
.setSubscriptionName(SubscriptionName.of(subscriptionId))
45+
SubscriptionPath.newBuilder()
46+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
47+
.setProject(ProjectNumber.of(projectNumber))
48+
.setName(SubscriptionName.of(subscriptionId))
5049
.build();
5150

5251
AdminClientSettings adminClientSettings =
5352
AdminClientSettings.newBuilder().setRegion(CloudRegion.of(cloudRegion)).build();
5453

5554
try (AdminClient adminClient = AdminClient.create(adminClientSettings)) {
5655
adminClient.deleteSubscription(subscriptionPath).get();
57-
System.out.println(subscriptionPath.value() + " deleted successfully.");
56+
System.out.println(subscriptionPath.toString() + " deleted successfully.");
5857
}
5958
}
6059
}

‎samples/snippets/src/main/java/pubsublite/DeleteTopicExample.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import com.google.cloud.pubsublite.ProjectNumber;
2525
import com.google.cloud.pubsublite.TopicName;
2626
import com.google.cloud.pubsublite.TopicPath;
27-
import com.google.cloud.pubsublite.TopicPaths;
2827

2928
public class DeleteTopicExample {
3029

@@ -42,18 +41,18 @@ public static void main(String... args) throws Exception {
4241
public static void deleteTopicExample(
4342
String cloudRegion, char zoneId, long projectNumber, String topicId) throws Exception {
4443
TopicPath topicPath =
45-
TopicPaths.newBuilder()
46-
.setProjectNumber(ProjectNumber.of(projectNumber))
47-
.setZone(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
48-
.setTopicName(TopicName.of(topicId))
44+
TopicPath.newBuilder()
45+
.setProject(ProjectNumber.of(projectNumber))
46+
.setLocation(CloudZone.of(CloudRegion.of(cloudRegion), zoneId))
47+
.setName(TopicName.of(topicId))
4948
.build();
5049

5150
AdminClientSettings adminClientSettings =
5251
AdminClientSettings.newBuilder().setRegion(CloudRegion.of(cloudRegion)).build();
5352

5453
try (AdminClient adminClient = AdminClient.create(adminClientSettings)) {
5554
adminClient.deleteTopic(topicPath).get();
56-
System.out.println(topicPath.value() + " deleted successfully.");
55+
System.out.println(topicPath.toString() + " deleted successfully.");
5756
}
5857
}
5958
} // [END pubsublite_delete_topic]

0 commit comments

Comments
 (0)