Skip to content

Commit 9591b89

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: [cloudtrace] Remove html formatting (cleanup) (#9027)
* feat: Add Cloud Trace v2 retry defaults for BatchWriteSpans PiperOrigin-RevId: 504068544 Source-Link: googleapis/googleapis@685d359 Source-Link: https://github.com/googleapis/googleapis-gen/commit/43aa9dacfc417b625ad8be1bed2a9fc36c277db6 Copy-Tag: eyJwIjoiamF2YS10cmFjZS8uT3dsQm90LnlhbWwiLCJoIjoiNDNhYTlkYWNmYzQxN2I2MjVhZDhiZTFiZWQyYTlmYzM2YzI3N2RiNiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: Remove html formatting (cleanup) PiperOrigin-RevId: 504326606 Source-Link: googleapis/googleapis@b7bb7fb Source-Link: https://github.com/googleapis/googleapis-gen/commit/cee916aedc9eb8fddd84433132cab5752a20c985 Copy-Tag: eyJwIjoiamF2YS10cmFjZS8uT3dsQm90LnlhbWwiLCJoIjoiY2VlOTE2YWVkYzllYjhmZGRkODQ0MzMxMzJjYWI1NzUyYTIwYzk4NSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent c63dc4f commit 9591b89

13 files changed

Lines changed: 594 additions & 524 deletions

File tree

‎java-trace/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file:
1919
<dependency>
2020
<groupId>com.google.cloud</groupId>
2121
<artifactId>google-cloud-trace</artifactId>
22-
<version>2.8.0</version>
22+
<version>2.9.0</version>
2323
</dependency>
2424
```
2525

2626
If you are using Gradle without BOM, add this to your dependencies:
2727

2828
```Groovy
29-
implementation 'com.google.cloud:google-cloud-trace:2.8.0'
29+
implementation 'com.google.cloud:google-cloud-trace:2.9.0'
3030
```
3131

3232
If you are using SBT, add this to your dependencies:
3333

3434
```Scala
35-
libraryDependencies += "com.google.cloud" % "google-cloud-trace" % "2.8.0"
35+
libraryDependencies += "com.google.cloud" % "google-cloud-trace" % "2.9.0"
3636
```
3737

3838
## Authentication

‎java-trace/google-cloud-trace/src/main/java/com/google/cloud/trace/v2/TraceServiceClient.java‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,13 @@
3131

3232
// AUTO-GENERATED DOCUMENTATION AND CLASS.
3333
/**
34-
* Service Description: This file describes an API for collecting and viewing traces and spans
35-
* within a trace. A Trace is a collection of spans corresponding to a single operation or set of
36-
* operations for an application. A span is an individual timed event which forms a node of the
37-
* trace tree. A single trace may contain span(s) from multiple services.
34+
* Service Description: Service for collecting and viewing traces and spans within a trace.
35+
*
36+
* <p>A trace is a collection of spans corresponding to a single operation or a set of operations in
37+
* an application.
38+
*
39+
* <p>A span is an individual timed event which forms a node of the trace tree. A single trace can
40+
* contain spans from multiple services.
3841
*
3942
* <p>This class provides the ability to make remote calls to the backing service through method
4043
* calls that map to API methods. Sample code to get started:
@@ -172,7 +175,7 @@ public TraceServiceStub getStub() {
172175

173176
// AUTO-GENERATED DOCUMENTATION AND METHOD.
174177
/**
175-
* Sends new spans to new or existing traces. You cannot update existing spans.
178+
* Batch writes new spans to new or existing traces. You cannot update existing spans.
176179
*
177180
* <p>Sample code:
178181
*
@@ -191,8 +194,8 @@ public TraceServiceStub getStub() {
191194
*
192195
* @param name Required. The name of the project where the spans belong. The format is
193196
* `projects/[PROJECT_ID]`.
194-
* @param spans Required. A list of new spans. The span names must not match existing spans, or
195-
* the results are undefined.
197+
* @param spans Required. A list of new spans. The span names must not match existing spans,
198+
* otherwise the results are undefined.
196199
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
197200
*/
198201
public final void batchWriteSpans(ProjectName name, List<Span> spans) {
@@ -206,7 +209,7 @@ public final void batchWriteSpans(ProjectName name, List<Span> spans) {
206209

207210
// AUTO-GENERATED DOCUMENTATION AND METHOD.
208211
/**
209-
* Sends new spans to new or existing traces. You cannot update existing spans.
212+
* Batch writes new spans to new or existing traces. You cannot update existing spans.
210213
*
211214
* <p>Sample code:
212215
*
@@ -225,8 +228,8 @@ public final void batchWriteSpans(ProjectName name, List<Span> spans) {
225228
*
226229
* @param name Required. The name of the project where the spans belong. The format is
227230
* `projects/[PROJECT_ID]`.
228-
* @param spans Required. A list of new spans. The span names must not match existing spans, or
229-
* the results are undefined.
231+
* @param spans Required. A list of new spans. The span names must not match existing spans,
232+
* otherwise the results are undefined.
230233
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
231234
*/
232235
public final void batchWriteSpans(String name, List<Span> spans) {
@@ -237,7 +240,7 @@ public final void batchWriteSpans(String name, List<Span> spans) {
237240

238241
// AUTO-GENERATED DOCUMENTATION AND METHOD.
239242
/**
240-
* Sends new spans to new or existing traces. You cannot update existing spans.
243+
* Batch writes new spans to new or existing traces. You cannot update existing spans.
241244
*
242245
* <p>Sample code:
243246
*
@@ -266,7 +269,7 @@ public final void batchWriteSpans(BatchWriteSpansRequest request) {
266269

267270
// AUTO-GENERATED DOCUMENTATION AND METHOD.
268271
/**
269-
* Sends new spans to new or existing traces. You cannot update existing spans.
272+
* Batch writes new spans to new or existing traces. You cannot update existing spans.
270273
*
271274
* <p>Sample code:
272275
*

‎java-trace/google-cloud-trace/src/main/java/com/google/cloud/trace/v2/package-info.java‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,19 @@
1515
*/
1616

1717
/**
18-
* The interfaces provided are listed below, along with usage samples.
18+
* A client to Stackdriver Trace API
19+
*
20+
* <p>The interfaces provided are listed below, along with usage samples.
1921
*
2022
* <p>======================= TraceServiceClient =======================
2123
*
22-
* <p>Service Description: This file describes an API for collecting and viewing traces and spans
23-
* within a trace. A Trace is a collection of spans corresponding to a single operation or set of
24-
* operations for an application. A span is an individual timed event which forms a node of the
25-
* trace tree. A single trace may contain span(s) from multiple services.
24+
* <p>Service Description: Service for collecting and viewing traces and spans within a trace.
25+
*
26+
* <p>A trace is a collection of spans corresponding to a single operation or a set of operations in
27+
* an application.
28+
*
29+
* <p>A span is an individual timed event which forms a node of the trace tree. A single trace can
30+
* contain spans from multiple services.
2631
*
2732
* <p>Sample for TraceServiceClient:
2833
*

‎java-trace/google-cloud-trace/src/main/java/com/google/cloud/trace/v2/stub/TraceServiceStubSettings.java‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,10 @@ public static class Builder extends StubSettings.Builder<TraceServiceStubSetting
227227
ImmutableMap.Builder<String, ImmutableSet<StatusCode.Code>> definitions =
228228
ImmutableMap.builder();
229229
definitions.put(
230-
"no_retry_0_codes", ImmutableSet.copyOf(Lists.<StatusCode.Code>newArrayList()));
230+
"retry_policy_0_codes",
231+
ImmutableSet.copyOf(
232+
Lists.<StatusCode.Code>newArrayList(
233+
StatusCode.Code.UNAVAILABLE, StatusCode.Code.DEADLINE_EXCEEDED)));
231234
definitions.put(
232235
"retry_policy_1_codes",
233236
ImmutableSet.copyOf(
@@ -243,12 +246,15 @@ public static class Builder extends StubSettings.Builder<TraceServiceStubSetting
243246
RetrySettings settings = null;
244247
settings =
245248
RetrySettings.newBuilder()
249+
.setInitialRetryDelay(Duration.ofMillis(100L))
250+
.setRetryDelayMultiplier(2.0)
251+
.setMaxRetryDelay(Duration.ofMillis(30000L))
246252
.setInitialRpcTimeout(Duration.ofMillis(120000L))
247253
.setRpcTimeoutMultiplier(1.0)
248254
.setMaxRpcTimeout(Duration.ofMillis(120000L))
249255
.setTotalTimeout(Duration.ofMillis(120000L))
250256
.build();
251-
definitions.put("no_retry_0_params", settings);
257+
definitions.put("retry_policy_0_params", settings);
252258
settings =
253259
RetrySettings.newBuilder()
254260
.setInitialRetryDelay(Duration.ofMillis(100L))
@@ -319,8 +325,8 @@ private static Builder createHttpJsonDefault() {
319325
private static Builder initDefaults(Builder builder) {
320326
builder
321327
.batchWriteSpansSettings()
322-
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
323-
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"));
328+
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
329+
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));
324330

325331
builder
326332
.createSpanSettings()

‎java-trace/grpc-google-cloud-trace-v2/src/main/java/com/google/devtools/cloudtrace/v2/TraceServiceGrpc.java‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
*
2222
*
2323
* <pre>
24-
* This file describes an API for collecting and viewing traces and spans
25-
* within a trace. A Trace is a collection of spans corresponding to a single
26-
* operation or set of operations for an application. A span is an individual
27-
* timed event which forms a node of the trace tree. A single trace may
28-
* contain span(s) from multiple services.
24+
* Service for collecting and viewing traces and spans within a trace.
25+
* A trace is a collection of spans corresponding to a single
26+
* operation or a set of operations in an application.
27+
* A span is an individual timed event which forms a node of the trace tree.
28+
* A single trace can contain spans from multiple services.
2929
* </pre>
3030
*/
3131
@javax.annotation.Generated(
@@ -168,11 +168,11 @@ public TraceServiceFutureStub newStub(
168168
*
169169
*
170170
* <pre>
171-
* This file describes an API for collecting and viewing traces and spans
172-
* within a trace. A Trace is a collection of spans corresponding to a single
173-
* operation or set of operations for an application. A span is an individual
174-
* timed event which forms a node of the trace tree. A single trace may
175-
* contain span(s) from multiple services.
171+
* Service for collecting and viewing traces and spans within a trace.
172+
* A trace is a collection of spans corresponding to a single
173+
* operation or a set of operations in an application.
174+
* A span is an individual timed event which forms a node of the trace tree.
175+
* A single trace can contain spans from multiple services.
176176
* </pre>
177177
*/
178178
public abstract static class TraceServiceImplBase implements io.grpc.BindableService {
@@ -181,7 +181,7 @@ public abstract static class TraceServiceImplBase implements io.grpc.BindableSer
181181
*
182182
*
183183
* <pre>
184-
* Sends new spans to new or existing traces. You cannot update
184+
* Batch writes new spans to new or existing traces. You cannot update
185185
* existing spans.
186186
* </pre>
187187
*/
@@ -228,11 +228,11 @@ public final io.grpc.ServerServiceDefinition bindService() {
228228
*
229229
*
230230
* <pre>
231-
* This file describes an API for collecting and viewing traces and spans
232-
* within a trace. A Trace is a collection of spans corresponding to a single
233-
* operation or set of operations for an application. A span is an individual
234-
* timed event which forms a node of the trace tree. A single trace may
235-
* contain span(s) from multiple services.
231+
* Service for collecting and viewing traces and spans within a trace.
232+
* A trace is a collection of spans corresponding to a single
233+
* operation or a set of operations in an application.
234+
* A span is an individual timed event which forms a node of the trace tree.
235+
* A single trace can contain spans from multiple services.
236236
* </pre>
237237
*/
238238
public static final class TraceServiceStub
@@ -250,7 +250,7 @@ protected TraceServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
250250
*
251251
*
252252
* <pre>
253-
* Sends new spans to new or existing traces. You cannot update
253+
* Batch writes new spans to new or existing traces. You cannot update
254254
* existing spans.
255255
* </pre>
256256
*/
@@ -282,11 +282,11 @@ public void createSpan(
282282
*
283283
*
284284
* <pre>
285-
* This file describes an API for collecting and viewing traces and spans
286-
* within a trace. A Trace is a collection of spans corresponding to a single
287-
* operation or set of operations for an application. A span is an individual
288-
* timed event which forms a node of the trace tree. A single trace may
289-
* contain span(s) from multiple services.
285+
* Service for collecting and viewing traces and spans within a trace.
286+
* A trace is a collection of spans corresponding to a single
287+
* operation or a set of operations in an application.
288+
* A span is an individual timed event which forms a node of the trace tree.
289+
* A single trace can contain spans from multiple services.
290290
* </pre>
291291
*/
292292
public static final class TraceServiceBlockingStub
@@ -305,7 +305,7 @@ protected TraceServiceBlockingStub build(
305305
*
306306
*
307307
* <pre>
308-
* Sends new spans to new or existing traces. You cannot update
308+
* Batch writes new spans to new or existing traces. You cannot update
309309
* existing spans.
310310
* </pre>
311311
*/
@@ -333,11 +333,11 @@ public com.google.devtools.cloudtrace.v2.Span createSpan(
333333
*
334334
*
335335
* <pre>
336-
* This file describes an API for collecting and viewing traces and spans
337-
* within a trace. A Trace is a collection of spans corresponding to a single
338-
* operation or set of operations for an application. A span is an individual
339-
* timed event which forms a node of the trace tree. A single trace may
340-
* contain span(s) from multiple services.
336+
* Service for collecting and viewing traces and spans within a trace.
337+
* A trace is a collection of spans corresponding to a single
338+
* operation or a set of operations in an application.
339+
* A span is an individual timed event which forms a node of the trace tree.
340+
* A single trace can contain spans from multiple services.
341341
* </pre>
342342
*/
343343
public static final class TraceServiceFutureStub
@@ -356,7 +356,7 @@ protected TraceServiceFutureStub build(
356356
*
357357
*
358358
* <pre>
359-
* Sends new spans to new or existing traces. You cannot update
359+
* Batch writes new spans to new or existing traces. You cannot update
360360
* existing spans.
361361
* </pre>
362362
*/

‎java-trace/proto-google-cloud-trace-v2/src/main/java/com/google/devtools/cloudtrace/v2/AttributeValue.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
*
2323
*
2424
* <pre>
25-
* The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
25+
* The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
2626
* </pre>
2727
*
2828
* Protobuf type {@code google.devtools.cloudtrace.v2.AttributeValue}
@@ -444,7 +444,7 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
444444
*
445445
*
446446
* <pre>
447-
* The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
447+
* The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
448448
* </pre>
449449
*
450450
* Protobuf type {@code google.devtools.cloudtrace.v2.AttributeValue}

0 commit comments

Comments
 (0)