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>
googleapis · Feb 2, 2023 · 9591b89 · 9591b89
1 parent c63dc4f
commit 9591b89
Show file tree

Hide file tree

Showing 13 changed files with 594 additions and 524 deletions.
diff --git a/java-trace/README.md b/java-trace/README.md
@@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file:
 <dependency>
   <groupId>com.google.cloud</groupId>
   <artifactId>google-cloud-trace</artifactId>
-  <version>2.8.0</version>
+  <version>2.9.0</version>
 </dependency>
 ```
 
 If you are using Gradle without BOM, add this to your dependencies:
 
 ```Groovy
-implementation 'com.google.cloud:google-cloud-trace:2.8.0'
+implementation 'com.google.cloud:google-cloud-trace:2.9.0'
 ```
 
 If you are using SBT, add this to your dependencies:
 
 ```Scala
-libraryDependencies += "com.google.cloud" % "google-cloud-trace" % "2.8.0"
+libraryDependencies += "com.google.cloud" % "google-cloud-trace" % "2.9.0"
 ```
 
 ## Authentication

diff --git a/...-trace/google-cloud-trace/src/main/java/com/google/cloud/trace/v2/TraceServiceClient.java b/...-trace/google-cloud-trace/src/main/java/com/google/cloud/trace/v2/TraceServiceClient.java
@@ -31,10 +31,13 @@
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
- * Service Description: This file describes an API for collecting and viewing traces and spans
- * within a trace. A Trace is a collection of spans corresponding to a single operation or set of
- * operations for an application. A span is an individual timed event which forms a node of the
- * trace tree. A single trace may contain span(s) from multiple services.
+ * Service Description: Service for collecting and viewing traces and spans within a trace.
+ *
+ * <p>A trace is a collection of spans corresponding to a single operation or a set of operations in
+ * an application.
+ *
+ * <p>A span is an individual timed event which forms a node of the trace tree. A single trace can
+ * contain spans from multiple services.
  *
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:
@@ -172,7 +175,7 @@ public TraceServiceStub getStub() {
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Sends new spans to new or existing traces. You cannot update existing spans.
+   * Batch writes new spans to new or existing traces. You cannot update existing spans.
    *
    * <p>Sample code:
    *
@@ -191,8 +194,8 @@ public TraceServiceStub getStub() {
    *
    * @param name Required. The name of the project where the spans belong. The format is
    *     `projects/[PROJECT_ID]`.
-   * @param spans Required. A list of new spans. The span names must not match existing spans, or
-   *     the results are undefined.
+   * @param spans Required. A list of new spans. The span names must not match existing spans,
+   *     otherwise the results are undefined.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final void batchWriteSpans(ProjectName name, List<Span> spans) {
@@ -206,7 +209,7 @@ public final void batchWriteSpans(ProjectName name, List<Span> spans) {
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Sends new spans to new or existing traces. You cannot update existing spans.
+   * Batch writes new spans to new or existing traces. You cannot update existing spans.
    *
    * <p>Sample code:
    *
@@ -225,8 +228,8 @@ public final void batchWriteSpans(ProjectName name, List<Span> spans) {
    *
    * @param name Required. The name of the project where the spans belong. The format is
    *     `projects/[PROJECT_ID]`.
-   * @param spans Required. A list of new spans. The span names must not match existing spans, or
-   *     the results are undefined.
+   * @param spans Required. A list of new spans. The span names must not match existing spans,
+   *     otherwise the results are undefined.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final void batchWriteSpans(String name, List<Span> spans) {
@@ -237,7 +240,7 @@ public final void batchWriteSpans(String name, List<Span> spans) {
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Sends new spans to new or existing traces. You cannot update existing spans.
+   * Batch writes new spans to new or existing traces. You cannot update existing spans.
    *
    * <p>Sample code:
    *
@@ -266,7 +269,7 @@ public final void batchWriteSpans(BatchWriteSpansRequest request) {
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Sends new spans to new or existing traces. You cannot update existing spans.
+   * Batch writes new spans to new or existing traces. You cannot update existing spans.
    *
    * <p>Sample code:
    *

diff --git a/java-trace/google-cloud-trace/src/main/java/com/google/cloud/trace/v2/package-info.java b/java-trace/google-cloud-trace/src/main/java/com/google/cloud/trace/v2/package-info.java
@@ -15,14 +15,19 @@
  */
 
 /**
- * The interfaces provided are listed below, along with usage samples.
+ * A client to Stackdriver Trace API
+ *
+ * <p>The interfaces provided are listed below, along with usage samples.
  *
  * <p>======================= TraceServiceClient =======================
  *
- * <p>Service Description: This file describes an API for collecting and viewing traces and spans
- * within a trace. A Trace is a collection of spans corresponding to a single operation or set of
- * operations for an application. A span is an individual timed event which forms a node of the
- * trace tree. A single trace may contain span(s) from multiple services.
+ * <p>Service Description: Service for collecting and viewing traces and spans within a trace.
+ *
+ * <p>A trace is a collection of spans corresponding to a single operation or a set of operations in
+ * an application.
+ *
+ * <p>A span is an individual timed event which forms a node of the trace tree. A single trace can
+ * contain spans from multiple services.
  *
  * <p>Sample for TraceServiceClient:
  *

diff --git a/...le-cloud-trace/src/main/java/com/google/cloud/trace/v2/stub/TraceServiceStubSettings.java b/...le-cloud-trace/src/main/java/com/google/cloud/trace/v2/stub/TraceServiceStubSettings.java
@@ -227,7 +227,10 @@ public static class Builder extends StubSettings.Builder<TraceServiceStubSetting
       ImmutableMap.Builder<String, ImmutableSet<StatusCode.Code>> definitions =
           ImmutableMap.builder();
       definitions.put(
-          "no_retry_0_codes", ImmutableSet.copyOf(Lists.<StatusCode.Code>newArrayList()));
+          "retry_policy_0_codes",
+          ImmutableSet.copyOf(
+              Lists.<StatusCode.Code>newArrayList(
+                  StatusCode.Code.UNAVAILABLE, StatusCode.Code.DEADLINE_EXCEEDED)));
       definitions.put(
           "retry_policy_1_codes",
           ImmutableSet.copyOf(
@@ -243,12 +246,15 @@ public static class Builder extends StubSettings.Builder<TraceServiceStubSetting
       RetrySettings settings = null;
       settings =
           RetrySettings.newBuilder()
+              .setInitialRetryDelay(Duration.ofMillis(100L))
+              .setRetryDelayMultiplier(2.0)
+              .setMaxRetryDelay(Duration.ofMillis(30000L))
               .setInitialRpcTimeout(Duration.ofMillis(120000L))
               .setRpcTimeoutMultiplier(1.0)
               .setMaxRpcTimeout(Duration.ofMillis(120000L))
               .setTotalTimeout(Duration.ofMillis(120000L))
               .build();
-      definitions.put("no_retry_0_params", settings);
+      definitions.put("retry_policy_0_params", settings);
       settings =
           RetrySettings.newBuilder()
               .setInitialRetryDelay(Duration.ofMillis(100L))
@@ -319,8 +325,8 @@ private static Builder createHttpJsonDefault() {
     private static Builder initDefaults(Builder builder) {
       builder
           .batchWriteSpansSettings()
-          .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
-          .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"));
+          .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
+          .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));
 
       builder
           .createSpanSettings()

diff --git a/...ogle-cloud-trace-v2/src/main/java/com/google/devtools/cloudtrace/v2/TraceServiceGrpc.java b/...ogle-cloud-trace-v2/src/main/java/com/google/devtools/cloudtrace/v2/TraceServiceGrpc.java
@@ -21,11 +21,11 @@
  *
  *
  * <pre>
- * This file describes an API for collecting and viewing traces and spans
- * within a trace.  A Trace is a collection of spans corresponding to a single
- * operation or set of operations for an application. A span is an individual
- * timed event which forms a node of the trace tree. A single trace may
- * contain span(s) from multiple services.
+ * Service for collecting and viewing traces and spans within a trace.
+ * A trace is a collection of spans corresponding to a single
+ * operation or a set of operations in an application.
+ * A span is an individual timed event which forms a node of the trace tree.
+ * A single trace can contain spans from multiple services.
  * </pre>
  */
 @javax.annotation.Generated(
@@ -168,11 +168,11 @@ public TraceServiceFutureStub newStub(
    *
    *
    * <pre>
-   * This file describes an API for collecting and viewing traces and spans
-   * within a trace.  A Trace is a collection of spans corresponding to a single
-   * operation or set of operations for an application. A span is an individual
-   * timed event which forms a node of the trace tree. A single trace may
-   * contain span(s) from multiple services.
+   * Service for collecting and viewing traces and spans within a trace.
+   * A trace is a collection of spans corresponding to a single
+   * operation or a set of operations in an application.
+   * A span is an individual timed event which forms a node of the trace tree.
+   * A single trace can contain spans from multiple services.
    * </pre>
    */
   public abstract static class TraceServiceImplBase implements io.grpc.BindableService {
@@ -181,7 +181,7 @@ public abstract static class TraceServiceImplBase implements io.grpc.BindableSer
      *
      *
      * <pre>
-     * Sends new spans to new or existing traces. You cannot update
+     * Batch writes new spans to new or existing traces. You cannot update
      * existing spans.
      * </pre>
      */
@@ -228,11 +228,11 @@ public final io.grpc.ServerServiceDefinition bindService() {
    *
    *
    * <pre>
-   * This file describes an API for collecting and viewing traces and spans
-   * within a trace.  A Trace is a collection of spans corresponding to a single
-   * operation or set of operations for an application. A span is an individual
-   * timed event which forms a node of the trace tree. A single trace may
-   * contain span(s) from multiple services.
+   * Service for collecting and viewing traces and spans within a trace.
+   * A trace is a collection of spans corresponding to a single
+   * operation or a set of operations in an application.
+   * A span is an individual timed event which forms a node of the trace tree.
+   * A single trace can contain spans from multiple services.
    * </pre>
    */
   public static final class TraceServiceStub
@@ -250,7 +250,7 @@ protected TraceServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
      *
      *
      * <pre>
-     * Sends new spans to new or existing traces. You cannot update
+     * Batch writes new spans to new or existing traces. You cannot update
      * existing spans.
      * </pre>
      */
@@ -282,11 +282,11 @@ public void createSpan(
    *
    *
    * <pre>
-   * This file describes an API for collecting and viewing traces and spans
-   * within a trace.  A Trace is a collection of spans corresponding to a single
-   * operation or set of operations for an application. A span is an individual
-   * timed event which forms a node of the trace tree. A single trace may
-   * contain span(s) from multiple services.
+   * Service for collecting and viewing traces and spans within a trace.
+   * A trace is a collection of spans corresponding to a single
+   * operation or a set of operations in an application.
+   * A span is an individual timed event which forms a node of the trace tree.
+   * A single trace can contain spans from multiple services.
    * </pre>
    */
   public static final class TraceServiceBlockingStub
@@ -305,7 +305,7 @@ protected TraceServiceBlockingStub build(
      *
      *
      * <pre>
-     * Sends new spans to new or existing traces. You cannot update
+     * Batch writes new spans to new or existing traces. You cannot update
      * existing spans.
      * </pre>
      */
@@ -333,11 +333,11 @@ public com.google.devtools.cloudtrace.v2.Span createSpan(
    *
    *
    * <pre>
-   * This file describes an API for collecting and viewing traces and spans
-   * within a trace.  A Trace is a collection of spans corresponding to a single
-   * operation or set of operations for an application. A span is an individual
-   * timed event which forms a node of the trace tree. A single trace may
-   * contain span(s) from multiple services.
+   * Service for collecting and viewing traces and spans within a trace.
+   * A trace is a collection of spans corresponding to a single
+   * operation or a set of operations in an application.
+   * A span is an individual timed event which forms a node of the trace tree.
+   * A single trace can contain spans from multiple services.
    * </pre>
    */
   public static final class TraceServiceFutureStub
@@ -356,7 +356,7 @@ protected TraceServiceFutureStub build(
      *
      *
      * <pre>
-     * Sends new spans to new or existing traces. You cannot update
+     * Batch writes new spans to new or existing traces. You cannot update
      * existing spans.
      * </pre>
      */

diff --git a/...google-cloud-trace-v2/src/main/java/com/google/devtools/cloudtrace/v2/AttributeValue.java b/...google-cloud-trace-v2/src/main/java/com/google/devtools/cloudtrace/v2/AttributeValue.java
@@ -22,7 +22,7 @@
  *
  *
  * <pre>
- * The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
+ * The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
  * </pre>
  *
  * Protobuf type {@code google.devtools.cloudtrace.v2.AttributeValue}
@@ -444,7 +444,7 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
    *
    *
    * <pre>
-   * The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
+   * The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
    * </pre>
    *
    * Protobuf type {@code google.devtools.cloudtrace.v2.AttributeValue}