Skip to content

Commit e0e657c

Browse files
jabubakejabubake
committed
standardize doc tags
1 parent c61a9c6 commit e0e657c

6 files changed

Lines changed: 56 additions & 60 deletions

File tree

‎google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/snippets/CreateTopicAndPublishMessages.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public static void createTopic() throws Exception {
4141
}
4242

4343
public static void publishMessages() throws Exception {
44-
// [START publish]
44+
// [START pubsub_publish]
4545
TopicName topicName = TopicName.create("my-project-id", "my-topic-id");
4646
Publisher publisher = null;
4747
List<ApiFuture<String>> messageIdFutures = new ArrayList<>();
@@ -75,7 +75,7 @@ public static void publishMessages() throws Exception {
7575
publisher.shutdown();
7676
}
7777
}
78-
// [END publish]
78+
// [END pubsub_publish]
7979
}
8080

8181
public static void main(String... args) throws Exception {

‎google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/snippets/MessageReceiverSnippets.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ public MessageReceiverSnippets(BlockingQueue<PubsubMessage> blockingQueue) {
4646
*/
4747
// [TARGET receiveMessage(PubsubMessage, AckReplyConsumer)]
4848
public MessageReceiver messageReceiver() {
49-
// [START receiveMessage]
5049
MessageReceiver receiver = new MessageReceiver() {
5150
public void receiveMessage(final PubsubMessage message, final AckReplyConsumer consumer) {
5251
if (blockingQueue.offer(message)) {
@@ -56,7 +55,6 @@ public void receiveMessage(final PubsubMessage message, final AckReplyConsumer c
5655
}
5756
}
5857
};
59-
// [END receiveMessage]
6058
return receiver;
6159
}
6260
}

‎google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/snippets/PublisherSnippets.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public static void newBuilder(String projectId, String topicId) throws Exception
8686
}
8787

8888
public Publisher getPublisherWithCustomBatchSettings(TopicName topicName) throws Exception {
89-
// [START publisherBatchSettings]
89+
// [START pubsub_publisher_batch_settings]
9090
// Batch settings control how the publisher batches messages
9191
long requestBytesThreshold = 5000L; // default : 1kb
9292
long messageCountBatchSize = 10L; // default : 100
@@ -102,12 +102,12 @@ public Publisher getPublisherWithCustomBatchSettings(TopicName topicName) throws
102102

103103
Publisher publisher = Publisher.defaultBuilder(topicName)
104104
.setBatchingSettings(batchingSettings).build();
105-
// [END publisherBatchSettings]
105+
// [END pubsub_publisher_batch_settings]
106106
return publisher;
107107
}
108108

109109
public Publisher getPublisherWithCustomRetrySettings(TopicName topicName) throws Exception {
110-
// [START publisherRetrySettings]
110+
// [START pubsub_publisher_retry_settings]
111111
// Retry settings control how the publisher handles retryable failures
112112
Duration retryDelay = Duration.ofMillis(100); // default : 1 ms
113113
double retryDelayMultiplier = 2.0; // back off for repeated failures
@@ -121,12 +121,12 @@ public Publisher getPublisherWithCustomRetrySettings(TopicName topicName) throws
121121

122122
Publisher publisher = Publisher.defaultBuilder(topicName)
123123
.setRetrySettings(retrySettings).build();
124-
// [END publisherRetrySettings]
124+
// [END pubsub_publisher_retry_settings]
125125
return publisher;
126126
}
127127

128128
public Publisher getPublisherWithCustomFlowControlSettings(TopicName topicName) throws Exception {
129-
// [START publisherFlowControlSettings]
129+
// [START pubsub_publisher_flow_settings]
130130

131131
// Flow control settings restrict the number of outstanding publish requests
132132
int maxOutstandingBatches = 20;
@@ -143,23 +143,23 @@ public Publisher getPublisherWithCustomFlowControlSettings(TopicName topicName)
143143

144144
Publisher publisher = Publisher.defaultBuilder(topicName)
145145
.setFlowControlSettings(flowControlSettings).build();
146-
// [END publisherFlowControlSettings]
146+
// [END pubsub_publisher_flow_settings]
147147
return publisher;
148148
}
149149

150150
public Publisher getSingleThreadedPublisher(TopicName topicName) throws Exception {
151-
// [START singleThreadedPublisher]
151+
// [START pubsub_publisher_single_threaded]
152152
// create a publisher with a single threaded executor
153153
ExecutorProvider executorProvider = InstantiatingExecutorProvider.newBuilder()
154154
.setExecutorThreadCount(1).build();
155155
Publisher publisher = Publisher.defaultBuilder(topicName)
156156
.setExecutorProvider(executorProvider).build();
157-
// [END singleThreadedPublisher]
157+
// [END pubsub_publisher_single_threaded]
158158
return publisher;
159159
}
160160

161161
private Publisher createPublisherWithCustomCredentials(TopicName topicName) throws Exception {
162-
// [START publisherWithCustomCredentials]
162+
// [START pubsub_publisher_custom_credentials]
163163
// read service account credentials from file
164164
CredentialsProvider credentialsProvider =
165165
FixedCredentialsProvider.create(
@@ -171,7 +171,7 @@ private Publisher createPublisherWithCustomCredentials(TopicName topicName) thro
171171
Publisher publisher = Publisher.defaultBuilder(topicName)
172172
.setChannelProvider(channelProvider)
173173
.build();
174-
// [END publisherWithCustomCredentials]
174+
// [END pubsub_publisher_custom_credentials]
175175
return publisher;
176176
}
177177
}

‎google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/snippets/SubscriberSnippets.java‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ public SubscriberSnippets(
6161

6262
// [TARGET startAsync()]
6363
public void startAndWait() throws Exception {
64-
// [START startAsync]
6564
Subscriber subscriber = Subscriber.defaultBuilder(subscriptionName, receiver).build();
6665
subscriber.addListener(new Subscriber.Listener() {
6766
public void failed(Subscriber.State from, Throwable failure) {
@@ -73,11 +72,10 @@ public void failed(Subscriber.State from, Throwable failure) {
7372
// Wait for a stop signal.
7473
done.get();
7574
subscriber.stopAsync().awaitTerminated();
76-
// [END startAsync]
7775
}
7876

7977
private void createSubscriber() throws Exception {
80-
// [START pullSubscriber]
78+
// [START pubsub_pull]
8179
String projectId = "my-project-id";
8280
String subscriptionId = "my-subscription-id";
8381

@@ -105,35 +103,35 @@ public void receiveMessage(PubsubMessage message, AckReplyConsumer consumer) {
105103
subscriber.stopAsync();
106104
}
107105
}
108-
// [END pullSubscriber]
106+
// [END pubsub_pull]
109107
}
110108

111109
private Subscriber createSubscriberWithErrorListener(Subscriber subscriber) throws Exception {
112-
// [START subscriberWithErrorListener]
110+
// [START pubsub_subscriber_error_listener]
113111
subscriber.addListener(new Subscriber.Listener() {
114112
public void failed(Subscriber.State from, Throwable failure) {
115113
// Handle error.
116114
}
117115
}, MoreExecutors.directExecutor());
118-
// [END subscriberWithErrorListener]
116+
// [END pubsub_subscriber_error_listener]
119117
return subscriber;
120118
}
121119

122120
private Subscriber createSingleThreadedSubscriber() throws Exception {
123-
// [START singleThreadedSubscriber]
121+
// [START pubsub_subscriber_single_threaded]
124122
// provide a separate executor service for polling
125123
ExecutorProvider executorProvider = InstantiatingExecutorProvider.newBuilder()
126124
.setExecutorThreadCount(1).build();
127125

128126
Subscriber subscriber = Subscriber.defaultBuilder(subscriptionName, receiver)
129127
.setExecutorProvider(executorProvider)
130128
.build();
131-
// [END singleThreadedSubscriber]
129+
// [END pubsub_subscriber_single_threaded]
132130
return subscriber;
133131
}
134132

135133
private Subscriber createSubscriberWithCustomFlowSettings() throws Exception {
136-
// [START subscriberWithCustomFlow]
134+
// [START pubsub_subscriber_flow_settings]
137135
int maxMessageCount = 10;
138136
// Configure max number of messages to be pulled
139137
FlowControlSettings flowControlSettings = FlowControlSettings.newBuilder()
@@ -142,12 +140,12 @@ private Subscriber createSubscriberWithCustomFlowSettings() throws Exception {
142140
Subscriber subscriber = Subscriber.defaultBuilder(subscriptionName, receiver)
143141
.setFlowControlSettings(flowControlSettings)
144142
.build();
145-
// [END subscriberWithCustomFlow]
143+
// [END pubsub_subscriber_flow_settings]
146144
return subscriber;
147145
}
148146

149147
private Subscriber createSubscriberWithCustomCredentials() throws Exception {
150-
// [START subscriberWithCustomCredentials]
148+
// [START pubsub_subscriber_custom_credentials]
151149
CredentialsProvider credentialsProvider =
152150
FixedCredentialsProvider
153151
.create(ServiceAccountCredentials.fromStream(
@@ -159,7 +157,7 @@ private Subscriber createSubscriberWithCustomCredentials() throws Exception {
159157
Subscriber subscriber = Subscriber.defaultBuilder(subscriptionName, receiver)
160158
.setChannelProvider(channelProvider)
161159
.build();
162-
// [START subscriberWithCustomCredentials]
160+
// [START pubsub_subscriber_custom_credentials]
163161
return subscriber;
164162
}
165163
}

‎google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/snippets/SubscriptionAdminClientSnippets.java‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public String getProjectId() {
5454

5555
/** Example of creating a pull subscription for a topic. */
5656
public Subscription createSubscription(String topicId, String subscriptionId) throws Exception {
57-
// [START createPullSubscription]
57+
// [START pubsub_create_pull_subscription]
5858
try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
5959
// eg. projectId = "my-test-project", topicId = "my-test-topic"
6060
TopicName topicName = TopicName.create(projectId, topicId);
@@ -67,14 +67,14 @@ public Subscription createSubscription(String topicId, String subscriptionId) th
6767
subscriptionName, topicName, PushConfig.getDefaultInstance(), 0);
6868
return subscription;
6969
}
70-
// [END createPullSubscription]
70+
// [END pubsub_create_pull_subscription]
7171
}
7272

7373
/** Example of creating a subscription with a push endpoint. */
7474
public Subscription createSubscriptionWithPushEndpoint(String topicId, String subscriptionId,
7575
String endpoint)
7676
throws Exception {
77-
// [START createPushSubscription]
77+
// [START pubsub_create_push_subscription]
7878
try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
7979
TopicName topicName = TopicName.create(projectId, topicId);
8080
SubscriptionName subscriptionName =
@@ -91,23 +91,23 @@ public Subscription createSubscriptionWithPushEndpoint(String topicId, String su
9191
subscriptionName, topicName, pushConfig, ackDeadlineInSeconds);
9292
return subscription;
9393
}
94-
// [END createPushSubscription]
94+
// [END pubsub_create_push_subscription]
9595
}
9696

9797
/** Example of replacing the push configuration of a subscription, setting the push endpoint. */
9898
public void replacePushConfig(String subscriptionId, String endpoint) throws Exception {
99-
// [START replacePushConfig]
99+
// [START pubsub_update_push_configuration]
100100
try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
101101
SubscriptionName subscriptionName = SubscriptionName.create(projectId, subscriptionId);
102102
PushConfig pushConfig = PushConfig.newBuilder().setPushEndpoint(endpoint).build();
103103
subscriptionAdminClient.modifyPushConfig(subscriptionName, pushConfig);
104104
}
105-
// [END replacePushConfig]
105+
// [END pubsub_update_push_configuration]
106106
}
107107

108108
/** Example of listing subscriptions. */
109109
public ListSubscriptionsPagedResponse listSubscriptions() throws Exception {
110-
// [START listSubscriptions]
110+
// [START pubsub_list_subscriptions]
111111
try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
112112
ListSubscriptionsRequest listSubscriptionsRequest =
113113
ListSubscriptionsRequest.newBuilder()
@@ -121,23 +121,23 @@ public ListSubscriptionsPagedResponse listSubscriptions() throws Exception {
121121
}
122122
return response;
123123
}
124-
// [END listSubscriptions]
124+
// [END pubsub_list_subscriptions]
125125
}
126126

127127
/** Example of deleting a subscription. */
128128
public SubscriptionName deleteSubscription(String subscriptionId) throws Exception {
129-
// [START deleteSubscription]
129+
// [START pubsub_delete_subscription]
130130
try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
131131
SubscriptionName subscriptionName = SubscriptionName.create(projectId, subscriptionId);
132132
subscriptionAdminClient.deleteSubscription(subscriptionName);
133133
return subscriptionName;
134134
}
135-
// [END deleteSubscription]
135+
// [END pubsub_delete_subscription]
136136
}
137137

138138
/** Example of getting a subscription policy. */
139139
public Policy getSubscriptionPolicy(String subscriptionId) throws Exception {
140-
// [START getSubscriptionPolicy]
140+
// [START pubsub_get_subscription_policy]
141141
try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
142142
SubscriptionName subscriptionName = SubscriptionName.create(projectId, subscriptionId);
143143
Policy policy = subscriptionAdminClient.getIamPolicy(subscriptionName.toString());
@@ -146,12 +146,12 @@ public Policy getSubscriptionPolicy(String subscriptionId) throws Exception {
146146
}
147147
return policy;
148148
}
149-
// [END getSubscriptionPolicy]
149+
// [END pubsub_get_subscription_policy]
150150
}
151151

152152
/** Example of replacing a subscription policy. */
153153
public Policy replaceSubscriptionPolicy(String subscriptionId) throws Exception {
154-
// [START replaceSubscriptionPolicy]
154+
// [START pubsub_update_subscription_policy]
155155
try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
156156
SubscriptionName subscriptionName = SubscriptionName.create(projectId, subscriptionId);
157157
Policy policy = subscriptionAdminClient.getIamPolicy(subscriptionName.toString());
@@ -167,13 +167,13 @@ public Policy replaceSubscriptionPolicy(String subscriptionId) throws Exception
167167
updatedPolicy = subscriptionAdminClient.setIamPolicy(subscriptionName.toString(), updatedPolicy);
168168
return updatedPolicy;
169169
}
170-
// [END replaceSubscriptionPolicy]
170+
// [END pubsub_update_subscription_policy]
171171
}
172172

173173
/** Example of testing whether the caller has the provided permissions on a subscription. */
174174
public TestIamPermissionsResponse testSubscriptionPermissions(String subscriptionId)
175175
throws Exception {
176-
// [START testSubscriptionPermissions]
176+
// [START pubsub_test_subscription_permissions]
177177
try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
178178
List<String> permissions = new LinkedList<>();
179179
permissions.add("pubsub.subscriptions.get");
@@ -182,17 +182,17 @@ public TestIamPermissionsResponse testSubscriptionPermissions(String subscriptio
182182
topicAdminClient.testIamPermissions(subscriptionName.toString(), permissions);
183183
return testedPermissions;
184184
}
185-
// [END testSubscriptionPermissions]
185+
// [END pubsub_test_subscription_permissions]
186186
}
187187

188188
/** Example of getting a subscription. */
189189
public Subscription getSubscription(String subscriptionId) throws Exception {
190-
// [START getSubscription]
190+
// [START pubsub_get_subscription]
191191
try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
192192
SubscriptionName subscriptionName = SubscriptionName.create(projectId, subscriptionId);
193193
Subscription subscription = subscriptionAdminClient.getSubscription(subscriptionName);
194194
return subscription;
195195
}
196-
// [END getSubscription]
196+
// [END pubsub_get_subscription]
197197
}
198198
}

0 commit comments

Comments
 (0)