🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md
googleapis · Nov 30, 2023 · 52a9813 · 52a9813
1 parent cf5b397
commit 52a9813
Show file tree

Hide file tree

Showing 222 changed files with 32,837 additions and 43,687 deletions.
diff --git a/google-cloud-logging/src/main/java/com/google/cloud/logging/v2/ConfigClient.java b/google-cloud-logging/src/main/java/com/google/cloud/logging/v2/ConfigClient.java
diff --git a/google-cloud-logging/src/main/java/com/google/cloud/logging/v2/LoggingClient.java b/google-cloud-logging/src/main/java/com/google/cloud/logging/v2/LoggingClient.java
@@ -76,132 +76,19 @@
  * <p>Note: close() needs to be called on the LoggingClient object to clean up resources such as
  * threads. In the example above, try-with-resources is used, which automatically calls close().
  *
- * <table>
- *    <tr>
- *      <th>Method</th>
- *      <th>Description</th>
- *      <th>Method Variants</th>
- *    <tr>
- *      <td>DeleteLog</td>
- *      <td><p>Deletes all the log entries in a log for the _Default Log Bucket. The log
- *  reappears if it receives new entries. Log entries written shortly before
- *  the delete operation might not be deleted. Entries received after the
- *  delete operation with a timestamp before the operation will be deleted.</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>deleteLog(DeleteLogRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>deleteLog(LogName logName)
- *           <li>deleteLog(String logName)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>deleteLogCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>WriteLogEntries</td>
- *      <td><p>Writes log entries to Logging. This API method is the
- *  only way to send log entries to Logging. This method
- *  is used, directly or indirectly, by the Logging agent
- *  (fluentd) and all logging libraries configured to use Logging.
- *  A single request may contain log entries for a maximum of 1000
- *  different resources (projects, organizations, billing accounts or
- *  folders)</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>writeLogEntries(WriteLogEntriesRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>writeLogEntries(LogName logName, MonitoredResource resource, Map<String, String> labels, List<LogEntry> entries)
- *           <li>writeLogEntries(String logName, MonitoredResource resource, Map<String, String> labels, List<LogEntry> entries)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>writeLogEntriesCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>ListLogEntries</td>
- *      <td><p>Lists log entries.  Use this method to retrieve log entries that originated
- *  from a project/folder/organization/billing account.  For ways to export log
- *  entries, see [Exporting
- *  Logs](https://cloud.google.com/logging/docs/export).</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>listLogEntries(ListLogEntriesRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>listLogEntries(List<String> resourceNames, String filter, String orderBy)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>listLogEntriesPagedCallable()
- *           <li>listLogEntriesCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>ListMonitoredResourceDescriptors</td>
- *      <td><p>Lists the descriptors for monitored resource types used by Logging.</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>listMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>listMonitoredResourceDescriptorsPagedCallable()
- *           <li>listMonitoredResourceDescriptorsCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>ListLogs</td>
- *      <td><p>Lists the logs in projects, organizations, folders, or billing accounts.
- *  Only logs that have entries are listed.</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>listLogs(ListLogsRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>listLogs(BillingAccountName parent)
- *           <li>listLogs(FolderName parent)
- *           <li>listLogs(OrganizationName parent)
- *           <li>listLogs(ProjectName parent)
- *           <li>listLogs(String parent)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>listLogsPagedCallable()
- *           <li>listLogsCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>TailLogEntries</td>
- *      <td><p>Streaming read of log entries as they are ingested. Until the stream is
- *  terminated, it will continue reading logs.</p></td>
- *      <td>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>tailLogEntriesCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    </tr>
- *  </table>
+ * <p>The surface of this class includes several types of Java methods for each of the API's
+ * methods:
+ *
+ * <ol>
+ *   <li>A "flattened" method. With this type of method, the fields of the request type have been
+ *       converted into function parameters. It may be the case that not all fields are available as
+ *       parameters, and not every API method will have a flattened method entry point.
+ *   <li>A "request object" method. This type of method only takes one parameter, a request object,
+ *       which must be constructed before the call. Not every API method will have a request object
+ *       method.
+ *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
+ *       callable object, which can be used to initiate calls to the service.
+ * </ol>
  *
  * <p>See the individual methods for example code.
  *

diff --git a/google-cloud-logging/src/main/java/com/google/cloud/logging/v2/MetricsClient.java b/google-cloud-logging/src/main/java/com/google/cloud/logging/v2/MetricsClient.java
@@ -64,109 +64,19 @@
  * <p>Note: close() needs to be called on the MetricsClient object to clean up resources such as
  * threads. In the example above, try-with-resources is used, which automatically calls close().
  *
- * <table>
- *    <tr>
- *      <th>Method</th>
- *      <th>Description</th>
- *      <th>Method Variants</th>
- *    <tr>
- *      <td>ListLogMetrics</td>
- *      <td><p>Lists logs-based metrics.</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>listLogMetrics(ListLogMetricsRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>listLogMetrics(ProjectName parent)
- *           <li>listLogMetrics(String parent)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>listLogMetricsPagedCallable()
- *           <li>listLogMetricsCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>GetLogMetric</td>
- *      <td><p>Gets a logs-based metric.</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>getLogMetric(GetLogMetricRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>getLogMetric(LogMetricName metricName)
- *           <li>getLogMetric(String metricName)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>getLogMetricCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>CreateLogMetric</td>
- *      <td><p>Creates a logs-based metric.</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>createLogMetric(CreateLogMetricRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>createLogMetric(ProjectName parent, LogMetric metric)
- *           <li>createLogMetric(String parent, LogMetric metric)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>createLogMetricCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>UpdateLogMetric</td>
- *      <td><p>Creates or updates a logs-based metric.</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>updateLogMetric(UpdateLogMetricRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>updateLogMetric(LogMetricName metricName, LogMetric metric)
- *           <li>updateLogMetric(String metricName, LogMetric metric)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>updateLogMetricCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    <tr>
- *      <td>DeleteLogMetric</td>
- *      <td><p>Deletes a logs-based metric.</p></td>
- *      <td>
- *      <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
- *      <ul>
- *           <li>deleteLogMetric(DeleteLogMetricRequest request)
- *      </ul>
- *      <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p>
- *      <ul>
- *           <li>deleteLogMetric(LogMetricName metricName)
- *           <li>deleteLogMetric(String metricName)
- *      </ul>
- *      <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p>
- *      <ul>
- *           <li>deleteLogMetricCallable()
- *      </ul>
- *       </td>
- *    </tr>
- *    </tr>
- *  </table>
+ * <p>The surface of this class includes several types of Java methods for each of the API's
+ * methods:
+ *
+ * <ol>
+ *   <li>A "flattened" method. With this type of method, the fields of the request type have been
+ *       converted into function parameters. It may be the case that not all fields are available as
+ *       parameters, and not every API method will have a flattened method entry point.
+ *   <li>A "request object" method. This type of method only takes one parameter, a request object,
+ *       which must be constructed before the call. Not every API method will have a request object
+ *       method.
+ *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
+ *       callable object, which can be used to initiate calls to the service.
+ * </ol>
  *
  * <p>See the individual methods for example code.
  *