From c477f4dce2695bc162dc2e3a1dbb225d0723dad6 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Sat, 22 Aug 2026 17:56:29 +0000 Subject: [PATCH 1/2] feat: publish public v1 proto for DocumentChunk.relevance_score PiperOrigin-RevId: 969028335 Source-Link: https://github.com/googleapis/googleapis/commit/f8291d2b89f0017ab078a4c7378069bae5686f6f Source-Link: https://github.com/googleapis/googleapis-gen/commit/e862fcb16c2ed81e1054be0ef78e889d8336e10a Copy-Tag: eyJwIjoiZ29vZ2xlLWRldmVsb3BlcnMtZGV2ZWxvcGVyX2tub3dsZWRnZS12MS8uT3dsQm90LnlhbWwiLCJoIjoiZTg2MmZjYjE2YzJlZDgxZTEwNTRiZTBlZjc4ZTg4OWQ4MzM2ZTEwYSJ9 --- .../.gitignore | 20 + .../.repo-metadata.json | 17 + .../.rubocop.yml | 33 + .../.toys.rb | 28 + .../.yardopts | 12 + .../AUTHENTICATION.md | 122 +++ .../CHANGELOG.md | 2 + .../Gemfile | 15 + .../LICENSE.md | 201 ++++ .../README.md | 153 ++++ .../Rakefile | 169 ++++ .../gapic_metadata.json | 38 + ...-developers-developer_knowledge-v1.gemspec | 28 + ...oogle-developers-developer_knowledge-v1.rb | 21 + .../developers/developer_knowledge/v1.rb | 45 + .../v1/developer_knowledge.rb | 70 ++ .../v1/developer_knowledge/client.rb | 861 ++++++++++++++++++ .../v1/developer_knowledge/credentials.rb | 47 + .../v1/developer_knowledge/paths.rb | 47 + .../v1/developer_knowledge/rest.rb | 67 ++ .../v1/developer_knowledge/rest/client.rb | 814 +++++++++++++++++ .../developer_knowledge/rest/service_stub.rb | 320 +++++++ .../developers/developer_knowledge/v1/rest.rb | 37 + .../developer_knowledge/v1/version.rb | 28 + .../knowledge/v1/developerknowledge_pb.rb | 41 + .../v1/developerknowledge_services_pb.rb | 77 ++ .../proto_docs/README.md | 4 + .../proto_docs/google/api/client.rb | 593 ++++++++++++ .../proto_docs/google/api/field_behavior.rb | 85 ++ .../proto_docs/google/api/launch_stage.rb | 71 ++ .../proto_docs/google/api/resource.rb | 227 +++++ .../knowledge/v1/developerknowledge.rb | 393 ++++++++ .../proto_docs/google/protobuf/duration.rb | 98 ++ .../proto_docs/google/protobuf/timestamp.rb | 128 +++ .../snippets/Gemfile | 32 + .../developer_knowledge/answer_query.rb | 47 + .../batch_get_documents.rb | 47 + .../developer_knowledge/get_document.rb | 47 + .../search_document_chunks.rb | 51 ++ ...tadata_google.developers.knowledge.v1.json | 175 ++++ .../v1/developer_knowledge_paths_test.rb | 55 ++ .../v1/developer_knowledge_rest_test.rb | 320 +++++++ .../v1/developer_knowledge_test.rb | 351 +++++++ .../test/helper.rb | 35 + 44 files changed, 6072 insertions(+) create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.gitignore create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.repo-metadata.json create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.rubocop.yml create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.toys.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.yardopts create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/AUTHENTICATION.md create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/CHANGELOG.md create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/Gemfile create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/LICENSE.md create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/README.md create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/Rakefile create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/gapic_metadata.json create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/google-developers-developer_knowledge-v1.gemspec create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google-developers-developer_knowledge-v1.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/credentials.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/paths.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/rest.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/version.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/README.md create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/client.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/field_behavior.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/launch_stage.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/resource.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/duration.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/timestamp.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/Gemfile create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/answer_query.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/batch_get_documents.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/get_document.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/search_document_chunks.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/snippet_metadata_google.developers.knowledge.v1.json create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_paths_test.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_rest_test.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_test.rb create mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/test/helper.rb diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.gitignore b/owl-bot-staging/google-developers-developer_knowledge-v1/.gitignore new file mode 100644 index 000000000000..a2e97ac84259 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/.gitignore @@ -0,0 +1,20 @@ +gems.locked + +# Ignore documentation output +doc/* +.yardoc/* + +# Ignore test output +coverage/* + +# Ignore build artifacts +pkg/* + +# Ignore files commonly present in certain dev environments +.vagrant +.DS_STORE +.idea +*.iml + +# Ignore synth output +__pycache__ diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.repo-metadata.json b/owl-bot-staging/google-developers-developer_knowledge-v1/.repo-metadata.json new file mode 100644 index 000000000000..b76a2b576cdf --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/.repo-metadata.json @@ -0,0 +1,17 @@ +{ + "api_id": "developerknowledge.googleapis.com", + "api_shortname": "developerknowledge", + "client_documentation": "https://cloud.google.com/ruby/docs/reference/google-developers-developer_knowledge-v1/latest", + "distribution_name": "google-developers-developer_knowledge-v1", + "is_cloud": true, + "language": "ruby", + "name": "developerknowledge", + "name_pretty": "Developer Knowledge V1 API", + "product_documentation": "https://developers.google.com/knowledge", + "release_level": "unreleased", + "repo": "googleapis/google-cloud-ruby", + "requires_billing": true, + "ruby-cloud-description": "The Developer Knowledge API provides access to Google's developer knowledge. Note that google-developers-developer_knowledge-v1 is a version-specific client library. For most uses, we recommend installing the main client library google-developers-developer_knowledge instead. See the readme for more details.", + "ruby-cloud-product-url": "https://developers.google.com/knowledge", + "library_type": "GAPIC_AUTO" +} diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.rubocop.yml b/owl-bot-staging/google-developers-developer_knowledge-v1/.rubocop.yml new file mode 100644 index 000000000000..eca990fb3b4d --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/.rubocop.yml @@ -0,0 +1,33 @@ +inherit_gem: + google-style: google-style.yml + +AllCops: + Exclude: + - "google-developers-developer_knowledge-v1.gemspec" + - "lib/**/*_pb.rb" + - "proto_docs/**/*" + - "test/**/*" + - "acceptance/**/*" + - "samples/acceptance/**/*" + - "Rakefile" + +Layout/LineLength: + Enabled: false +Metrics/AbcSize: + Enabled: false +Metrics/ClassLength: + Enabled: false +Metrics/CyclomaticComplexity: + Enabled: false +Metrics/MethodLength: + Enabled: false +Metrics/ModuleLength: + Enabled: false +Metrics/PerceivedComplexity: + Enabled: false +Naming/AccessorMethodName: + Exclude: + - "snippets/**/*.rb" +Naming/FileName: + Exclude: + - "lib/google-developers-developer_knowledge-v1.rb" diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.toys.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/.toys.rb new file mode 100644 index 000000000000..177e22456e8a --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/.toys.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +toys_version! ">= 0.15.3" + +if ENV["RUBY_COMMON_TOOLS"] + common_tools_dir = File.expand_path ENV["RUBY_COMMON_TOOLS"] + load File.join(common_tools_dir, "toys", "gapic") +else + load_git remote: "https://github.com/googleapis/ruby-common-tools.git", + path: "toys/gapic", + update: true +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.yardopts b/owl-bot-staging/google-developers-developer_knowledge-v1/.yardopts new file mode 100644 index 000000000000..029e31f7886d --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/.yardopts @@ -0,0 +1,12 @@ +--no-private +--title="Developer Knowledge V1 API" +--exclude _pb\.rb$ +--markup markdown +--markup-provider redcarpet + +./lib/**/*.rb +./proto_docs/**/*.rb +- +README.md +LICENSE.md +AUTHENTICATION.md diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/AUTHENTICATION.md b/owl-bot-staging/google-developers-developer_knowledge-v1/AUTHENTICATION.md new file mode 100644 index 000000000000..cb46050750cd --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/AUTHENTICATION.md @@ -0,0 +1,122 @@ +# Authentication + +The recommended way to authenticate to the google-developers-developer_knowledge-v1 library is to use +[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials). +To review all of your authentication options, see [Credentials lookup](#credential-lookup). + +## Quickstart + +The following example shows how to set up authentication for a local development +environment with your user credentials. + +**NOTE:** This method is _not_ recommended for running in production. User credentials +should be used only during development. + +1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk). +2. Set up a local ADC file with your user credentials: + +```sh +gcloud auth application-default login +``` + +3. Write code as if already authenticated. + +For more information about setting up authentication for a local development environment, see +[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev). + +## Credential Lookup + +The google-developers-developer_knowledge-v1 library provides several mechanisms to configure your system. +Generally, using Application Default Credentials to facilitate automatic +credentials discovery is the easist method. But if you need to explicitly specify +credentials, there are several methods available to you. + +Credentials are accepted in the following ways, in the following order or precedence: + +1. Credentials specified in method arguments +2. Credentials specified in configuration +3. Credentials pointed to or included in environment variables +4. Credentials found in local ADC file +5. Credentials returned by the metadata server for the attached service account (GCP) + +### Configuration + +You can configure a path to a JSON credentials file, either for an individual client object or +globally, for all client objects. The JSON file can contain credentials created for +[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation), +[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a +[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key). + +Note: Service account keys are a security risk if not managed correctly. You should +[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree) +whenever possible. + +To configure a credentials file for an individual client initialization: + +```ruby +require "google/developers/developer_knowledge/v1" + +client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.credentials = "path/to/credentialfile.json" +end +``` + +To configure a credentials file globally for all clients: + +```ruby +require "google/developers/developer_knowledge/v1" + +::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.configure do |config| + config.credentials = "path/to/credentialfile.json" +end + +client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new +``` + +### Environment Variables + +You can also use an environment variable to provide a JSON credentials file. +The environment variable can contain a path to the credentials file or, for +environments such as Docker containers where writing files is not encouraged, +you can include the credentials file itself. + +The JSON file can contain credentials created for +[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation), +[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a +[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key). + +Note: Service account keys are a security risk if not managed correctly. You should +[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree) +whenever possible. + +The environment variables that google-developers-developer_knowledge-v1 +checks for credentials are: + +* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents +* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file + +```ruby +require "google/developers/developer_knowledge/v1" + +ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json" + +client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new +``` + +### Local ADC file + +You can set up a local ADC file with your user credentials for authentication during +development. If credentials are not provided in code or in environment variables, +then the local ADC credentials are discovered. + +Follow the steps in [Quickstart](#quickstart) to set up a local ADC file. + +### Google Cloud Platform environments + +When running on Google Cloud Platform (GCP), including Google Compute Engine +(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud +Functions (GCF) and Cloud Run, credentials are retrieved from the attached +service account automatically. Code should be written as if already authenticated. + +For more information, see +[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa). diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/CHANGELOG.md b/owl-bot-staging/google-developers-developer_knowledge-v1/CHANGELOG.md new file mode 100644 index 000000000000..f88957a62ba2 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/CHANGELOG.md @@ -0,0 +1,2 @@ +# Release History + diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/Gemfile b/owl-bot-staging/google-developers-developer_knowledge-v1/Gemfile new file mode 100644 index 000000000000..823c136ec3c0 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/Gemfile @@ -0,0 +1,15 @@ +source "https://rubygems.org" + +gemspec + +gem "google-style", "~> 1.32.0" +gem "irb", "~> 1.17" +gem "minitest", "~> 6.0.2" +gem "minitest-focus", "~> 1.4" +gem "minitest-mock", "~> 5.27" +gem "minitest-reporters", "~> 1.8.0", require: false +gem "minitest-rg", "~> 5.3" +gem "ostruct", "~> 0.5.5" +gem "rake", ">= 13.0" +gem "redcarpet", "~> 3.6" +gem "yard", "~> 0.9" diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/LICENSE.md b/owl-bot-staging/google-developers-developer_knowledge-v1/LICENSE.md new file mode 100644 index 000000000000..c261857ba6ad --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/LICENSE.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/README.md b/owl-bot-staging/google-developers-developer_knowledge-v1/README.md new file mode 100644 index 000000000000..b4b5340b19fc --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/README.md @@ -0,0 +1,153 @@ +# Ruby Client for the Developer Knowledge V1 API + +The Developer Knowledge API provides access to Google's developer knowledge. + + +https://github.com/googleapis/google-cloud-ruby + +This gem is a _versioned_ client. It provides basic client classes for a +specific version of the Developer Knowledge V1 API. Most users should consider using +the main client gem, +[google-developers-developer_knowledge](https://rubygems.org/gems/google-developers-developer_knowledge). +See the section below titled *Which client should I use?* for more information. + +## Installation + +``` +$ gem install google-developers-developer_knowledge-v1 +``` + +## Before You Begin + +In order to use this library, you first need to go through the following steps: + +1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project) +1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project) +1. [Enable the API.](https://console.cloud.google.com/apis/library/developerknowledge.googleapis.com) +1. [Set up authentication.](AUTHENTICATION.md) + +## Quick Start + +```ruby +require "google/developers/developer_knowledge/v1" + +client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new +request = ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new # (request fields as keyword arguments...) +response = client.search_document_chunks request +``` + +View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-developers-developer_knowledge-v1/latest) +for class and method documentation. + +See also the [Product Documentation](https://developers.google.com/knowledge) +for general usage information. + +## Debug Logging + +This library comes with opt-in Debug Logging that can help you troubleshoot +your application's integration with the API. When logging is activated, key +events such as requests and responses, along with data payloads and metadata +such as headers and client configuration, are logged to the standard error +stream. + +**WARNING:** Client Library Debug Logging includes your data payloads in +plaintext, which could include sensitive data such as PII for yourself or your +customers, private keys, or other security data that could be compromising if +leaked. Always practice good data hygiene with your application logs, and follow +the principle of least access. Google also recommends that Client Library Debug +Logging be enabled only temporarily during active debugging, and not used +permanently in production. + +To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS` +to the value `all`. Alternatively, you can set the value to a comma-delimited +list of client library gem names. This will select the default logging behavior, +which writes logs to the standard error stream. On a local workstation, this may +result in logs appearing on the console. When running on a Google Cloud hosting +service such as [Google Cloud Run](https://cloud.google.com/run), this generally +results in logs appearing alongside your application logs in the +[Google Cloud Logging](https://cloud.google.com/logging/) service. + +You can customize logging by modifying the `logger` configuration when +constructing a client object. For example: + +```ruby +require "google/developers/developer_knowledge/v1" +require "logger" + +client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.logger = Logger.new "my-app.log" +end +``` + +## Google Cloud Samples + +To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples). + +## Supported Ruby Versions + +This library is supported on Ruby 3.2+. + +Google provides official support for Ruby versions that are actively supported +by Ruby Core—that is, Ruby versions that are either in normal maintenance or +in security maintenance, and not end of life. Older versions of Ruby _may_ +still work, but are unsupported and not recommended. See +https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby +support schedule. + +## Which client should I use? + +Most modern Ruby client libraries for Google APIs come in two flavors: the main +client library with a name such as `google-developers-developer_knowledge`, +and lower-level _versioned_ client libraries with names such as +`google-developers-developer_knowledge-v1`. +_In most cases, you should install the main client._ + +### What's the difference between the main client and a versioned client? + +A _versioned client_ provides a basic set of data types and client classes for +a _single version_ of a specific service. (That is, for a service with multiple +versions, there might be a separate versioned client for each service version.) +Most versioned clients are written and maintained by a code generator. + +The _main client_ is designed to provide you with the _recommended_ client +interfaces for the service. There will be only one main client for any given +service, even a service with multiple versions. The main client includes +factory methods for constructing the client objects we recommend for most +users. In some cases, those will be classes provided by an underlying versioned +client; in other cases, they will be handwritten higher-level client objects +with additional capabilities, convenience methods, or best practices built in. +Generally, the main client will default to a recommended service version, +although in some cases you can override this if you need to talk to a specific +service version. + +### Why would I want to use the main client? + +We recommend that most users install the main client gem for a service. You can +identify this gem as the one _without_ a version in its name, e.g. +`google-developers-developer_knowledge`. +The main client is recommended because it will embody the best practices for +accessing the service, and may also provide more convenient interfaces or +tighter integration into frameworks and third-party libraries. In addition, the +documentation and samples published by Google will generally demonstrate use of +the main client. + +### Why would I want to use a versioned client? + +You can use a versioned client if you are content with a possibly lower-level +class interface, you explicitly want to avoid features provided by the main +client, or you want to access a specific service version not be covered by the +main client. You can identify versioned client gems because the service version +is part of the name, e.g. `google-developers-developer_knowledge-v1`. + +### What about the google-apis- clients? + +Client library gems with names that begin with `google-apis-` are based on an +older code generation technology. They talk to a REST/JSON backend (whereas +most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may +not offer the same performance, features, and ease of use provided by more +modern clients. + +The `google-apis-` clients have wide coverage across Google services, so you +might need to use one if there is no modern client available for the service. +However, if a modern client is available, we generally recommend it over the +older `google-apis-` clients. diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/Rakefile b/owl-bot-staging/google-developers-developer_knowledge-v1/Rakefile new file mode 100644 index 000000000000..ca756f3b2f8a --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/Rakefile @@ -0,0 +1,169 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "bundler/setup" +require "bundler/gem_tasks" + +require "rubocop/rake_task" +RuboCop::RakeTask.new + +require "rake/testtask" +desc "Run tests." +Rake::TestTask.new do |t| + t.libs << "test" + t.test_files = FileList["test/**/*_test.rb"] + t.warning = false +end + +desc "Runs the smoke tests." +Rake::TestTask.new :smoke_test do |t| + t.test_files = FileList["acceptance/**/*smoke_test.rb"] + t.warning = false +end + +# Acceptance tests +desc "Run the google-developers-developer_knowledge-v1 acceptance tests." +task :acceptance, :project, :keyfile do |t, args| + project = args[:project] + project ||= + ENV["GOOGLE_CLOUD_TEST_PROJECT"] || + ENV["GCLOUD_TEST_PROJECT"] + keyfile = args[:keyfile] + keyfile ||= + ENV["GOOGLE_CLOUD_TEST_KEYFILE"] || + ENV["GCLOUD_TEST_KEYFILE"] + if keyfile + keyfile = File.read keyfile + else + keyfile ||= + ENV["GOOGLE_CLOUD_TEST_KEYFILE_JSON"] || + ENV["GCLOUD_TEST_KEYFILE_JSON"] + end + if project.nil? || keyfile.nil? + fail "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or GOOGLE_CLOUD_TEST_PROJECT=test123 GOOGLE_CLOUD_TEST_KEYFILE=/path/to/keyfile.json rake acceptance" + end + require "google/developers/developer_knowledge/v1/developer_knowledge/credentials" + ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Credentials.env_vars.each do |path| + ENV[path] = nil + end + ENV["GOOGLE_CLOUD_PROJECT"] = project + ENV["GOOGLE_CLOUD_TEST_PROJECT"] = project + ENV["GOOGLE_CLOUD_KEYFILE_JSON"] = keyfile + + Rake::Task["acceptance:run"].invoke +end + +namespace :acceptance do + task :run do + if File.directory? "acceptance" + Rake::Task[:smoke_test].invoke + else + puts "The google-developers-developer_knowledge-v1 gem has no acceptance tests." + end + end + + desc "Run acceptance cleanup." + task :cleanup do + end +end + +task :samples do + Rake::Task["samples:latest"].invoke +end + +namespace :samples do + task :latest do + if File.directory? "samples" + Dir.chdir "samples" do + Bundler.with_clean_env do + ENV["GOOGLE_CLOUD_SAMPLES_TEST"] = "not_master" + sh "bundle update" + sh "bundle exec rake test" + end + end + else + puts "The google-developers-developer_knowledge-v1 gem has no samples to test." + end + end + + task :master do + if File.directory? "samples" + Dir.chdir "samples" do + Bundler.with_clean_env do + ENV["GOOGLE_CLOUD_SAMPLES_TEST"] = "master" + sh "bundle update" + sh "bundle exec rake test" + end + end + else + puts "The google-developers-developer_knowledge-v1 gem has no samples to test." + end + end +end + +require "yard" +require "yard/rake/yardoc_task" +YARD::Rake::YardocTask.new do |y| + y.options << "--fail-on-warning" +end + +desc "Run yard-doctest example tests." +task :doctest do + puts "The google-developers-developer_knowledge-v1 gem does not have doctest tests." +end + +desc "Run the CI build" +task :ci do + header "BUILDING google-developers-developer_knowledge-v1" + header "google-developers-developer_knowledge-v1 rubocop", "*" + Rake::Task[:rubocop].invoke + header "google-developers-developer_knowledge-v1 yard", "*" + Rake::Task[:yard].invoke + header "google-developers-developer_knowledge-v1 test", "*" + Rake::Task[:test].invoke +end + +namespace :ci do + desc "Run the CI build, with smoke tests." + task :smoke_test do + Rake::Task[:ci].invoke + header "google-developers-developer_knowledge-v1 smoke_test", "*" + Rake::Task[:smoke_test].invoke + end + desc "Run the CI build, with acceptance tests." + task :acceptance do + Rake::Task[:ci].invoke + header "google-developers-developer_knowledge-v1 acceptance", "*" + Rake::Task[:acceptance].invoke + end + task :a do + # This is a handy shortcut to save typing + Rake::Task["ci:acceptance"].invoke + end +end + +task default: :test + +def header str, token = "#" + line_length = str.length + 8 + puts "" + puts token * line_length + puts "#{token * 3} #{str} #{token * 3}" + puts token * line_length + puts "" +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/gapic_metadata.json b/owl-bot-staging/google-developers-developer_knowledge-v1/gapic_metadata.json new file mode 100644 index 000000000000..37fb4a1b5f6d --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/gapic_metadata.json @@ -0,0 +1,38 @@ +{ + "schema": "1.0", + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "ruby", + "protoPackage": "google.developers.knowledge.v1", + "libraryPackage": "::Google::Developers::DeveloperKnowledge::V1", + "services": { + "DeveloperKnowledge": { + "clients": { + "grpc": { + "libraryClient": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client", + "rpcs": { + "SearchDocumentChunks": { + "methods": [ + "search_document_chunks" + ] + }, + "GetDocument": { + "methods": [ + "get_document" + ] + }, + "BatchGetDocuments": { + "methods": [ + "batch_get_documents" + ] + }, + "AnswerQuery": { + "methods": [ + "answer_query" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/google-developers-developer_knowledge-v1.gemspec b/owl-bot-staging/google-developers-developer_knowledge-v1/google-developers-developer_knowledge-v1.gemspec new file mode 100644 index 000000000000..ff236befee57 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/google-developers-developer_knowledge-v1.gemspec @@ -0,0 +1,28 @@ +# -*- ruby -*- +# encoding: utf-8 + +require File.expand_path("lib/google/developers/developer_knowledge/v1/version", __dir__) + +Gem::Specification.new do |gem| + gem.name = "google-developers-developer_knowledge-v1" + gem.version = Google::Developers::DeveloperKnowledge::V1::VERSION + + gem.authors = ["Google LLC"] + gem.email = "googleapis-packages@google.com" + gem.description = "The Developer Knowledge API provides access to Google's developer knowledge. Note that google-developers-developer_knowledge-v1 is a version-specific client library. For most uses, we recommend installing the main client library google-developers-developer_knowledge instead. See the readme for more details." + gem.summary = "The Developer Knowledge API provides access to Google's developer knowledge." + gem.homepage = "https://github.com/googleapis/google-cloud-ruby" + gem.license = "Apache-2.0" + + gem.platform = Gem::Platform::RUBY + + gem.files = `git ls-files -- lib/*`.split("\n") + + `git ls-files -- proto_docs/*`.split("\n") + + ["README.md", "LICENSE.md", "AUTHENTICATION.md", ".yardopts"] + gem.require_paths = ["lib"] + + gem.required_ruby_version = ">= 3.2" + + gem.add_dependency "gapic-common", "~> 1.3" + gem.add_dependency "google-cloud-errors", "~> 1.0" +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google-developers-developer_knowledge-v1.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google-developers-developer_knowledge-v1.rb new file mode 100644 index 000000000000..b1e644ed99d8 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google-developers-developer_knowledge-v1.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +# This gem does not autoload during Bundler.require. To load this gem, +# issue explicit require statements for the packages desired, e.g.: +# require "google/developers/developer_knowledge/v1" diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1.rb new file mode 100644 index 000000000000..d9cee294ec23 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1.rb @@ -0,0 +1,45 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "google/developers/developer_knowledge/v1/developer_knowledge" +require "google/developers/developer_knowledge/v1/version" + +module Google + module Developers + module DeveloperKnowledge + ## + # API client module. + # + # @example Load this package, including all its services, and instantiate a gRPC client + # + # require "google/developers/developer_knowledge/v1" + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + # + # @example Load this package, including all its services, and instantiate a REST client + # + # require "google/developers/developer_knowledge/v1" + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + module V1 + end + end + end +end + +helper_path = ::File.join __dir__, "v1", "_helpers.rb" +require "google/developers/developer_knowledge/v1/_helpers" if ::File.file? helper_path diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge.rb new file mode 100644 index 000000000000..e18de241d98e --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge.rb @@ -0,0 +1,70 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "gapic/common" +require "gapic/config" +require "gapic/config/method" + +require "google/developers/developer_knowledge/v1/version" + +require "google/developers/developer_knowledge/v1/developer_knowledge/credentials" +require "google/developers/developer_knowledge/v1/developer_knowledge/paths" +require "google/developers/developer_knowledge/v1/developer_knowledge/client" +require "google/developers/developer_knowledge/v1/developer_knowledge/rest" + +module Google + module Developers + module DeveloperKnowledge + module V1 + ## + # The Developer Knowledge API provides programmatic access to Google's public + # developer documentation, enabling you to integrate this knowledge base into + # your own applications and workflows. + # + # The API is designed to be the canonical source for machine-readable access to + # Google's developer documentation. + # + # A typical use case is to first use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks} + # to find relevant page URIs based on a query, and then use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # to fetch the full content of the top results. + # + # All document content is provided in Markdown format. + # + # @example Load this service and instantiate a gRPC client + # + # require "google/developers/developer_knowledge/v1/developer_knowledge" + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + # + # @example Load this service and instantiate a REST client + # + # require "google/developers/developer_knowledge/v1/developer_knowledge/rest" + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + module DeveloperKnowledge + end + end + end + end +end + +helper_path = ::File.join __dir__, "developer_knowledge", "helpers.rb" +require "google/developers/developer_knowledge/v1/developer_knowledge/helpers" if ::File.file? helper_path diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb new file mode 100644 index 000000000000..14fbd2c1ffca --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb @@ -0,0 +1,861 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "google/cloud/errors" +require "google/developers/knowledge/v1/developerknowledge_pb" + +module Google + module Developers + module DeveloperKnowledge + module V1 + module DeveloperKnowledge + ## + # Client for the DeveloperKnowledge service. + # + # The Developer Knowledge API provides programmatic access to Google's public + # developer documentation, enabling you to integrate this knowledge base into + # your own applications and workflows. + # + # The API is designed to be the canonical source for machine-readable access to + # Google's developer documentation. + # + # A typical use case is to first use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks} + # to find relevant page URIs based on a query, and then use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # to fetch the full content of the top results. + # + # All document content is provided in Markdown format. + # + class Client + # @private + API_VERSION = "" + + # @private + DEFAULT_ENDPOINT_TEMPLATE = "developerknowledge.$UNIVERSE_DOMAIN$" + + include Paths + + # @private + attr_reader :developer_knowledge_stub + + ## + # Configure the DeveloperKnowledge Client class. + # + # See {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client::Configuration} + # for a description of the configuration fields. + # + # @example + # + # # Modify the configuration for all DeveloperKnowledge clients + # ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.configure do |config| + # config.timeout = 10.0 + # end + # + # @yield [config] Configure the Client client. + # @yieldparam config [Client::Configuration] + # + # @return [Client::Configuration] + # + def self.configure + @configure ||= begin + namespace = ["Google", "Developers", "DeveloperKnowledge", "V1"] + parent_config = while namespace.any? + parent_name = namespace.join "::" + parent_const = const_get parent_name + break parent_const.configure if parent_const.respond_to? :configure + namespace.pop + end + default_config = Client::Configuration.new parent_config + + default_config.rpcs.get_document.timeout = 60.0 + default_config.rpcs.get_document.retry_policy = { + initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] + } + + default_config.rpcs.batch_get_documents.timeout = 60.0 + default_config.rpcs.batch_get_documents.retry_policy = { + initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] + } + + default_config + end + yield @configure if block_given? + @configure + end + + ## + # Configure the DeveloperKnowledge Client instance. + # + # The configuration is set to the derived mode, meaning that values can be changed, + # but structural changes (adding new fields, etc.) are not allowed. Structural changes + # should be made on {Client.configure}. + # + # See {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client::Configuration} + # for a description of the configuration fields. + # + # @yield [config] Configure the Client client. + # @yieldparam config [Client::Configuration] + # + # @return [Client::Configuration] + # + def configure + yield @config if block_given? + @config + end + + ## + # The effective universe domain + # + # @return [String] + # + def universe_domain + @developer_knowledge_stub.universe_domain + end + + ## + # Create a new DeveloperKnowledge client object. + # + # @example + # + # # Create a client using the default configuration + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + # + # # Create a client using a custom configuration + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + # config.timeout = 10.0 + # end + # + # @yield [config] Configure the DeveloperKnowledge client. + # @yieldparam config [Client::Configuration] + # + def initialize + # These require statements are intentionally placed here to initialize + # the gRPC module only when it's required. + # See https://github.com/googleapis/toolkit/issues/446 + require "gapic/grpc" + require "google/developers/knowledge/v1/developerknowledge_services_pb" + + # Create the configuration object + @config = Configuration.new Client.configure + + # Yield the configuration if needed + yield @config if block_given? + + # Create credentials + credentials = @config.credentials + # Use self-signed JWT if the endpoint is unchanged from default, + # but only if the default endpoint does not have a region prefix. + enable_self_signed_jwt = @config.endpoint.nil? || + (@config.endpoint == Configuration::DEFAULT_ENDPOINT && + !@config.endpoint.split(".").first.include?("-")) + credentials ||= Credentials.default scope: @config.scope, + enable_self_signed_jwt: enable_self_signed_jwt + if credentials.is_a?(::String) || credentials.is_a?(::Hash) + credentials = Credentials.new credentials, scope: @config.scope + end + @quota_project_id = @config.quota_project + @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id + + @developer_knowledge_stub = ::Gapic::ServiceStub.new( + ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Stub, + credentials: credentials, + endpoint: @config.endpoint, + endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, + universe_domain: @config.universe_domain, + channel_args: @config.channel_args, + interceptors: @config.interceptors, + channel_pool_config: @config.channel_pool, + logger: @config.logger + ) + + @developer_knowledge_stub.stub_logger&.info do |entry| + entry.set_system_name + entry.set_service + entry.message = "Created client for #{entry.service}" + entry.set_credentials_fields credentials + entry.set "customEndpoint", @config.endpoint if @config.endpoint + entry.set "defaultTimeout", @config.timeout if @config.timeout + entry.set "quotaProject", @quota_project_id if @quota_project_id + end + end + + ## + # The logger used for request/response debug logging. + # + # @return [Logger] + # + def logger + @developer_knowledge_stub.logger + end + + # Service calls + + ## + # Searches for developer knowledge across Google's developer documentation. + # Returns {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s + # based on the user's query. There may be many chunks from the same + # {::Google::Developers::DeveloperKnowledge::V1::Document Document}. To retrieve full + # documents, use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # with the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk#parent DocumentChunk.parent} + # returned in the + # {::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse#results SearchDocumentChunksResponse.results}. + # + # @overload search_document_chunks(request, options = nil) + # Pass arguments to `search_document_chunks` via a request object, either of type + # {::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest} or an equivalent Hash. + # + # @param request [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest, ::Hash] + # A request object representing the call parameters. Required. To specify no + # parameters, or to keep all the default parameter values, pass an empty Hash. + # @param options [::Gapic::CallOptions, ::Hash] + # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. + # + # @overload search_document_chunks(query: nil, page_size: nil, page_token: nil, filter: nil) + # Pass arguments to `search_document_chunks` via keyword arguments. Note that at + # least one keyword argument is required. To specify no parameters, or to keep all + # the default parameter values, pass an empty Hash as a request object (see above). + # + # @param query [::String] + # Required. Provides the raw query string provided by the user, such as "How + # to create a Cloud Storage bucket?". The query must not exceed 500 + # characters; values longer than 500 characters will result in an + # `INVALID_ARGUMENT` error. + # @param page_size [::Integer] + # Optional. Specifies the maximum number of results to return. The service + # may return fewer than this value. + # + # If unspecified, at most 5 results will be returned. + # + # The maximum value is 100; values above 100 will be coerced to 100. + # @param page_token [::String] + # Optional. Contains a page token, received from a previous + # `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. + # @param filter [::String] + # Optional. Applies a strict filter to the search results. The expression + # supports a subset of the syntax described at https://google.aip.dev/160. + # + # While `SearchDocumentChunks` returns + # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s, the filter + # is applied to `DocumentChunk.document` fields. + # + # Supported fields for filtering: + # + # * `content_length_bytes` (INTEGER): The length of the `Document.content` + # field in bytes. + # * `data_source` (STRING): The source of the document, e.g. + # `docs.cloud.google.com`. See + # https://developers.google.com/knowledge/reference/corpus-reference for + # the complete list of data sources in the corpus. + # * `update_time` (TIMESTAMP): The timestamp of when the document was last + # meaningfully updated. A meaningful update is one that changes document's + # markdown content or metadata. + # * `uri` (STRING): The document URI, e.g. + # `https://docs.cloud.google.com/bigquery/docs/tables`. + # + # INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. + # + # STRING fields support `=` (equals) and `!=` (not equals) operators for + # **exact match** on the whole string. Partial match, prefix match, and + # regexp match are not supported. + # + # TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. + # Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. + # + # Note: Field names must be in `snake_case` (e.g., `data_source`). Values on + # the right-hand side of filtering expressions must be string literals + # enclosed in double quotes (e.g., `"docs.cloud.google.com"`). + # + # You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical + # operators. `OR` has higher precedence than `AND`. Use parentheses for + # explicit precedence grouping. + # + # Examples: + # + # * Filter by `Document.content_length_bytes`: + # `content_length_bytes < 50000` + # * `data_source = "docs.cloud.google.com" OR data_source = + # "firebase.google.com"` + # * `data_source != "firebase.google.com"` + # * `update_time < "2024-01-01T00:00:00Z"` + # * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = + # "developer.chrome.com" OR data_source = "web.dev")` + # * `uri = "https://docs.cloud.google.com/release-notes"` + # + # The `filter` string must not exceed 500 characters; values longer than 500 + # characters will result in an `INVALID_ARGUMENT` error. + # + # @yield [response, operation] Access the result along with the RPC operation + # @yieldparam response [::Gapic::PagedEnumerable<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] + # @yieldparam operation [::GRPC::ActiveCall::Operation] + # + # @return [::Gapic::PagedEnumerable<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] + # + # @raise [::Google::Cloud::Error] if the RPC is aborted. + # + # @example Basic example + # require "google/developers/developer_knowledge/v1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new + # + # # Call the search_document_chunks method. + # result = client.search_document_chunks request + # + # # The returned object is of type Gapic::PagedEnumerable. You can iterate + # # over elements, and API calls will be issued to fetch pages as needed. + # result.each do |item| + # # Each element is of type ::Google::Developers::DeveloperKnowledge::V1::DocumentChunk. + # p item + # end + # + def search_document_chunks request, options = nil + raise ::ArgumentError, "request must be provided" if request.nil? + + request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest + + # Converts hash and nil to an options object + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + + # Customize the options with defaults + metadata = @config.rpcs.search_document_chunks.metadata.to_h + + # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers + metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ + lib_name: @config.lib_name, lib_version: @config.lib_version, + gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION + metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? + metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + + options.apply_defaults timeout: @config.rpcs.search_document_chunks.timeout, + metadata: metadata, + retry_policy: @config.rpcs.search_document_chunks.retry_policy + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, + retry_policy: @config.retry_policy + + @developer_knowledge_stub.call_rpc :search_document_chunks, request, options: options do |response, operation| + response = ::Gapic::PagedEnumerable.new @developer_knowledge_stub, :search_document_chunks, request, response, operation, options + yield response, operation if block_given? + throw :response, response + end + rescue ::GRPC::BadStatus => e + raise ::Google::Cloud::Error.from_error(e) + end + + ## + # Retrieves a single document with its full Markdown content. + # + # @overload get_document(request, options = nil) + # Pass arguments to `get_document` via a request object, either of type + # {::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest} or an equivalent Hash. + # + # @param request [::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, ::Hash] + # A request object representing the call parameters. Required. To specify no + # parameters, or to keep all the default parameter values, pass an empty Hash. + # @param options [::Gapic::CallOptions, ::Hash] + # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. + # + # @overload get_document(name: nil, view: nil) + # Pass arguments to `get_document` via keyword arguments. Note that at + # least one keyword argument is required. To specify no parameters, or to keep all + # the default parameter values, pass an empty Hash as a request object (see above). + # + # @param name [::String] + # Required. Specifies the name of the document to retrieve. + # Format: `documents/{uri_without_scheme}` + # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + # + # The name must not exceed 500 characters; values longer than 500 characters + # will result in an `INVALID_ARGUMENT` error. + # @param view [::Google::Developers::DeveloperKnowledge::V1::DocumentView] + # Optional. Specifies the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the + # document. If unspecified, + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # defaults to `DOCUMENT_VIEW_CONTENT`. + # + # @yield [response, operation] Access the result along with the RPC operation + # @yieldparam response [::Google::Developers::DeveloperKnowledge::V1::Document] + # @yieldparam operation [::GRPC::ActiveCall::Operation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::Document] + # + # @raise [::Google::Cloud::Error] if the RPC is aborted. + # + # @example Basic example + # require "google/developers/developer_knowledge/v1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new + # + # # Call the get_document method. + # result = client.get_document request + # + # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::Document. + # p result + # + def get_document request, options = nil + raise ::ArgumentError, "request must be provided" if request.nil? + + request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest + + # Converts hash and nil to an options object + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + + # Customize the options with defaults + metadata = @config.rpcs.get_document.metadata.to_h + + # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers + metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ + lib_name: @config.lib_name, lib_version: @config.lib_version, + gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION + metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? + metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + + header_params = {} + if request.name + header_params["name"] = request.name + end + + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") + metadata[:"x-goog-request-params"] ||= request_params_header + + options.apply_defaults timeout: @config.rpcs.get_document.timeout, + metadata: metadata, + retry_policy: @config.rpcs.get_document.retry_policy + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, + retry_policy: @config.retry_policy + + @developer_knowledge_stub.call_rpc :get_document, request, options: options do |response, operation| + yield response, operation if block_given? + end + rescue ::GRPC::BadStatus => e + raise ::Google::Cloud::Error.from_error(e) + end + + ## + # Retrieves multiple documents, each with its full Markdown content. + # + # @overload batch_get_documents(request, options = nil) + # Pass arguments to `batch_get_documents` via a request object, either of type + # {::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest} or an equivalent Hash. + # + # @param request [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, ::Hash] + # A request object representing the call parameters. Required. To specify no + # parameters, or to keep all the default parameter values, pass an empty Hash. + # @param options [::Gapic::CallOptions, ::Hash] + # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. + # + # @overload batch_get_documents(names: nil, view: nil) + # Pass arguments to `batch_get_documents` via keyword arguments. Note that at + # least one keyword argument is required. To specify no parameters, or to keep all + # the default parameter values, pass an empty Hash as a request object (see above). + # + # @param names [::Array<::String>] + # Required. Specifies the names of the documents to retrieve. A maximum of 20 + # documents can be retrieved in a batch. The documents are returned in the + # same order as the `names` in the request. + # + # Format: `documents/{uri_without_scheme}` + # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + # + # Each name must not exceed 500 characters; values longer than 500 characters + # will result in an `INVALID_ARGUMENT` error. + # @param view [::Google::Developers::DeveloperKnowledge::V1::DocumentView] + # Optional. Specifies the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the + # document. If unspecified, + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # defaults to `DOCUMENT_VIEW_CONTENT`. + # + # @yield [response, operation] Access the result along with the RPC operation + # @yieldparam response [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] + # @yieldparam operation [::GRPC::ActiveCall::Operation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] + # + # @raise [::Google::Cloud::Error] if the RPC is aborted. + # + # @example Basic example + # require "google/developers/developer_knowledge/v1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new + # + # # Call the batch_get_documents method. + # result = client.batch_get_documents request + # + # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse. + # p result + # + def batch_get_documents request, options = nil + raise ::ArgumentError, "request must be provided" if request.nil? + + request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest + + # Converts hash and nil to an options object + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + + # Customize the options with defaults + metadata = @config.rpcs.batch_get_documents.metadata.to_h + + # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers + metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ + lib_name: @config.lib_name, lib_version: @config.lib_version, + gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION + metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? + metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + + options.apply_defaults timeout: @config.rpcs.batch_get_documents.timeout, + metadata: metadata, + retry_policy: @config.rpcs.batch_get_documents.retry_policy + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, + retry_policy: @config.retry_policy + + @developer_knowledge_stub.call_rpc :batch_get_documents, request, options: options do |response, operation| + yield response, operation if block_given? + end + rescue ::GRPC::BadStatus => e + raise ::Google::Cloud::Error.from_error(e) + end + + ## + # Answers a query using grounded generation. + # + # @overload answer_query(request, options = nil) + # Pass arguments to `answer_query` via a request object, either of type + # {::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest} or an equivalent Hash. + # + # @param request [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Hash] + # A request object representing the call parameters. Required. To specify no + # parameters, or to keep all the default parameter values, pass an empty Hash. + # @param options [::Gapic::CallOptions, ::Hash] + # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. + # + # @overload answer_query(query: nil) + # Pass arguments to `answer_query` via keyword arguments. Note that at + # least one keyword argument is required. To specify no parameters, or to keep all + # the default parameter values, pass an empty Hash as a request object (see above). + # + # @param query [::String] + # Required. The query to answer. + # + # @yield [response, operation] Access the result along with the RPC operation + # @yieldparam response [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] + # @yieldparam operation [::GRPC::ActiveCall::Operation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] + # + # @raise [::Google::Cloud::Error] if the RPC is aborted. + # + # @example Basic example + # require "google/developers/developer_knowledge/v1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new + # + # # Call the answer_query method. + # result = client.answer_query request + # + # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse. + # p result + # + def answer_query request, options = nil + raise ::ArgumentError, "request must be provided" if request.nil? + + request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest + + # Converts hash and nil to an options object + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + + # Customize the options with defaults + metadata = @config.rpcs.answer_query.metadata.to_h + + # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers + metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ + lib_name: @config.lib_name, lib_version: @config.lib_version, + gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION + metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? + metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + + options.apply_defaults timeout: @config.rpcs.answer_query.timeout, + metadata: metadata, + retry_policy: @config.rpcs.answer_query.retry_policy + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, + retry_policy: @config.retry_policy + + @developer_knowledge_stub.call_rpc :answer_query, request, options: options do |response, operation| + yield response, operation if block_given? + end + rescue ::GRPC::BadStatus => e + raise ::Google::Cloud::Error.from_error(e) + end + + ## + # Configuration class for the DeveloperKnowledge API. + # + # This class represents the configuration for DeveloperKnowledge, + # providing control over timeouts, retry behavior, logging, transport + # parameters, and other low-level controls. Certain parameters can also be + # applied individually to specific RPCs. See + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client::Configuration::Rpcs} + # for a list of RPCs that can be configured independently. + # + # Configuration can be applied globally to all clients, or to a single client + # on construction. + # + # @example + # + # # Modify the global config, setting the timeout for + # # search_document_chunks to 20 seconds, + # # and all remaining timeouts to 10 seconds. + # ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.configure do |config| + # config.timeout = 10.0 + # config.rpcs.search_document_chunks.timeout = 20.0 + # end + # + # # Apply the above configuration only to a new client. + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + # config.timeout = 10.0 + # config.rpcs.search_document_chunks.timeout = 20.0 + # end + # + # @!attribute [rw] endpoint + # A custom service endpoint, as a hostname or hostname:port. The default is + # nil, indicating to use the default endpoint in the current universe domain. + # @return [::String,nil] + # @!attribute [rw] credentials + # Credentials to send with calls. You may provide any of the following types: + # * (`Google::Auth::Credentials`) A googleauth credentials object + # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) + # * (`Signet::OAuth2::Client`) A signet oauth2 client object + # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) + # * (`GRPC::Core::Channel`) a gRPC channel with included credentials + # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object + # * (`nil`) indicating no credentials + # + # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials + # is deprecated. Providing an unvalidated credential configuration to + # Google APIs can compromise the security of your systems and data. + # + # @example + # + # # The recommended way to provide credentials is to use the `make_creds` method + # # on the appropriate credentials class for your environment. + # + # require "googleauth" + # + # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds( + # json_key_io: ::File.open("/path/to/keyfile.json") + # ) + # + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + # config.credentials = credentials + # end + # + # @note Warning: If you accept a credential configuration (JSON file or Hash) from an + # external source for authentication to Google Cloud, you must validate it before + # providing it to a Google API client library. Providing an unvalidated credential + # configuration to Google APIs can compromise the security of your systems and data. + # For more information, refer to [Validate credential configurations from external + # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials). + # @return [::Object] + # @!attribute [rw] scope + # The OAuth scopes + # @return [::Array<::String>] + # @!attribute [rw] lib_name + # The library name as recorded in instrumentation and logging + # @return [::String] + # @!attribute [rw] lib_version + # The library version as recorded in instrumentation and logging + # @return [::String] + # @!attribute [rw] channel_args + # Extra parameters passed to the gRPC channel. Note: this is ignored if a + # `GRPC::Core::Channel` object is provided as the credential. + # @return [::Hash] + # @!attribute [rw] interceptors + # An array of interceptors that are run before calls are executed. + # @return [::Array<::GRPC::ClientInterceptor>] + # @!attribute [rw] timeout + # The call timeout in seconds. + # @return [::Numeric] + # @!attribute [rw] metadata + # Additional gRPC headers to be sent with the call. + # @return [::Hash{::Symbol=>::String}] + # @!attribute [rw] retry_policy + # The retry policy. The value is a hash with the following keys: + # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. + # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. + # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. + # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0. + # * `:retry_codes` (*type:* `Array`) - The error codes that should + # trigger a retry. + # @return [::Hash] + # @!attribute [rw] quota_project + # A separate project against which to charge quota. + # @return [::String] + # @!attribute [rw] universe_domain + # The universe domain within which to make requests. This determines the + # default endpoint URL. The default value of nil uses the environment + # universe (usually the default "googleapis.com" universe). + # @return [::String,nil] + # @!attribute [rw] logger + # A custom logger to use for request/response debug logging, or the value + # `:default` (the default) to construct a default logger, or `nil` to + # explicitly disable logging. + # @return [::Logger,:default,nil] + # + class Configuration + extend ::Gapic::Config + + # @private + # The endpoint specific to the default "googleapis.com" universe. Deprecated. + DEFAULT_ENDPOINT = "developerknowledge.googleapis.com" + + config_attr :endpoint, nil, ::String, nil + config_attr :credentials, nil do |value| + allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil] + allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel + allowed.any? { |klass| klass === value } + end + config_attr :scope, nil, ::String, ::Array, nil + config_attr :lib_name, nil, ::String, nil + config_attr :lib_version, nil, ::String, nil + config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) + config_attr :interceptors, nil, ::Array, nil + config_attr :timeout, nil, ::Numeric, nil + config_attr :metadata, nil, ::Hash, nil + config_attr :retry_policy, nil, ::Hash, ::Proc, nil + config_attr :quota_project, nil, ::String, nil + config_attr :universe_domain, nil, ::String, nil + config_attr :logger, :default, ::Logger, nil, :default + + # @private + def initialize parent_config = nil + @parent_config = parent_config unless parent_config.nil? + + yield self if block_given? + end + + ## + # Configurations for individual RPCs + # @return [Rpcs] + # + def rpcs + @rpcs ||= begin + parent_rpcs = nil + parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) + Rpcs.new parent_rpcs + end + end + + ## + # Configuration for the channel pool + # @return [::Gapic::ServiceStub::ChannelPool::Configuration] + # + def channel_pool + @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new + end + + ## + # Configuration RPC class for the DeveloperKnowledge API. + # + # Includes fields providing the configuration for each RPC in this service. + # Each configuration object is of type `Gapic::Config::Method` and includes + # the following configuration fields: + # + # * `timeout` (*type:* `Numeric`) - The call timeout in seconds + # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers + # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields + # include the following keys: + # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. + # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. + # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. + # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0. + # * `:retry_codes` (*type:* `Array`) - The error codes that should + # trigger a retry. + # + class Rpcs + ## + # RPC-specific configuration for `search_document_chunks` + # @return [::Gapic::Config::Method] + # + attr_reader :search_document_chunks + ## + # RPC-specific configuration for `get_document` + # @return [::Gapic::Config::Method] + # + attr_reader :get_document + ## + # RPC-specific configuration for `batch_get_documents` + # @return [::Gapic::Config::Method] + # + attr_reader :batch_get_documents + ## + # RPC-specific configuration for `answer_query` + # @return [::Gapic::Config::Method] + # + attr_reader :answer_query + + # @private + def initialize parent_rpcs = nil + search_document_chunks_config = parent_rpcs.search_document_chunks if parent_rpcs.respond_to? :search_document_chunks + @search_document_chunks = ::Gapic::Config::Method.new search_document_chunks_config + get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document + @get_document = ::Gapic::Config::Method.new get_document_config + batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents + @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config + answer_query_config = parent_rpcs.answer_query if parent_rpcs.respond_to? :answer_query + @answer_query = ::Gapic::Config::Method.new answer_query_config + + yield self if block_given? + end + end + end + end + end + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/credentials.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/credentials.rb new file mode 100644 index 000000000000..4d6b73d55cf7 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/credentials.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "googleauth" + +module Google + module Developers + module DeveloperKnowledge + module V1 + module DeveloperKnowledge + # Credentials for the DeveloperKnowledge API. + class Credentials < ::Google::Auth::Credentials + self.scope = [ + "https://www.googleapis.com/auth/cloud-platform" + ] + self.env_vars = [ + "GOOGLE_CLOUD_CREDENTIALS", + "GOOGLE_CLOUD_KEYFILE", + "GCLOUD_KEYFILE", + "GOOGLE_CLOUD_CREDENTIALS_JSON", + "GOOGLE_CLOUD_KEYFILE_JSON", + "GCLOUD_KEYFILE_JSON" + ] + self.paths = [ + "~/.config/google_cloud/application_default_credentials.json" + ] + end + end + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/paths.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/paths.rb new file mode 100644 index 000000000000..6389c8f3c5e6 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/paths.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Developers + module DeveloperKnowledge + module V1 + module DeveloperKnowledge + # Path helper methods for the DeveloperKnowledge API. + module Paths + ## + # Create a fully-qualified Document resource string. + # + # The resource will be in the following format: + # + # `documents/{document}` + # + # @param document [String] + # + # @return [::String] + def document_path document: + "documents/#{document}" + end + + extend self + end + end + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest.rb new file mode 100644 index 000000000000..6b7630f75bd6 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest.rb @@ -0,0 +1,67 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "gapic/rest" +require "gapic/config" +require "gapic/config/method" + +require "google/developers/developer_knowledge/v1/version" + +require "google/developers/developer_knowledge/v1/developer_knowledge/credentials" +require "google/developers/developer_knowledge/v1/developer_knowledge/paths" +require "google/developers/developer_knowledge/v1/developer_knowledge/rest/client" + +module Google + module Developers + module DeveloperKnowledge + module V1 + ## + # The Developer Knowledge API provides programmatic access to Google's public + # developer documentation, enabling you to integrate this knowledge base into + # your own applications and workflows. + # + # The API is designed to be the canonical source for machine-readable access to + # Google's developer documentation. + # + # A typical use case is to first use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks} + # to find relevant page URIs based on a query, and then use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # to fetch the full content of the top results. + # + # All document content is provided in Markdown format. + # + # To load this service and instantiate a REST client: + # + # require "google/developers/developer_knowledge/v1/developer_knowledge/rest" + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + module DeveloperKnowledge + # Client for the REST transport + module Rest + end + end + end + end + end +end + +helper_path = ::File.join __dir__, "rest", "helpers.rb" +require "google/developers/developer_knowledge/v1/developer_knowledge/rest/helpers" if ::File.file? helper_path diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb new file mode 100644 index 000000000000..22d73f37ff82 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb @@ -0,0 +1,814 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "google/cloud/errors" +require "google/developers/knowledge/v1/developerknowledge_pb" +require "google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub" + +module Google + module Developers + module DeveloperKnowledge + module V1 + module DeveloperKnowledge + module Rest + ## + # REST client for the DeveloperKnowledge service. + # + # The Developer Knowledge API provides programmatic access to Google's public + # developer documentation, enabling you to integrate this knowledge base into + # your own applications and workflows. + # + # The API is designed to be the canonical source for machine-readable access to + # Google's developer documentation. + # + # A typical use case is to first use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks} + # to find relevant page URIs based on a query, and then use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # to fetch the full content of the top results. + # + # All document content is provided in Markdown format. + # + class Client + # @private + API_VERSION = "" + + # @private + DEFAULT_ENDPOINT_TEMPLATE = "developerknowledge.$UNIVERSE_DOMAIN$" + + include Paths + + # @private + attr_reader :developer_knowledge_stub + + ## + # Configure the DeveloperKnowledge Client class. + # + # See {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client::Configuration} + # for a description of the configuration fields. + # + # @example + # + # # Modify the configuration for all DeveloperKnowledge clients + # ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.configure do |config| + # config.timeout = 10.0 + # end + # + # @yield [config] Configure the Client client. + # @yieldparam config [Client::Configuration] + # + # @return [Client::Configuration] + # + def self.configure + @configure ||= begin + namespace = ["Google", "Developers", "DeveloperKnowledge", "V1"] + parent_config = while namespace.any? + parent_name = namespace.join "::" + parent_const = const_get parent_name + break parent_const.configure if parent_const.respond_to? :configure + namespace.pop + end + default_config = Client::Configuration.new parent_config + + default_config.rpcs.get_document.timeout = 60.0 + default_config.rpcs.get_document.retry_policy = { + initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] + } + + default_config.rpcs.batch_get_documents.timeout = 60.0 + default_config.rpcs.batch_get_documents.retry_policy = { + initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] + } + + default_config + end + yield @configure if block_given? + @configure + end + + ## + # Configure the DeveloperKnowledge Client instance. + # + # The configuration is set to the derived mode, meaning that values can be changed, + # but structural changes (adding new fields, etc.) are not allowed. Structural changes + # should be made on {Client.configure}. + # + # See {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client::Configuration} + # for a description of the configuration fields. + # + # @yield [config] Configure the Client client. + # @yieldparam config [Client::Configuration] + # + # @return [Client::Configuration] + # + def configure + yield @config if block_given? + @config + end + + ## + # The effective universe domain + # + # @return [String] + # + def universe_domain + @developer_knowledge_stub.universe_domain + end + + ## + # Create a new DeveloperKnowledge REST client object. + # + # @example + # + # # Create a client using the default configuration + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + # # Create a client using a custom configuration + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| + # config.timeout = 10.0 + # end + # + # @yield [config] Configure the DeveloperKnowledge client. + # @yieldparam config [Client::Configuration] + # + def initialize + # Create the configuration object + @config = Configuration.new Client.configure + + # Yield the configuration if needed + yield @config if block_given? + + # Create credentials + credentials = @config.credentials + # Use self-signed JWT if the endpoint is unchanged from default, + # but only if the default endpoint does not have a region prefix. + enable_self_signed_jwt = @config.endpoint.nil? || + (@config.endpoint == Configuration::DEFAULT_ENDPOINT && + !@config.endpoint.split(".").first.include?("-")) + credentials ||= Credentials.default scope: @config.scope, + enable_self_signed_jwt: enable_self_signed_jwt + if credentials.is_a?(::String) || credentials.is_a?(::Hash) + credentials = Credentials.new credentials, scope: @config.scope + end + + @quota_project_id = @config.quota_project + @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id + + @developer_knowledge_stub = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.new( + endpoint: @config.endpoint, + endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, + universe_domain: @config.universe_domain, + credentials: credentials, + logger: @config.logger + ) + + @developer_knowledge_stub.logger(stub: true)&.info do |entry| + entry.set_system_name + entry.set_service + entry.message = "Created client for #{entry.service}" + entry.set_credentials_fields credentials + entry.set "customEndpoint", @config.endpoint if @config.endpoint + entry.set "defaultTimeout", @config.timeout if @config.timeout + entry.set "quotaProject", @quota_project_id if @quota_project_id + end + end + + ## + # The logger used for request/response debug logging. + # + # @return [Logger] + # + def logger + @developer_knowledge_stub.logger + end + + # Service calls + + ## + # Searches for developer knowledge across Google's developer documentation. + # Returns {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s + # based on the user's query. There may be many chunks from the same + # {::Google::Developers::DeveloperKnowledge::V1::Document Document}. To retrieve full + # documents, use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # with the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk#parent DocumentChunk.parent} + # returned in the + # {::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse#results SearchDocumentChunksResponse.results}. + # + # @overload search_document_chunks(request, options = nil) + # Pass arguments to `search_document_chunks` via a request object, either of type + # {::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest} or an equivalent Hash. + # + # @param request [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest, ::Hash] + # A request object representing the call parameters. Required. To specify no + # parameters, or to keep all the default parameter values, pass an empty Hash. + # @param options [::Gapic::CallOptions, ::Hash] + # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. + # + # @overload search_document_chunks(query: nil, page_size: nil, page_token: nil, filter: nil) + # Pass arguments to `search_document_chunks` via keyword arguments. Note that at + # least one keyword argument is required. To specify no parameters, or to keep all + # the default parameter values, pass an empty Hash as a request object (see above). + # + # @param query [::String] + # Required. Provides the raw query string provided by the user, such as "How + # to create a Cloud Storage bucket?". The query must not exceed 500 + # characters; values longer than 500 characters will result in an + # `INVALID_ARGUMENT` error. + # @param page_size [::Integer] + # Optional. Specifies the maximum number of results to return. The service + # may return fewer than this value. + # + # If unspecified, at most 5 results will be returned. + # + # The maximum value is 100; values above 100 will be coerced to 100. + # @param page_token [::String] + # Optional. Contains a page token, received from a previous + # `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. + # @param filter [::String] + # Optional. Applies a strict filter to the search results. The expression + # supports a subset of the syntax described at https://google.aip.dev/160. + # + # While `SearchDocumentChunks` returns + # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s, the filter + # is applied to `DocumentChunk.document` fields. + # + # Supported fields for filtering: + # + # * `content_length_bytes` (INTEGER): The length of the `Document.content` + # field in bytes. + # * `data_source` (STRING): The source of the document, e.g. + # `docs.cloud.google.com`. See + # https://developers.google.com/knowledge/reference/corpus-reference for + # the complete list of data sources in the corpus. + # * `update_time` (TIMESTAMP): The timestamp of when the document was last + # meaningfully updated. A meaningful update is one that changes document's + # markdown content or metadata. + # * `uri` (STRING): The document URI, e.g. + # `https://docs.cloud.google.com/bigquery/docs/tables`. + # + # INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. + # + # STRING fields support `=` (equals) and `!=` (not equals) operators for + # **exact match** on the whole string. Partial match, prefix match, and + # regexp match are not supported. + # + # TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. + # Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. + # + # Note: Field names must be in `snake_case` (e.g., `data_source`). Values on + # the right-hand side of filtering expressions must be string literals + # enclosed in double quotes (e.g., `"docs.cloud.google.com"`). + # + # You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical + # operators. `OR` has higher precedence than `AND`. Use parentheses for + # explicit precedence grouping. + # + # Examples: + # + # * Filter by `Document.content_length_bytes`: + # `content_length_bytes < 50000` + # * `data_source = "docs.cloud.google.com" OR data_source = + # "firebase.google.com"` + # * `data_source != "firebase.google.com"` + # * `update_time < "2024-01-01T00:00:00Z"` + # * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = + # "developer.chrome.com" OR data_source = "web.dev")` + # * `uri = "https://docs.cloud.google.com/release-notes"` + # + # The `filter` string must not exceed 500 characters; values longer than 500 + # characters will result in an `INVALID_ARGUMENT` error. + # @yield [result, operation] Access the result along with the TransportOperation object + # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] + # @yieldparam operation [::Gapic::Rest::TransportOperation] + # + # @return [::Gapic::Rest::PagedEnumerable<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] + # + # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/developers/developer_knowledge/v1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new + # + # # Call the search_document_chunks method. + # result = client.search_document_chunks request + # + # # The returned object is of type Gapic::PagedEnumerable. You can iterate + # # over elements, and API calls will be issued to fetch pages as needed. + # result.each do |item| + # # Each element is of type ::Google::Developers::DeveloperKnowledge::V1::DocumentChunk. + # p item + # end + # + def search_document_chunks request, options = nil + raise ::ArgumentError, "request must be provided" if request.nil? + + request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest + + # Converts hash and nil to an options object + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + + # Customize the options with defaults + call_metadata = @config.rpcs.search_document_chunks.metadata.to_h + + # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers + call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ + lib_name: @config.lib_name, lib_version: @config.lib_version, + gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION, + transports_version_send: [:rest] + + call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + + options.apply_defaults timeout: @config.rpcs.search_document_chunks.timeout, + metadata: call_metadata, + retry_policy: @config.rpcs.search_document_chunks.retry_policy + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, + retry_policy: @config.retry_policy + + @developer_knowledge_stub.search_document_chunks request, options do |result, operation| + result = ::Gapic::Rest::PagedEnumerable.new @developer_knowledge_stub, :search_document_chunks, "results", request, result, options + yield result, operation if block_given? + throw :response, result + end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) + end + + ## + # Retrieves a single document with its full Markdown content. + # + # @overload get_document(request, options = nil) + # Pass arguments to `get_document` via a request object, either of type + # {::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest} or an equivalent Hash. + # + # @param request [::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, ::Hash] + # A request object representing the call parameters. Required. To specify no + # parameters, or to keep all the default parameter values, pass an empty Hash. + # @param options [::Gapic::CallOptions, ::Hash] + # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. + # + # @overload get_document(name: nil, view: nil) + # Pass arguments to `get_document` via keyword arguments. Note that at + # least one keyword argument is required. To specify no parameters, or to keep all + # the default parameter values, pass an empty Hash as a request object (see above). + # + # @param name [::String] + # Required. Specifies the name of the document to retrieve. + # Format: `documents/{uri_without_scheme}` + # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + # + # The name must not exceed 500 characters; values longer than 500 characters + # will result in an `INVALID_ARGUMENT` error. + # @param view [::Google::Developers::DeveloperKnowledge::V1::DocumentView] + # Optional. Specifies the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the + # document. If unspecified, + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#get_document DeveloperKnowledge.GetDocument} + # defaults to `DOCUMENT_VIEW_CONTENT`. + # @yield [result, operation] Access the result along with the TransportOperation object + # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::Document] + # @yieldparam operation [::Gapic::Rest::TransportOperation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::Document] + # + # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/developers/developer_knowledge/v1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new + # + # # Call the get_document method. + # result = client.get_document request + # + # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::Document. + # p result + # + def get_document request, options = nil + raise ::ArgumentError, "request must be provided" if request.nil? + + request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest + + # Converts hash and nil to an options object + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + + # Customize the options with defaults + call_metadata = @config.rpcs.get_document.metadata.to_h + + # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers + call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ + lib_name: @config.lib_name, lib_version: @config.lib_version, + gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION, + transports_version_send: [:rest] + + call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + + options.apply_defaults timeout: @config.rpcs.get_document.timeout, + metadata: call_metadata, + retry_policy: @config.rpcs.get_document.retry_policy + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, + retry_policy: @config.retry_policy + + @developer_knowledge_stub.get_document request, options do |result, operation| + yield result, operation if block_given? + end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) + end + + ## + # Retrieves multiple documents, each with its full Markdown content. + # + # @overload batch_get_documents(request, options = nil) + # Pass arguments to `batch_get_documents` via a request object, either of type + # {::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest} or an equivalent Hash. + # + # @param request [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, ::Hash] + # A request object representing the call parameters. Required. To specify no + # parameters, or to keep all the default parameter values, pass an empty Hash. + # @param options [::Gapic::CallOptions, ::Hash] + # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. + # + # @overload batch_get_documents(names: nil, view: nil) + # Pass arguments to `batch_get_documents` via keyword arguments. Note that at + # least one keyword argument is required. To specify no parameters, or to keep all + # the default parameter values, pass an empty Hash as a request object (see above). + # + # @param names [::Array<::String>] + # Required. Specifies the names of the documents to retrieve. A maximum of 20 + # documents can be retrieved in a batch. The documents are returned in the + # same order as the `names` in the request. + # + # Format: `documents/{uri_without_scheme}` + # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + # + # Each name must not exceed 500 characters; values longer than 500 characters + # will result in an `INVALID_ARGUMENT` error. + # @param view [::Google::Developers::DeveloperKnowledge::V1::DocumentView] + # Optional. Specifies the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the + # document. If unspecified, + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # defaults to `DOCUMENT_VIEW_CONTENT`. + # @yield [result, operation] Access the result along with the TransportOperation object + # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] + # @yieldparam operation [::Gapic::Rest::TransportOperation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] + # + # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/developers/developer_knowledge/v1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new + # + # # Call the batch_get_documents method. + # result = client.batch_get_documents request + # + # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse. + # p result + # + def batch_get_documents request, options = nil + raise ::ArgumentError, "request must be provided" if request.nil? + + request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest + + # Converts hash and nil to an options object + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + + # Customize the options with defaults + call_metadata = @config.rpcs.batch_get_documents.metadata.to_h + + # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers + call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ + lib_name: @config.lib_name, lib_version: @config.lib_version, + gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION, + transports_version_send: [:rest] + + call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + + options.apply_defaults timeout: @config.rpcs.batch_get_documents.timeout, + metadata: call_metadata, + retry_policy: @config.rpcs.batch_get_documents.retry_policy + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, + retry_policy: @config.retry_policy + + @developer_knowledge_stub.batch_get_documents request, options do |result, operation| + yield result, operation if block_given? + end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) + end + + ## + # Answers a query using grounded generation. + # + # @overload answer_query(request, options = nil) + # Pass arguments to `answer_query` via a request object, either of type + # {::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest} or an equivalent Hash. + # + # @param request [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Hash] + # A request object representing the call parameters. Required. To specify no + # parameters, or to keep all the default parameter values, pass an empty Hash. + # @param options [::Gapic::CallOptions, ::Hash] + # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. + # + # @overload answer_query(query: nil) + # Pass arguments to `answer_query` via keyword arguments. Note that at + # least one keyword argument is required. To specify no parameters, or to keep all + # the default parameter values, pass an empty Hash as a request object (see above). + # + # @param query [::String] + # Required. The query to answer. + # @yield [result, operation] Access the result along with the TransportOperation object + # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] + # @yieldparam operation [::Gapic::Rest::TransportOperation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] + # + # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/developers/developer_knowledge/v1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new + # + # # Call the answer_query method. + # result = client.answer_query request + # + # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse. + # p result + # + def answer_query request, options = nil + raise ::ArgumentError, "request must be provided" if request.nil? + + request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest + + # Converts hash and nil to an options object + options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h + + # Customize the options with defaults + call_metadata = @config.rpcs.answer_query.metadata.to_h + + # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers + call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ + lib_name: @config.lib_name, lib_version: @config.lib_version, + gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION, + transports_version_send: [:rest] + + call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + + options.apply_defaults timeout: @config.rpcs.answer_query.timeout, + metadata: call_metadata, + retry_policy: @config.rpcs.answer_query.retry_policy + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, + retry_policy: @config.retry_policy + + @developer_knowledge_stub.answer_query request, options do |result, operation| + yield result, operation if block_given? + end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) + end + + ## + # Configuration class for the DeveloperKnowledge REST API. + # + # This class represents the configuration for DeveloperKnowledge REST, + # providing control over timeouts, retry behavior, logging, transport + # parameters, and other low-level controls. Certain parameters can also be + # applied individually to specific RPCs. See + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client::Configuration::Rpcs} + # for a list of RPCs that can be configured independently. + # + # Configuration can be applied globally to all clients, or to a single client + # on construction. + # + # @example + # + # # Modify the global config, setting the timeout for + # # search_document_chunks to 20 seconds, + # # and all remaining timeouts to 10 seconds. + # ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.configure do |config| + # config.timeout = 10.0 + # config.rpcs.search_document_chunks.timeout = 20.0 + # end + # + # # Apply the above configuration only to a new client. + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| + # config.timeout = 10.0 + # config.rpcs.search_document_chunks.timeout = 20.0 + # end + # + # @!attribute [rw] endpoint + # A custom service endpoint, as a hostname or hostname:port. The default is + # nil, indicating to use the default endpoint in the current universe domain. + # @return [::String,nil] + # @!attribute [rw] credentials + # Credentials to send with calls. You may provide any of the following types: + # * (`String`) The path to a service account key file in JSON format + # * (`Hash`) A service account key as a Hash + # * (`Google::Auth::Credentials`) A googleauth credentials object + # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) + # * (`Signet::OAuth2::Client`) A signet oauth2 client object + # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) + # * (`nil`) indicating no credentials + # + # Warning: If you accept a credential configuration (JSON file or Hash) from an + # external source for authentication to Google Cloud, you must validate it before + # providing it to a Google API client library. Providing an unvalidated credential + # configuration to Google APIs can compromise the security of your systems and data. + # For more information, refer to [Validate credential configurations from external + # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials). + # @return [::Object] + # @!attribute [rw] scope + # The OAuth scopes + # @return [::Array<::String>] + # @!attribute [rw] lib_name + # The library name as recorded in instrumentation and logging + # @return [::String] + # @!attribute [rw] lib_version + # The library version as recorded in instrumentation and logging + # @return [::String] + # @!attribute [rw] timeout + # The call timeout in seconds. + # @return [::Numeric] + # @!attribute [rw] metadata + # Additional headers to be sent with the call. + # @return [::Hash{::Symbol=>::String}] + # @!attribute [rw] retry_policy + # The retry policy. The value is a hash with the following keys: + # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. + # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. + # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. + # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0. + # * `:retry_codes` (*type:* `Array`) - The error codes that should + # trigger a retry. + # @return [::Hash] + # @!attribute [rw] quota_project + # A separate project against which to charge quota. + # @return [::String] + # @!attribute [rw] universe_domain + # The universe domain within which to make requests. This determines the + # default endpoint URL. The default value of nil uses the environment + # universe (usually the default "googleapis.com" universe). + # @return [::String,nil] + # @!attribute [rw] logger + # A custom logger to use for request/response debug logging, or the value + # `:default` (the default) to construct a default logger, or `nil` to + # explicitly disable logging. + # @return [::Logger,:default,nil] + # + class Configuration + extend ::Gapic::Config + + # @private + # The endpoint specific to the default "googleapis.com" universe. Deprecated. + DEFAULT_ENDPOINT = "developerknowledge.googleapis.com" + + config_attr :endpoint, nil, ::String, nil + config_attr :credentials, nil do |value| + allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil] + allowed.any? { |klass| klass === value } + end + config_attr :scope, nil, ::String, ::Array, nil + config_attr :lib_name, nil, ::String, nil + config_attr :lib_version, nil, ::String, nil + config_attr :timeout, nil, ::Numeric, nil + config_attr :metadata, nil, ::Hash, nil + config_attr :retry_policy, nil, ::Hash, ::Proc, nil + config_attr :quota_project, nil, ::String, nil + config_attr :universe_domain, nil, ::String, nil + config_attr :logger, :default, ::Logger, nil, :default + + # @private + def initialize parent_config = nil + @parent_config = parent_config unless parent_config.nil? + + yield self if block_given? + end + + ## + # Configurations for individual RPCs + # @return [Rpcs] + # + def rpcs + @rpcs ||= begin + parent_rpcs = nil + parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) + Rpcs.new parent_rpcs + end + end + + ## + # Configuration RPC class for the DeveloperKnowledge API. + # + # Includes fields providing the configuration for each RPC in this service. + # Each configuration object is of type `Gapic::Config::Method` and includes + # the following configuration fields: + # + # * `timeout` (*type:* `Numeric`) - The call timeout in seconds + # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers + # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields + # include the following keys: + # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. + # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. + # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. + # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0. + # * `:retry_codes` (*type:* `Array`) - The error codes that should + # trigger a retry. + # + class Rpcs + ## + # RPC-specific configuration for `search_document_chunks` + # @return [::Gapic::Config::Method] + # + attr_reader :search_document_chunks + ## + # RPC-specific configuration for `get_document` + # @return [::Gapic::Config::Method] + # + attr_reader :get_document + ## + # RPC-specific configuration for `batch_get_documents` + # @return [::Gapic::Config::Method] + # + attr_reader :batch_get_documents + ## + # RPC-specific configuration for `answer_query` + # @return [::Gapic::Config::Method] + # + attr_reader :answer_query + + # @private + def initialize parent_rpcs = nil + search_document_chunks_config = parent_rpcs.search_document_chunks if parent_rpcs.respond_to? :search_document_chunks + @search_document_chunks = ::Gapic::Config::Method.new search_document_chunks_config + get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document + @get_document = ::Gapic::Config::Method.new get_document_config + batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents + @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config + answer_query_config = parent_rpcs.answer_query if parent_rpcs.respond_to? :answer_query + @answer_query = ::Gapic::Config::Method.new answer_query_config + + yield self if block_given? + end + end + end + end + end + end + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb new file mode 100644 index 000000000000..2b64ff55126a --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb @@ -0,0 +1,320 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "google/developers/knowledge/v1/developerknowledge_pb" + +module Google + module Developers + module DeveloperKnowledge + module V1 + module DeveloperKnowledge + module Rest + ## + # REST service stub for the DeveloperKnowledge service. + # Service stub contains baseline method implementations + # including transcoding, making the REST call, and deserialing the response. + # + class ServiceStub + # @private + def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger: + # These require statements are intentionally placed here to initialize + # the REST modules only when it's required. + require "gapic/rest" + + @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, + endpoint_template: endpoint_template, + universe_domain: universe_domain, + credentials: credentials, + numeric_enums: true, + service_name: self.class, + raise_faraday_errors: false, + logger: logger + end + + ## + # The effective universe domain + # + # @return [String] + # + def universe_domain + @client_stub.universe_domain + end + + ## + # The effective endpoint + # + # @return [String] + # + def endpoint + @client_stub.endpoint + end + + ## + # The logger used for request/response debug logging. + # + # @return [Logger] + # + def logger stub: false + stub ? @client_stub.stub_logger : @client_stub.logger + end + + ## + # Baseline implementation for the search_document_chunks REST call + # + # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest] + # A request object representing the call parameters. Required. + # @param options [::Gapic::CallOptions] + # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. + # + # @yield [result, operation] Access the result along with the TransportOperation object + # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse] + # @yieldparam operation [::Gapic::Rest::TransportOperation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse] + # A result object deserialized from the server's reply + def search_document_chunks request_pb, options = nil + raise ::ArgumentError, "request must be provided" if request_pb.nil? + + verb, uri, query_string_params, body = ServiceStub.transcode_search_document_chunks_request request_pb + query_string_params = if query_string_params.any? + query_string_params.to_h { |p| p.split "=", 2 } + else + {} + end + + response = @client_stub.make_http_request( + verb, + uri: uri, + body: body || "", + params: query_string_params, + method_name: "search_document_chunks", + options: options + ) + operation = ::Gapic::Rest::TransportOperation.new response + result = ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse.decode_json response.body, ignore_unknown_fields: true + catch :response do + yield result, operation if block_given? + result + end + end + + ## + # Baseline implementation for the get_document REST call + # + # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest] + # A request object representing the call parameters. Required. + # @param options [::Gapic::CallOptions] + # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. + # + # @yield [result, operation] Access the result along with the TransportOperation object + # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::Document] + # @yieldparam operation [::Gapic::Rest::TransportOperation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::Document] + # A result object deserialized from the server's reply + def get_document request_pb, options = nil + raise ::ArgumentError, "request must be provided" if request_pb.nil? + + verb, uri, query_string_params, body = ServiceStub.transcode_get_document_request request_pb + query_string_params = if query_string_params.any? + query_string_params.to_h { |p| p.split "=", 2 } + else + {} + end + + response = @client_stub.make_http_request( + verb, + uri: uri, + body: body || "", + params: query_string_params, + method_name: "get_document", + options: options + ) + operation = ::Gapic::Rest::TransportOperation.new response + result = ::Google::Developers::DeveloperKnowledge::V1::Document.decode_json response.body, ignore_unknown_fields: true + catch :response do + yield result, operation if block_given? + result + end + end + + ## + # Baseline implementation for the batch_get_documents REST call + # + # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest] + # A request object representing the call parameters. Required. + # @param options [::Gapic::CallOptions] + # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. + # + # @yield [result, operation] Access the result along with the TransportOperation object + # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] + # @yieldparam operation [::Gapic::Rest::TransportOperation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] + # A result object deserialized from the server's reply + def batch_get_documents request_pb, options = nil + raise ::ArgumentError, "request must be provided" if request_pb.nil? + + verb, uri, query_string_params, body = ServiceStub.transcode_batch_get_documents_request request_pb + query_string_params = if query_string_params.any? + query_string_params.to_h { |p| p.split "=", 2 } + else + {} + end + + response = @client_stub.make_http_request( + verb, + uri: uri, + body: body || "", + params: query_string_params, + method_name: "batch_get_documents", + options: options + ) + operation = ::Gapic::Rest::TransportOperation.new response + result = ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse.decode_json response.body, ignore_unknown_fields: true + catch :response do + yield result, operation if block_given? + result + end + end + + ## + # Baseline implementation for the answer_query REST call + # + # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest] + # A request object representing the call parameters. Required. + # @param options [::Gapic::CallOptions] + # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. + # + # @yield [result, operation] Access the result along with the TransportOperation object + # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] + # @yieldparam operation [::Gapic::Rest::TransportOperation] + # + # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] + # A result object deserialized from the server's reply + def answer_query request_pb, options = nil + raise ::ArgumentError, "request must be provided" if request_pb.nil? + + verb, uri, query_string_params, body = ServiceStub.transcode_answer_query_request request_pb + query_string_params = if query_string_params.any? + query_string_params.to_h { |p| p.split "=", 2 } + else + {} + end + + response = @client_stub.make_http_request( + verb, + uri: uri, + body: body || "", + params: query_string_params, + method_name: "answer_query", + options: options + ) + operation = ::Gapic::Rest::TransportOperation.new response + result = ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.decode_json response.body, ignore_unknown_fields: true + catch :response do + yield result, operation if block_given? + result + end + end + + ## + # @private + # + # GRPC transcoding helper method for the search_document_chunks REST call + # + # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest] + # A request object representing the call parameters. Required. + # @return [Array(String, [String, nil], Hash{String => String})] + # Uri, Body, Query string parameters + def self.transcode_search_document_chunks_request request_pb + transcoder = Gapic::Rest::GrpcTranscoder.new + .with_bindings( + uri_method: :get, + uri_template: "/v1/documents:searchDocumentChunks", + matches: [] + ) + transcoder.transcode request_pb + end + + ## + # @private + # + # GRPC transcoding helper method for the get_document REST call + # + # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest] + # A request object representing the call parameters. Required. + # @return [Array(String, [String, nil], Hash{String => String})] + # Uri, Body, Query string parameters + def self.transcode_get_document_request request_pb + transcoder = Gapic::Rest::GrpcTranscoder.new + .with_bindings( + uri_method: :get, + uri_template: "/v1/{name}", + matches: [ + ["name", %r{^documents(?:/(?<__wildcard__>.*))?$}, true] + ] + ) + transcoder.transcode request_pb + end + + ## + # @private + # + # GRPC transcoding helper method for the batch_get_documents REST call + # + # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest] + # A request object representing the call parameters. Required. + # @return [Array(String, [String, nil], Hash{String => String})] + # Uri, Body, Query string parameters + def self.transcode_batch_get_documents_request request_pb + transcoder = Gapic::Rest::GrpcTranscoder.new + .with_bindings( + uri_method: :get, + uri_template: "/v1/documents:batchGet", + matches: [] + ) + transcoder.transcode request_pb + end + + ## + # @private + # + # GRPC transcoding helper method for the answer_query REST call + # + # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest] + # A request object representing the call parameters. Required. + # @return [Array(String, [String, nil], Hash{String => String})] + # Uri, Body, Query string parameters + def self.transcode_answer_query_request request_pb + transcoder = Gapic::Rest::GrpcTranscoder.new + .with_bindings( + uri_method: :post, + uri_template: "/v1:answerQuery", + body: "*", + matches: [] + ) + transcoder.transcode request_pb + end + end + end + end + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/rest.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/rest.rb new file mode 100644 index 000000000000..564abffb5326 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/rest.rb @@ -0,0 +1,37 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "google/developers/developer_knowledge/v1/developer_knowledge/rest" +require "google/developers/developer_knowledge/v1/version" + +module Google + module Developers + module DeveloperKnowledge + ## + # To load just the REST part of this package, including all its services, and instantiate a REST client: + # + # @example + # + # require "google/developers/developer_knowledge/v1/rest" + # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new + # + module V1 + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/version.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/version.rb new file mode 100644 index 000000000000..27f225b083b3 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/version.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Developers + module DeveloperKnowledge + module V1 + VERSION = "0.0.1" + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb new file mode 100644 index 000000000000..26518ed4f668 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb @@ -0,0 +1,41 @@ +# frozen_string_literal: true +# Generated by the protocol buffer compiler. DO NOT EDIT! +# source: google/developers/knowledge/v1/developerknowledge.proto + +require 'google/protobuf' + +require 'google/api/annotations_pb' +require 'google/api/client_pb' +require 'google/api/field_behavior_pb' +require 'google/api/resource_pb' +require 'google/protobuf/timestamp_pb' + + +descriptor_data = "\n7google/developers/knowledge/v1/developerknowledge.proto\x12\x1egoogle.developers.knowledge.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x83\x03\n\x08\x44ocument\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x10\n\x03uri\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x65scription\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x61ta_source\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x12\n\x05title\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12?\n\x04view\x18\x08 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x03\x12!\n\x14\x63ontent_length_bytes\x18\t \x01(\x05\x42\x03\xe0\x41\x03:Z\xea\x41W\n*developerknowledge.googleapis.com/Document\x12\x14\x64ocuments/{document}*\tdocuments2\x08\x64ocument\"w\n\x1bSearchDocumentChunksRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x04 \x01(\tB\x03\xe0\x41\x01\"w\n\x1cSearchDocumentChunksResponse\x12>\n\x07results\x18\x01 \x03(\x0b\x32-.google.developers.knowledge.v1.DocumentChunk\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\x97\x01\n\x12GetDocumentRequest\x12@\n\x04name\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"\x9e\x01\n\x18\x42\x61tchGetDocumentsRequest\x12\x41\n\x05names\x18\x01 \x03(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"X\n\x19\x42\x61tchGetDocumentsResponse\x12;\n\tdocuments\x18\x01 \x03(\x0b\x32(.google.developers.knowledge.v1.Document\"(\n\x12\x41nswerQueryRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\"M\n\x13\x41nswerQueryResponse\x12\x36\n\x06\x61nswer\x18\x01 \x01(\x0b\x32&.google.developers.knowledge.v1.Answer\"\xdb\x04\n\x06\x41nswer\x12\x13\n\x0b\x61nswer_text\x18\x01 \x01(\t\x12M\n\tcitations\x18\x02 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.AnswerCitationB\x03\xe0\x41\x03\x12O\n\nreferences\x18\x03 \x03(\x0b\x32\x36.google.developers.knowledge.v1.Answer.AnswerReferenceB\x03\xe0\x41\x03\x1a\x8f\x01\n\x0e\x41nswerCitation\x12\x18\n\x0bstart_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x12\x16\n\tend_index\x18\x02 \x01(\x05\x42\x03\xe0\x41\x03\x12K\n\x07sources\x18\x03 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.CitationSourceB\x03\xe0\x41\x03\x1a.\n\x0e\x43itationSource\x12\x1c\n\x0freference_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x1ay\n\x0f\x41nswerReference\x12[\n\x12\x64ocument_reference\x18\x01 \x01(\x0b\x32\x38.google.developers.knowledge.v1.Answer.DocumentReferenceB\x03\xe0\x41\x03H\x00\x42\t\n\x07\x63ontent\x1a_\n\x11\x44ocumentReference\x12J\n\x0e\x64ocument_chunk\x18\x01 \x01(\x0b\x32-.google.developers.knowledge.v1.DocumentChunkB\x03\xe0\x41\x03\"\xf2\x01\n\rDocumentChunk\x12\x42\n\x06parent\x18\x01 \x01(\tB2\xe0\x41\x03\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12\x0f\n\x02id\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12?\n\x08\x64ocument\x18\x04 \x01(\x0b\x32(.google.developers.knowledge.v1.DocumentB\x03\xe0\x41\x03\x12!\n\x0frelevance_score\x18\x05 \x01(\x01\x42\x03\xe0\x41\x03H\x00\x88\x01\x01\x42\x12\n\x10_relevance_score*y\n\x0c\x44ocumentView\x12\x1d\n\x19\x44OCUMENT_VIEW_UNSPECIFIED\x10\x00\x12\x17\n\x13\x44OCUMENT_VIEW_BASIC\x10\x01\x12\x16\n\x12\x44OCUMENT_VIEW_FULL\x10\x02\x12\x19\n\x15\x44OCUMENT_VIEW_CONTENT\x10\x03\x32\x81\x06\n\x12\x44\x65veloperKnowledge\x12\xbd\x01\n\x14SearchDocumentChunks\x12;.google.developers.knowledge.v1.SearchDocumentChunksRequest\x1a<.google.developers.knowledge.v1.SearchDocumentChunksResponse\"*\x82\xd3\xe4\x93\x02$\x12\"/v1/documents:searchDocumentChunks\x12\x93\x01\n\x0bGetDocument\x12\x32.google.developers.knowledge.v1.GetDocumentRequest\x1a(.google.developers.knowledge.v1.Document\"&\xda\x41\x04name\x82\xd3\xe4\x93\x02\x19\x12\x17/v1/{name=documents/**}\x12\xa8\x01\n\x11\x42\x61tchGetDocuments\x12\x38.google.developers.knowledge.v1.BatchGetDocumentsRequest\x1a\x39.google.developers.knowledge.v1.BatchGetDocumentsResponse\"\x1e\x82\xd3\xe4\x93\x02\x18\x12\x16/v1/documents:batchGet\x12\x92\x01\n\x0b\x41nswerQuery\x12\x32.google.developers.knowledge.v1.AnswerQueryRequest\x1a\x33.google.developers.knowledge.v1.AnswerQueryResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1:answerQuery:\x01*\x1aU\xca\x41!developerknowledge.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x83\x02\n\"com.google.developers.knowledge.v1B\x17\x44\x65veloperKnowledgeProtoP\x01ZAcloud.google.com/go/developerknowledge/apiv1/developerknowledgepb\xaa\x02\'Google.Developers.DeveloperKnowledge.V1\xca\x02\'Google\\Developers\\DeveloperKnowledge\\V1\xea\x02*Google::Developers::DeveloperKnowledge::V1b\x06proto3" + +pool = ::Google::Protobuf::DescriptorPool.generated_pool +pool.add_serialized_file(descriptor_data) + +module Google + module Developers + module DeveloperKnowledge + module V1 + Document = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Document").msgclass + SearchDocumentChunksRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.SearchDocumentChunksRequest").msgclass + SearchDocumentChunksResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.SearchDocumentChunksResponse").msgclass + GetDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.GetDocumentRequest").msgclass + BatchGetDocumentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.BatchGetDocumentsRequest").msgclass + BatchGetDocumentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.BatchGetDocumentsResponse").msgclass + AnswerQueryRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.AnswerQueryRequest").msgclass + AnswerQueryResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.AnswerQueryResponse").msgclass + Answer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer").msgclass + Answer::AnswerCitation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.AnswerCitation").msgclass + Answer::CitationSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.CitationSource").msgclass + Answer::AnswerReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.AnswerReference").msgclass + Answer::DocumentReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.DocumentReference").msgclass + DocumentChunk = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.DocumentChunk").msgclass + DocumentView = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.DocumentView").enummodule + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb new file mode 100644 index 000000000000..b8d1a647457b --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb @@ -0,0 +1,77 @@ +# Generated by the protocol buffer compiler. DO NOT EDIT! +# Source: google/developers/knowledge/v1/developerknowledge.proto for package 'Google.Developers.DeveloperKnowledge.V1' +# Original file comments: +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +require 'grpc' +require 'google/developers/knowledge/v1/developerknowledge_pb' + +module Google + module Developers + module DeveloperKnowledge + module V1 + module DeveloperKnowledge + # The Developer Knowledge API provides programmatic access to Google's public + # developer documentation, enabling you to integrate this knowledge base into + # your own applications and workflows. + # + # The API is designed to be the canonical source for machine-readable access to + # Google's developer documentation. + # + # A typical use case is to first use + # [DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks] + # to find relevant page URIs based on a query, and then use + # [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] + # or + # [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] + # to fetch the full content of the top results. + # + # All document content is provided in Markdown format. + class Service + + include ::GRPC::GenericService + + self.marshal_class_method = :encode + self.unmarshal_class_method = :decode + self.service_name = 'google.developers.knowledge.v1.DeveloperKnowledge' + + # Searches for developer knowledge across Google's developer documentation. + # Returns [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s + # based on the user's query. There may be many chunks from the same + # [Document][google.developers.knowledge.v1.Document]. To retrieve full + # documents, use + # [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] + # or + # [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] + # with the + # [DocumentChunk.parent][google.developers.knowledge.v1.DocumentChunk.parent] + # returned in the + # [SearchDocumentChunksResponse.results][google.developers.knowledge.v1.SearchDocumentChunksResponse.results]. + rpc :SearchDocumentChunks, ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest, ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse + # Retrieves a single document with its full Markdown content. + rpc :GetDocument, ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, ::Google::Developers::DeveloperKnowledge::V1::Document + # Retrieves multiple documents, each with its full Markdown content. + rpc :BatchGetDocuments, ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse + # Answers a query using grounded generation. + rpc :AnswerQuery, ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse + end + + Stub = Service.rpc_stub_class + end + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/README.md b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/README.md new file mode 100644 index 000000000000..76079269bdd8 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/README.md @@ -0,0 +1,4 @@ +# Developer Knowledge V1 Protocol Buffer Documentation + +These files are for the YARD documentation of the generated protobuf files. +They are not intended to be required or loaded at runtime. diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/client.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/client.rb new file mode 100644 index 000000000000..3ab0b096d445 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/client.rb @@ -0,0 +1,593 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Api + # Required information for every language. + # @!attribute [rw] reference_docs_uri + # @deprecated This field is deprecated and may be removed in the next major version update. + # @return [::String] + # Link to automatically generated reference documentation. Example: + # https://cloud.google.com/nodejs/docs/reference/asset/latest + # @!attribute [rw] destinations + # @return [::Array<::Google::Api::ClientLibraryDestination>] + # The destination where API teams want this client library to be published. + # @!attribute [rw] selective_gapic_generation + # @return [::Google::Api::SelectiveGapicGeneration] + # Configuration for which RPCs should be generated in the GAPIC client. + # + # Note: This field should not be used in most cases. + class CommonLanguageSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Details about how and where to publish client libraries. + # @!attribute [rw] version + # @return [::String] + # Version of the API to apply these settings to. This is the full protobuf + # package for the API, ending in the version element. + # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1". + # @!attribute [rw] launch_stage + # @return [::Google::Api::LaunchStage] + # Launch stage of this version of the API. + # @!attribute [rw] rest_numeric_enums + # @return [::Boolean] + # When using transport=rest, the client request will encode enums as + # numbers rather than strings. + # @!attribute [rw] java_settings + # @return [::Google::Api::JavaSettings] + # Settings for legacy Java features, supported in the Service YAML. + # @!attribute [rw] cpp_settings + # @return [::Google::Api::CppSettings] + # Settings for C++ client libraries. + # @!attribute [rw] php_settings + # @return [::Google::Api::PhpSettings] + # Settings for PHP client libraries. + # @!attribute [rw] python_settings + # @return [::Google::Api::PythonSettings] + # Settings for Python client libraries. + # @!attribute [rw] node_settings + # @return [::Google::Api::NodeSettings] + # Settings for Node client libraries. + # @!attribute [rw] dotnet_settings + # @return [::Google::Api::DotnetSettings] + # Settings for .NET client libraries. + # @!attribute [rw] ruby_settings + # @return [::Google::Api::RubySettings] + # Settings for Ruby client libraries. + # @!attribute [rw] go_settings + # @return [::Google::Api::GoSettings] + # Settings for Go client libraries. + class ClientLibrarySettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # This message configures the settings for publishing [Google Cloud Client + # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) + # generated from the service config. + # @!attribute [rw] method_settings + # @return [::Array<::Google::Api::MethodSettings>] + # A list of API method settings, e.g. the behavior for methods that use the + # long-running operation pattern. + # @!attribute [rw] new_issue_uri + # @return [::String] + # Link to a *public* URI where users can report issues. Example: + # https://issuetracker.google.com/issues/new?component=190865&template=1161103 + # @!attribute [rw] documentation_uri + # @return [::String] + # Link to product home page. Example: + # https://cloud.google.com/asset-inventory/docs/overview + # @!attribute [rw] api_short_name + # @return [::String] + # Used as a tracking tag when collecting data about the APIs developer + # relations artifacts like docs, packages delivered to package managers, + # etc. Example: "speech". + # @!attribute [rw] github_label + # @return [::String] + # GitHub label to apply to issues and pull requests opened for this API. + # @!attribute [rw] codeowner_github_teams + # @return [::Array<::String>] + # GitHub teams to be added to CODEOWNERS in the directory in GitHub + # containing source code for the client libraries for this API. + # @!attribute [rw] doc_tag_prefix + # @return [::String] + # A prefix used in sample code when demarking regions to be included in + # documentation. + # @!attribute [rw] organization + # @return [::Google::Api::ClientLibraryOrganization] + # For whom the client library is being published. + # @!attribute [rw] library_settings + # @return [::Array<::Google::Api::ClientLibrarySettings>] + # Client library settings. If the same version string appears multiple + # times in this list, then the last one wins. Settings from earlier + # settings with the same version string are discarded. + # @!attribute [rw] proto_reference_documentation_uri + # @return [::String] + # Optional link to proto reference documentation. Example: + # https://cloud.google.com/pubsub/lite/docs/reference/rpc + # @!attribute [rw] rest_reference_documentation_uri + # @return [::String] + # Optional link to REST reference documentation. Example: + # https://cloud.google.com/pubsub/lite/docs/reference/rest + class Publishing + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Settings for Java client libraries. + # @!attribute [rw] library_package + # @return [::String] + # The package name to use in Java. Clobbers the java_package option + # set in the protobuf. This should be used **only** by APIs + # who have already set the language_settings.java.package_name" field + # in gapic.yaml. API teams should use the protobuf java_package option + # where possible. + # + # Example of a YAML configuration:: + # + # publishing: + # library_settings: + # java_settings: + # library_package: com.google.cloud.pubsub.v1 + # @!attribute [rw] service_class_names + # @return [::Google::Protobuf::Map{::String => ::String}] + # Configure the Java class name to use instead of the service's for its + # corresponding generated GAPIC client. Keys are fully-qualified + # service names as they appear in the protobuf (including the full + # the language_settings.java.interface_names" field in gapic.yaml. API + # teams should otherwise use the service name as it appears in the + # protobuf. + # + # Example of a YAML configuration:: + # + # publishing: + # java_settings: + # service_class_names: + # - google.pubsub.v1.Publisher: TopicAdmin + # - google.pubsub.v1.Subscriber: SubscriptionAdmin + # @!attribute [rw] common + # @return [::Google::Api::CommonLanguageSettings] + # Some settings. + class JavaSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # @!attribute [rw] key + # @return [::String] + # @!attribute [rw] value + # @return [::String] + class ServiceClassNamesEntry + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end + + # Settings for C++ client libraries. + # @!attribute [rw] common + # @return [::Google::Api::CommonLanguageSettings] + # Some settings. + class CppSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Settings for Php client libraries. + # @!attribute [rw] common + # @return [::Google::Api::CommonLanguageSettings] + # Some settings. + # @!attribute [rw] library_package + # @return [::String] + # The package name to use in Php. Clobbers the php_namespace option + # set in the protobuf. This should be used **only** by APIs + # who have already set the language_settings.php.package_name" field + # in gapic.yaml. API teams should use the protobuf php_namespace option + # where possible. + # + # Example of a YAML configuration:: + # + # publishing: + # library_settings: + # php_settings: + # library_package: Google\Cloud\PubSub\V1 + class PhpSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Settings for Python client libraries. + # @!attribute [rw] common + # @return [::Google::Api::CommonLanguageSettings] + # Some settings. + # @!attribute [rw] experimental_features + # @return [::Google::Api::PythonSettings::ExperimentalFeatures] + # Experimental features to be included during client library generation. + class PythonSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # Experimental features to be included during client library generation. + # These fields will be deprecated once the feature graduates and is enabled + # by default. + # @!attribute [rw] rest_async_io_enabled + # @return [::Boolean] + # Enables generation of asynchronous REST clients if `rest` transport is + # enabled. By default, asynchronous REST clients will not be generated. + # This feature will be enabled by default 1 month after launching the + # feature in preview packages. + # @!attribute [rw] protobuf_pythonic_types_enabled + # @return [::Boolean] + # Enables generation of protobuf code using new types that are more + # Pythonic which are included in `protobuf>=5.29.x`. This feature will be + # enabled by default 1 month after launching the feature in preview + # packages. + # @!attribute [rw] unversioned_package_disabled + # @return [::Boolean] + # Disables generation of an unversioned Python package for this client + # library. This means that the module names will need to be versioned in + # import statements. For example `import google.cloud.library_v2` instead + # of `import google.cloud.library`. + class ExperimentalFeatures + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end + + # Settings for Node client libraries. + # @!attribute [rw] common + # @return [::Google::Api::CommonLanguageSettings] + # Some settings. + class NodeSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Settings for Dotnet client libraries. + # @!attribute [rw] common + # @return [::Google::Api::CommonLanguageSettings] + # Some settings. + # @!attribute [rw] renamed_services + # @return [::Google::Protobuf::Map{::String => ::String}] + # Map from original service names to renamed versions. + # This is used when the default generated types + # would cause a naming conflict. (Neither name is + # fully-qualified.) + # Example: Subscriber to SubscriberServiceApi. + # @!attribute [rw] renamed_resources + # @return [::Google::Protobuf::Map{::String => ::String}] + # Map from full resource types to the effective short name + # for the resource. This is used when otherwise resource + # named from different services would cause naming collisions. + # Example entry: + # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" + # @!attribute [rw] ignored_resources + # @return [::Array<::String>] + # List of full resource types to ignore during generation. + # This is typically used for API-specific Location resources, + # which should be handled by the generator as if they were actually + # the common Location resources. + # Example entry: "documentai.googleapis.com/Location" + # @!attribute [rw] forced_namespace_aliases + # @return [::Array<::String>] + # Namespaces which must be aliased in snippets due to + # a known (but non-generator-predictable) naming collision + # @!attribute [rw] handwritten_signatures + # @return [::Array<::String>] + # Method signatures (in the form "service.method(signature)") + # which are provided separately, so shouldn't be generated. + # Snippets *calling* these methods are still generated, however. + class DotnetSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # @!attribute [rw] key + # @return [::String] + # @!attribute [rw] value + # @return [::String] + class RenamedServicesEntry + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # @!attribute [rw] key + # @return [::String] + # @!attribute [rw] value + # @return [::String] + class RenamedResourcesEntry + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end + + # Settings for Ruby client libraries. + # @!attribute [rw] common + # @return [::Google::Api::CommonLanguageSettings] + # Some settings. + class RubySettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Settings for Go client libraries. + # @!attribute [rw] common + # @return [::Google::Api::CommonLanguageSettings] + # Some settings. + # @!attribute [rw] renamed_services + # @return [::Google::Protobuf::Map{::String => ::String}] + # Map of service names to renamed services. Keys are the package relative + # service names and values are the name to be used for the service client + # and call options. + # + # Example: + # + # publishing: + # go_settings: + # renamed_services: + # Publisher: TopicAdmin + class GoSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # @!attribute [rw] key + # @return [::String] + # @!attribute [rw] value + # @return [::String] + class RenamedServicesEntry + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end + + # Describes the generator configuration for a method. + # @!attribute [rw] selector + # @return [::String] + # The fully qualified name of the method, for which the options below apply. + # This is used to find the method to apply the options. + # + # Example: + # + # publishing: + # method_settings: + # - selector: google.storage.control.v2.StorageControl.CreateFolder + # # method settings for CreateFolder... + # @!attribute [rw] long_running + # @return [::Google::Api::MethodSettings::LongRunning] + # Describes settings to use for long-running operations when generating + # API methods for RPCs. Complements RPCs that use the annotations in + # google/longrunning/operations.proto. + # + # Example of a YAML configuration:: + # + # publishing: + # method_settings: + # - selector: google.cloud.speech.v2.Speech.BatchRecognize + # long_running: + # initial_poll_delay: 60s # 1 minute + # poll_delay_multiplier: 1.5 + # max_poll_delay: 360s # 6 minutes + # total_poll_timeout: 54000s # 90 minutes + # @!attribute [rw] auto_populated_fields + # @return [::Array<::String>] + # List of top-level fields of the request message, that should be + # automatically populated by the client libraries based on their + # (google.api.field_info).format. Currently supported format: UUID4. + # + # Example of a YAML configuration: + # + # publishing: + # method_settings: + # - selector: google.example.v1.ExampleService.CreateExample + # auto_populated_fields: + # - request_id + # @!attribute [rw] batching + # @return [::Google::Api::BatchingConfigProto] + # Batching configuration for an API method in client libraries. + # + # Example of a YAML configuration: + # + # publishing: + # method_settings: + # - selector: google.example.v1.ExampleService.BatchCreateExample + # batching: + # element_count_threshold: 1000 + # request_byte_threshold: 100000000 + # delay_threshold_millis: 10 + class MethodSettings + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # Describes settings to use when generating API methods that use the + # long-running operation pattern. + # All default values below are from those used in the client library + # generators (e.g. + # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). + # @!attribute [rw] initial_poll_delay + # @return [::Google::Protobuf::Duration] + # Initial delay after which the first poll request will be made. + # Default value: 5 seconds. + # @!attribute [rw] poll_delay_multiplier + # @return [::Float] + # Multiplier to gradually increase delay between subsequent polls until it + # reaches max_poll_delay. + # Default value: 1.5. + # @!attribute [rw] max_poll_delay + # @return [::Google::Protobuf::Duration] + # Maximum time between two subsequent poll requests. + # Default value: 45 seconds. + # @!attribute [rw] total_poll_timeout + # @return [::Google::Protobuf::Duration] + # Total polling timeout. + # Default value: 5 minutes. + class LongRunning + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end + + # This message is used to configure the generation of a subset of the RPCs in + # a service for client libraries. + # + # Note: This feature should not be used in most cases. + # @!attribute [rw] methods + # @return [::Array<::String>] + # An allowlist of the fully qualified names of RPCs that should be included + # on public client surfaces. + # @!attribute [rw] generate_omitted_as_internal + # @return [::Boolean] + # Setting this to true indicates to the client generators that methods + # that would be excluded from the generation should instead be generated + # in a way that indicates these methods should not be consumed by + # end users. How this is expressed is up to individual language + # implementations to decide. Some examples may be: added annotations, + # obfuscated identifiers, or other language idiomatic patterns. + class SelectiveGapicGeneration + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # `BatchingConfigProto` defines the batching configuration for an API method. + # @!attribute [rw] thresholds + # @return [::Google::Api::BatchingSettingsProto] + # The thresholds which trigger a batched request to be sent. + # @!attribute [rw] batch_descriptor + # @return [::Google::Api::BatchingDescriptorProto] + # The request and response fields used in batching. + class BatchingConfigProto + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # `BatchingSettingsProto` specifies a set of batching thresholds, each of + # which acts as a trigger to send a batch of messages as a request. At least + # one threshold must be positive nonzero. + # @!attribute [rw] element_count_threshold + # @return [::Integer] + # The number of elements of a field collected into a batch which, if + # exceeded, causes the batch to be sent. + # @!attribute [rw] request_byte_threshold + # @return [::Integer] + # The aggregated size of the batched field which, if exceeded, causes the + # batch to be sent. This size is computed by aggregating the sizes of the + # request field to be batched, not of the entire request message. + # @!attribute [rw] delay_threshold + # @return [::Google::Protobuf::Duration] + # The duration after which a batch should be sent, starting from the addition + # of the first message to that batch. + # @!attribute [rw] element_count_limit + # @return [::Integer] + # The maximum number of elements collected in a batch that could be accepted + # by server. + # @!attribute [rw] request_byte_limit + # @return [::Integer] + # The maximum size of the request that could be accepted by server. + # @!attribute [rw] flow_control_element_limit + # @return [::Integer] + # The maximum number of elements allowed by flow control. + # @!attribute [rw] flow_control_byte_limit + # @return [::Integer] + # The maximum size of data allowed by flow control. + # @!attribute [rw] flow_control_limit_exceeded_behavior + # @return [::Google::Api::FlowControlLimitExceededBehaviorProto] + # The behavior to take when the flow control limit is exceeded. + class BatchingSettingsProto + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # `BatchingDescriptorProto` specifies the fields of the request message to be + # used for batching, and, optionally, the fields of the response message to be + # used for demultiplexing. + # @!attribute [rw] batched_field + # @return [::String] + # The repeated field in the request message to be aggregated by batching. + # @!attribute [rw] discriminator_fields + # @return [::Array<::String>] + # A list of the fields in the request message. Two requests will be batched + # together only if the values of every field specified in + # `request_discriminator_fields` is equal between the two requests. + # @!attribute [rw] subresponse_field + # @return [::String] + # Optional. When present, indicates the field in the response message to be + # used to demultiplex the response into multiple response messages, in + # correspondence with the multiple request messages originally batched + # together. + class BatchingDescriptorProto + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # The organization for which the client libraries are being published. + # Affects the url where generated docs are published, etc. + module ClientLibraryOrganization + # Not useful. + CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0 + + # Google Cloud Platform Org. + CLOUD = 1 + + # Ads (Advertising) Org. + ADS = 2 + + # Photos Org. + PHOTOS = 3 + + # Street View Org. + STREET_VIEW = 4 + + # Shopping Org. + SHOPPING = 5 + + # Geo Org. + GEO = 6 + + # Generative AI - https://developers.generativeai.google + GENERATIVE_AI = 7 + end + + # To where should client libraries be published? + module ClientLibraryDestination + # Client libraries will neither be generated nor published to package + # managers. + CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0 + + # Generate the client library in a repo under github.com/googleapis, + # but don't publish it to package managers. + GITHUB = 10 + + # Publish the library to package managers like nuget.org and npmjs.com. + PACKAGE_MANAGER = 20 + end + + # The behavior to take when the flow control limit is exceeded. + module FlowControlLimitExceededBehaviorProto + # Default behavior, system-defined. + UNSET_BEHAVIOR = 0 + + # Stop operation, raise error. + THROW_EXCEPTION = 1 + + # Pause operation until limit clears. + BLOCK = 2 + + # Continue operation, disregard limit. + IGNORE = 3 + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/field_behavior.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/field_behavior.rb new file mode 100644 index 000000000000..582be187d115 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/field_behavior.rb @@ -0,0 +1,85 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Api + # An indicator of the behavior of a given field (for example, that a field + # is required in requests, or given as output but ignored as input). + # This **does not** change the behavior in protocol buffers itself; it only + # denotes the behavior and may affect how API tooling handles the field. + # + # Note: This enum **may** receive new values in the future. + module FieldBehavior + # Conventional default for enums. Do not use this. + FIELD_BEHAVIOR_UNSPECIFIED = 0 + + # Specifically denotes a field as optional. + # While all fields in protocol buffers are optional, this may be specified + # for emphasis if appropriate. + OPTIONAL = 1 + + # Denotes a field as required. + # This indicates that the field **must** be provided as part of the request, + # and failure to do so will cause an error (usually `INVALID_ARGUMENT`). + REQUIRED = 2 + + # Denotes a field as output only. + # This indicates that the field is provided in responses, but including the + # field in a request does nothing (the server *must* ignore it and + # *must not* throw an error as a result of the field's presence). + OUTPUT_ONLY = 3 + + # Denotes a field as input only. + # This indicates that the field is provided in requests, and the + # corresponding field is not included in output. + INPUT_ONLY = 4 + + # Denotes a field as immutable. + # This indicates that the field may be set once in a request to create a + # resource, but may not be changed thereafter. + IMMUTABLE = 5 + + # Denotes that a (repeated) field is an unordered list. + # This indicates that the service may provide the elements of the list + # in any arbitrary order, rather than the order the user originally + # provided. Additionally, the list's order may or may not be stable. + UNORDERED_LIST = 6 + + # Denotes that this field returns a non-empty default value if not set. + # This indicates that if the user provides the empty value in a request, + # a non-empty value will be returned. The user will not be aware of what + # non-empty value to expect. + NON_EMPTY_DEFAULT = 7 + + # Denotes that the field in a resource (a message annotated with + # google.api.resource) is used in the resource name to uniquely identify the + # resource. For AIP-compliant APIs, this should only be applied to the + # `name` field on the resource. + # + # This behavior should not be applied to references to other resources within + # the message. + # + # The identifier field of resources often have different field behavior + # depending on the request it is embedded in (e.g. for Create methods name + # is optional and unused, while for Update methods it is required). Instead + # of method-specific annotations, only `IDENTIFIER` is required. + IDENTIFIER = 8 + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/launch_stage.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/launch_stage.rb new file mode 100644 index 000000000000..9392a413fb1b --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/launch_stage.rb @@ -0,0 +1,71 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Api + # The launch stage as defined by [Google Cloud Platform + # Launch Stages](https://cloud.google.com/terms/launch-stages). + module LaunchStage + # Do not use this default value. + LAUNCH_STAGE_UNSPECIFIED = 0 + + # The feature is not yet implemented. Users can not use it. + UNIMPLEMENTED = 6 + + # Prelaunch features are hidden from users and are only visible internally. + PRELAUNCH = 7 + + # Early Access features are limited to a closed group of testers. To use + # these features, you must sign up in advance and sign a Trusted Tester + # agreement (which includes confidentiality provisions). These features may + # be unstable, changed in backward-incompatible ways, and are not + # guaranteed to be released. + EARLY_ACCESS = 1 + + # Alpha is a limited availability test for releases before they are cleared + # for widespread use. By Alpha, all significant design issues are resolved + # and we are in the process of verifying functionality. Alpha customers + # need to apply for access, agree to applicable terms, and have their + # projects allowlisted. Alpha releases don't have to be feature complete, + # no SLAs are provided, and there are no technical support obligations, but + # they will be far enough along that customers can actually use them in + # test environments or for limited-use tests -- just like they would in + # normal production cases. + ALPHA = 2 + + # Beta is the point at which we are ready to open a release for any + # customer to use. There are no SLA or technical support obligations in a + # Beta release. Products will be complete from a feature perspective, but + # may have some open outstanding issues. Beta releases are suitable for + # limited production use cases. + BETA = 3 + + # GA features are open to all developers and are considered stable and + # fully qualified for production use. + GA = 4 + + # Deprecated features are scheduled to be shut down and removed. For more + # information, see the "Deprecation Policy" section of our [Terms of + # Service](https://cloud.google.com/terms/) + # and the [Google Cloud Platform Subject to the Deprecation + # Policy](https://cloud.google.com/terms/deprecation) documentation. + DEPRECATED = 5 + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/resource.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/resource.rb new file mode 100644 index 000000000000..25dec4847ac1 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/resource.rb @@ -0,0 +1,227 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Api + # A simple descriptor of a resource type. + # + # ResourceDescriptor annotates a resource message (either by means of a + # protobuf annotation or use in the service config), and associates the + # resource's schema, the resource type, and the pattern of the resource name. + # + # Example: + # + # message Topic { + # // Indicates this message defines a resource schema. + # // Declares the resource type in the format of {service}/{kind}. + # // For Kubernetes resources, the format is {api group}/{kind}. + # option (google.api.resource) = { + # type: "pubsub.googleapis.com/Topic" + # pattern: "projects/{project}/topics/{topic}" + # }; + # } + # + # The ResourceDescriptor Yaml config will look like: + # + # resources: + # - type: "pubsub.googleapis.com/Topic" + # pattern: "projects/{project}/topics/{topic}" + # + # Sometimes, resources have multiple patterns, typically because they can + # live under multiple parents. + # + # Example: + # + # message LogEntry { + # option (google.api.resource) = { + # type: "logging.googleapis.com/LogEntry" + # pattern: "projects/{project}/logs/{log}" + # pattern: "folders/{folder}/logs/{log}" + # pattern: "organizations/{organization}/logs/{log}" + # pattern: "billingAccounts/{billing_account}/logs/{log}" + # }; + # } + # + # The ResourceDescriptor Yaml config will look like: + # + # resources: + # - type: 'logging.googleapis.com/LogEntry' + # pattern: "projects/{project}/logs/{log}" + # pattern: "folders/{folder}/logs/{log}" + # pattern: "organizations/{organization}/logs/{log}" + # pattern: "billingAccounts/{billing_account}/logs/{log}" + # @!attribute [rw] type + # @return [::String] + # The resource type. It must be in the format of + # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be + # singular and must not include version numbers. + # + # Example: `storage.googleapis.com/Bucket` + # + # The value of the resource_type_kind must follow the regular expression + # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and + # should use PascalCase (UpperCamelCase). The maximum number of + # characters allowed for the `resource_type_kind` is 100. + # @!attribute [rw] pattern + # @return [::Array<::String>] + # Optional. The relative resource name pattern associated with this resource + # type. The DNS prefix of the full resource name shouldn't be specified here. + # + # The path pattern must follow the syntax, which aligns with HTTP binding + # syntax: + # + # Template = Segment { "/" Segment } ; + # Segment = LITERAL | Variable ; + # Variable = "{" LITERAL "}" ; + # + # Examples: + # + # - "projects/\\{project}/topics/\\{topic}" + # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}" + # + # The components in braces correspond to the IDs for each resource in the + # hierarchy. It is expected that, if multiple patterns are provided, + # the same component name (e.g. "project") refers to IDs of the same + # type of resource. + # @!attribute [rw] name_field + # @return [::String] + # Optional. The field on the resource that designates the resource name + # field. If omitted, this is assumed to be "name". + # @!attribute [rw] history + # @return [::Google::Api::ResourceDescriptor::History] + # Optional. The historical or future-looking state of the resource pattern. + # + # Example: + # + # // The InspectTemplate message originally only supported resource + # // names with organization, and project was added later. + # message InspectTemplate { + # option (google.api.resource) = { + # type: "dlp.googleapis.com/InspectTemplate" + # pattern: + # "organizations/{organization}/inspectTemplates/{inspect_template}" + # pattern: "projects/{project}/inspectTemplates/{inspect_template}" + # history: ORIGINALLY_SINGLE_PATTERN + # }; + # } + # @!attribute [rw] plural + # @return [::String] + # The plural name used in the resource name and permission names, such as + # 'projects' for the resource name of 'projects/\\{project}' and the permission + # name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception + # to this is for Nested Collections that have stuttering names, as defined + # in [AIP-122](https://google.aip.dev/122#nested-collections), where the + # collection ID in the resource name pattern does not necessarily directly + # match the `plural` value. + # + # It is the same concept of the `plural` field in k8s CRD spec + # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ + # + # Note: The plural form is required even for singleton resources. See + # https://aip.dev/156 + # @!attribute [rw] singular + # @return [::String] + # The same concept of the `singular` field in k8s CRD spec + # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ + # Such as "project" for the `resourcemanager.googleapis.com/Project` type. + # @!attribute [rw] style + # @return [::Array<::Google::Api::ResourceDescriptor::Style>] + # Style flag(s) for this resource. + # These indicate that a resource is expected to conform to a given + # style. See the specific style flags for additional information. + class ResourceDescriptor + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # A description of the historical or future-looking state of the + # resource pattern. + module History + # The "unset" value. + HISTORY_UNSPECIFIED = 0 + + # The resource originally had one pattern and launched as such, and + # additional patterns were added later. + ORIGINALLY_SINGLE_PATTERN = 1 + + # The resource has one pattern, but the API owner expects to add more + # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents + # that from being necessary once there are multiple patterns.) + FUTURE_MULTI_PATTERN = 2 + end + + # A flag representing a specific style that a resource claims to conform to. + module Style + # The unspecified value. Do not use. + STYLE_UNSPECIFIED = 0 + + # This resource is intended to be "declarative-friendly". + # + # Declarative-friendly resources must be more strictly consistent, and + # setting this to true communicates to tools that this resource should + # adhere to declarative-friendly expectations. + # + # Note: This is used by the API linter (linter.aip.dev) to enable + # additional checks. + DECLARATIVE_FRIENDLY = 1 + end + end + + # Defines a proto annotation that describes a string field that refers to + # an API resource. + # @!attribute [rw] type + # @return [::String] + # The resource type that the annotated field references. + # + # Example: + # + # message Subscription { + # string topic = 2 [(google.api.resource_reference) = { + # type: "pubsub.googleapis.com/Topic" + # }]; + # } + # + # Occasionally, a field may reference an arbitrary resource. In this case, + # APIs use the special value * in their resource reference. + # + # Example: + # + # message GetIamPolicyRequest { + # string resource = 2 [(google.api.resource_reference) = { + # type: "*" + # }]; + # } + # @!attribute [rw] child_type + # @return [::String] + # The resource type of a child collection that the annotated field + # references. This is useful for annotating the `parent` field that + # doesn't have a fixed resource type. + # + # Example: + # + # message ListLogEntriesRequest { + # string parent = 1 [(google.api.resource_reference) = { + # child_type: "logging.googleapis.com/LogEntry" + # }; + # } + class ResourceReference + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb new file mode 100644 index 000000000000..dd0b79ef3029 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb @@ -0,0 +1,393 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Developers + module DeveloperKnowledge + module V1 + # A Document represents a page of documentation in the Developer Knowledge + # corpus, like the page at + # https://docs.cloud.google.com/storage/docs/creating-buckets. + # @!attribute [rw] name + # @return [::String] + # Identifier. Contains the resource name of the document. + # Format: `documents/{uri_without_scheme}` + # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + # @!attribute [r] uri + # @return [::String] + # Output only. Provides the URI of the content, such as + # `docs.cloud.google.com/storage/docs/creating-buckets`. + # @!attribute [r] content + # @return [::String] + # Output only. Contains the full content of the document in Markdown format. + # @!attribute [r] description + # @return [::String] + # Output only. Provides a description of the document. + # @!attribute [r] data_source + # @return [::String] + # Output only. Specifies the data source of the document. + # Example data source: `firebase.google.com` + # @!attribute [r] title + # @return [::String] + # Output only. Provides the title of the document. + # @!attribute [r] update_time + # @return [::Google::Protobuf::Timestamp] + # Output only. Represents the timestamp when the content or metadata of the + # document was last updated. + # @!attribute [r] view + # @return [::Google::Developers::DeveloperKnowledge::V1::DocumentView] + # Output only. Specifies the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the + # document. + # @!attribute [r] content_length_bytes + # @return [::Integer] + # Output only. The length of the `content` field in bytes. + class Document + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Request message for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks}. + # @!attribute [rw] query + # @return [::String] + # Required. Provides the raw query string provided by the user, such as "How + # to create a Cloud Storage bucket?". The query must not exceed 500 + # characters; values longer than 500 characters will result in an + # `INVALID_ARGUMENT` error. + # @!attribute [rw] page_size + # @return [::Integer] + # Optional. Specifies the maximum number of results to return. The service + # may return fewer than this value. + # + # If unspecified, at most 5 results will be returned. + # + # The maximum value is 100; values above 100 will be coerced to 100. + # @!attribute [rw] page_token + # @return [::String] + # Optional. Contains a page token, received from a previous + # `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. + # @!attribute [rw] filter + # @return [::String] + # Optional. Applies a strict filter to the search results. The expression + # supports a subset of the syntax described at https://google.aip.dev/160. + # + # While `SearchDocumentChunks` returns + # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s, the filter + # is applied to `DocumentChunk.document` fields. + # + # Supported fields for filtering: + # + # * `content_length_bytes` (INTEGER): The length of the `Document.content` + # field in bytes. + # * `data_source` (STRING): The source of the document, e.g. + # `docs.cloud.google.com`. See + # https://developers.google.com/knowledge/reference/corpus-reference for + # the complete list of data sources in the corpus. + # * `update_time` (TIMESTAMP): The timestamp of when the document was last + # meaningfully updated. A meaningful update is one that changes document's + # markdown content or metadata. + # * `uri` (STRING): The document URI, e.g. + # `https://docs.cloud.google.com/bigquery/docs/tables`. + # + # INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. + # + # STRING fields support `=` (equals) and `!=` (not equals) operators for + # **exact match** on the whole string. Partial match, prefix match, and + # regexp match are not supported. + # + # TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. + # Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. + # + # Note: Field names must be in `snake_case` (e.g., `data_source`). Values on + # the right-hand side of filtering expressions must be string literals + # enclosed in double quotes (e.g., `"docs.cloud.google.com"`). + # + # You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical + # operators. `OR` has higher precedence than `AND`. Use parentheses for + # explicit precedence grouping. + # + # Examples: + # + # * Filter by `Document.content_length_bytes`: + # `content_length_bytes < 50000` + # * `data_source = "docs.cloud.google.com" OR data_source = + # "firebase.google.com"` + # * `data_source != "firebase.google.com"` + # * `update_time < "2024-01-01T00:00:00Z"` + # * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = + # "developer.chrome.com" OR data_source = "web.dev")` + # * `uri = "https://docs.cloud.google.com/release-notes"` + # + # The `filter` string must not exceed 500 characters; values longer than 500 + # characters will result in an `INVALID_ARGUMENT` error. + class SearchDocumentChunksRequest + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Response message for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks}. + # @!attribute [rw] results + # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] + # Contains the search results for the given query. Each + # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk} in this list + # contains a snippet of content relevant to the search query. Use the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk#parent DocumentChunk.parent} + # field of each result with + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # to retrieve the full document content. + # @!attribute [rw] next_page_token + # @return [::String] + # Provides a token that can be sent as `page_token` to retrieve the next + # page. + # If this field is omitted, there are no subsequent pages. + class SearchDocumentChunksResponse + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Request message for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument}. + # @!attribute [rw] name + # @return [::String] + # Required. Specifies the name of the document to retrieve. + # Format: `documents/{uri_without_scheme}` + # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + # + # The name must not exceed 500 characters; values longer than 500 characters + # will result in an `INVALID_ARGUMENT` error. + # @!attribute [rw] view + # @return [::Google::Developers::DeveloperKnowledge::V1::DocumentView] + # Optional. Specifies the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the + # document. If unspecified, + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # defaults to `DOCUMENT_VIEW_CONTENT`. + class GetDocumentRequest + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Request message for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments}. + # @!attribute [rw] names + # @return [::Array<::String>] + # Required. Specifies the names of the documents to retrieve. A maximum of 20 + # documents can be retrieved in a batch. The documents are returned in the + # same order as the `names` in the request. + # + # Format: `documents/{uri_without_scheme}` + # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + # + # Each name must not exceed 500 characters; values longer than 500 characters + # will result in an `INVALID_ARGUMENT` error. + # @!attribute [rw] view + # @return [::Google::Developers::DeveloperKnowledge::V1::DocumentView] + # Optional. Specifies the + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the + # document. If unspecified, + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # defaults to `DOCUMENT_VIEW_CONTENT`. + class BatchGetDocumentsRequest + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Response message for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments}. + # @!attribute [rw] documents + # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Document>] + # Contains the documents requested. + class BatchGetDocumentsResponse + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Request message for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query DeveloperKnowledge.AnswerQuery}. + # @!attribute [rw] query + # @return [::String] + # Required. The query to answer. + class AnswerQueryRequest + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Response message for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query DeveloperKnowledge.AnswerQuery}. + # @!attribute [rw] answer + # @return [::Google::Developers::DeveloperKnowledge::V1::Answer] + # The answer to the query. + class AnswerQueryResponse + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # An answer to a query. + # @!attribute [rw] answer_text + # @return [::String] + # Contains the text of the answer. + # @!attribute [r] citations + # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerCitation>] + # Output only. Contains citations for the answer. + # @!attribute [r] references + # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerReference>] + # Output only. Contains references for the answer. + class Answer + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + + # Citation info for a segment. + # @!attribute [r] start_index + # @return [::Integer] + # Output only. Indicates the start of the segment, measured in bytes (UTF-8 + # unicode), inclusive. If there are multi-byte characters, such as + # non-ASCII characters, the index measurement is longer than the string + # length. + # @!attribute [r] end_index + # @return [::Integer] + # Output only. Indicates the end of the segment, measured in bytes (UTF-8 + # unicode), exclusive. If there are multi-byte characters, such as + # non-ASCII characters, the index measurement is longer than the string + # length. + # @!attribute [r] sources + # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::CitationSource>] + # Output only. Contains citation sources for the attributed segment. + class AnswerCitation + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Citation source. + # @!attribute [r] reference_index + # @return [::Integer] + # Output only. Contains the index of the + # {::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerReference Answer.AnswerReference} + # in the `references` repeated field. + class CitationSource + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Represents a reference to a source. + # @!attribute [r] document_reference + # @return [::Google::Developers::DeveloperKnowledge::V1::Answer::DocumentReference] + # Output only. The reference document. + class AnswerReference + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Represents a reference to a document. + # @!attribute [r] document_chunk + # @return [::Google::Developers::DeveloperKnowledge::V1::DocumentChunk] + # Output only. Contains the document chunk. The `document_chunk.id` field + # is not set and will be empty. + class DocumentReference + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end + + # A DocumentChunk represents a piece of content from a + # {::Google::Developers::DeveloperKnowledge::V1::Document Document} in the DeveloperKnowledge + # corpus. To fetch the entire document content, pass the `parent` to + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments}. + # @!attribute [r] parent + # @return [::String] + # Output only. Contains the resource name of the document this chunk is from. + # Format: `documents/{uri_without_scheme}` + # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` + # @!attribute [r] id + # @return [::String] + # Output only. Specifies the ID of this chunk within the document. The chunk + # ID is unique within a document, but not globally unique across documents. + # The chunk ID is not stable and may change over time. + # @!attribute [r] content + # @return [::String] + # Output only. Contains the content of the document chunk. + # @!attribute [r] document + # @return [::Google::Developers::DeveloperKnowledge::V1::Document] + # Output only. Represents metadata about the + # {::Google::Developers::DeveloperKnowledge::V1::Document Document} this chunk is from. The + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of this + # {::Google::Developers::DeveloperKnowledge::V1::Document Document} message will be set to + # `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients + # do not need to call + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # if they only need the metadata fields. Otherwise, clients should use + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # or + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} + # to fetch the full document content. + # @!attribute [r] relevance_score + # @return [::Float] + # Output only. Represents the relevance score of the chunk to the search + # query. Higher score indicates higher chunk relevance. The score is in range + # [0.0, 1.0]. + class DocumentChunk + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Specifies which fields of the + # {::Google::Developers::DeveloperKnowledge::V1::Document Document} are included. + module DocumentView + # The default / unset value. See each API method for its default value if + # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} is not + # specified. + DOCUMENT_VIEW_UNSPECIFIED = 0 + + # Includes only the basic metadata fields: + # + # - `name` + # - `uri` + # - `data_source` + # - `title` + # - `description` + # - `update_time` + # - `view` + # - `content_length_bytes` + # + # This is the default of view for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks}. + DOCUMENT_VIEW_BASIC = 1 + + # Includes all {::Google::Developers::DeveloperKnowledge::V1::Document Document} fields. + DOCUMENT_VIEW_FULL = 2 + + # Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. + # + # This is the default of view for + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} + # and + # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments}. + DOCUMENT_VIEW_CONTENT = 3 + end + end + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/duration.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/duration.rb new file mode 100644 index 000000000000..ea59f1f91daf --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/duration.rb @@ -0,0 +1,98 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Protobuf + # A Duration represents a signed, fixed-length span of time represented + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". It is related to Timestamp in that the difference between + # two Timestamp values is a Duration and it can be added or subtracted + # from a Timestamp. Range is approximately +-10,000 years. + # + # # Examples + # + # Example 1: Compute Duration from two Timestamps in pseudo code. + # + # Timestamp start = ...; + # Timestamp end = ...; + # Duration duration = ...; + # + # duration.seconds = end.seconds - start.seconds; + # duration.nanos = end.nanos - start.nanos; + # + # if (duration.seconds < 0 && duration.nanos > 0) { + # duration.seconds += 1; + # duration.nanos -= 1000000000; + # } else if (duration.seconds > 0 && duration.nanos < 0) { + # duration.seconds -= 1; + # duration.nanos += 1000000000; + # } + # + # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. + # + # Timestamp start = ...; + # Duration duration = ...; + # Timestamp end = ...; + # + # end.seconds = start.seconds + duration.seconds; + # end.nanos = start.nanos + duration.nanos; + # + # if (end.nanos < 0) { + # end.seconds -= 1; + # end.nanos += 1000000000; + # } else if (end.nanos >= 1000000000) { + # end.seconds += 1; + # end.nanos -= 1000000000; + # } + # + # Example 3: Compute Duration from datetime.timedelta in Python. + # + # td = datetime.timedelta(days=3, minutes=10) + # duration = Duration() + # duration.FromTimedelta(td) + # + # # JSON Mapping + # + # In JSON format, the Duration type is encoded as a string rather than an + # object, where the string ends in the suffix "s" (indicating seconds) and + # is preceded by the number of seconds, with nanoseconds expressed as + # fractional seconds. For example, 3 seconds with 0 nanoseconds should be + # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should + # be expressed in JSON format as "3.000000001s", and 3 seconds and 1 + # microsecond should be expressed in JSON format as "3.000001s". + # @!attribute [rw] seconds + # @return [::Integer] + # Signed seconds of the span of time. Must be from -315,576,000,000 + # to +315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + # @!attribute [rw] nanos + # @return [::Integer] + # Signed fractions of a second at nanosecond resolution of the span + # of time. Durations less than one second are represented with a 0 + # `seconds` field and a positive or negative `nanos` field. For durations + # of one second or more, a non-zero value for the `nanos` field must be + # of the same sign as the `seconds` field. Must be from -999,999,999 + # to +999,999,999 inclusive. + class Duration + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/timestamp.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/timestamp.rb new file mode 100644 index 000000000000..e58202461f88 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/timestamp.rb @@ -0,0 +1,128 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + + +module Google + module Protobuf + # A Timestamp represents a point in time independent of any time zone or local + # calendar, encoded as a count of seconds and fractions of seconds at + # nanosecond resolution. The count is relative to an epoch at UTC midnight on + # January 1, 1970, in the proleptic Gregorian calendar which extends the + # Gregorian calendar backwards to year one. + # + # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap + # second table is needed for interpretation, using a [24-hour linear + # smear](https://developers.google.com/time/smear). + # + # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By + # restricting to that range, we ensure that we can convert to and from [RFC + # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + # + # # Examples + # + # Example 1: Compute Timestamp from POSIX `time()`. + # + # Timestamp timestamp; + # timestamp.set_seconds(time(NULL)); + # timestamp.set_nanos(0); + # + # Example 2: Compute Timestamp from POSIX `gettimeofday()`. + # + # struct timeval tv; + # gettimeofday(&tv, NULL); + # + # Timestamp timestamp; + # timestamp.set_seconds(tv.tv_sec); + # timestamp.set_nanos(tv.tv_usec * 1000); + # + # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. + # + # FILETIME ft; + # GetSystemTimeAsFileTime(&ft); + # UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; + # + # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z + # // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. + # Timestamp timestamp; + # timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); + # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); + # + # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. + # + # long millis = System.currentTimeMillis(); + # + # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) + # .setNanos((int) ((millis % 1000) * 1000000)).build(); + # + # Example 5: Compute Timestamp from Java `Instant.now()`. + # + # Instant now = Instant.now(); + # + # Timestamp timestamp = + # Timestamp.newBuilder().setSeconds(now.getEpochSecond()) + # .setNanos(now.getNano()).build(); + # + # Example 6: Compute Timestamp from current time in Python. + # + # timestamp = Timestamp() + # timestamp.GetCurrentTime() + # + # # JSON Mapping + # + # In JSON format, the Timestamp type is encoded as a string in the + # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the + # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z" + # where \\{year} is always expressed using four digits while \\{month}, \\{day}, + # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional + # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), + # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone + # is required. A proto3 JSON serializer should always use UTC (as indicated by + # "Z") when printing the Timestamp type and a proto3 JSON parser should be + # able to accept both UTC and other timezones (as indicated by an offset). + # + # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past + # 01:30 UTC on January 15, 2017. + # + # In JavaScript, one can convert a Date object to this format using the + # standard + # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) + # method. In Python, a standard `datetime.datetime` object can be converted + # to this format using + # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with + # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use + # the Joda Time's [`ISODateTimeFormat.dateTime()`]( + # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() + # ) to obtain a formatter capable of generating timestamps in this format. + # @!attribute [rw] seconds + # @return [::Integer] + # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must + # be between -315576000000 and 315576000000 inclusive (which corresponds to + # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z). + # @!attribute [rw] nanos + # @return [::Integer] + # Non-negative fractions of a second at nanosecond resolution. This field is + # the nanosecond portion of the duration, not an alternative to seconds. + # Negative second values with fractions must still have non-negative nanos + # values that count forward in time. Must be between 0 and 999,999,999 + # inclusive. + class Timestamp + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/Gemfile b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/Gemfile new file mode 100644 index 000000000000..c5326ddd4ac6 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/Gemfile @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +source "https://rubygems.org" + +if ENV["GOOGLE_CLOUD_SAMPLES_TEST"] == "master" + gem "google-developers-developer_knowledge-v1", path: "../" +else + gem "google-developers-developer_knowledge-v1" +end + +group :test do + gem "google-style", "~> 1.26.1" + gem "minitest", "~> 5.16" + gem "minitest-focus", "~> 1.1" + gem "minitest-hooks", "~> 1.5" +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/answer_query.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/answer_query.rb new file mode 100644 index 000000000000..1da8579829f3 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/answer_query.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +# [START developerknowledge_v1_generated_DeveloperKnowledge_AnswerQuery_sync] +require "google/developers/developer_knowledge/v1" + +## +# Snippet for the answer_query call in the DeveloperKnowledge service +# +# This snippet has been automatically generated and should be regarded as a code +# template only. It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in https://cloud.google.com/ruby/docs/reference. +# +# This is an auto-generated example demonstrating basic usage of +# Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query. +# +def answer_query + # Create a client object. The client can be reused for multiple calls. + client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + + # Create a request. To set request fields, pass in keyword arguments. + request = Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new + + # Call the answer_query method. + result = client.answer_query request + + # The returned object is of type Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse. + p result +end +# [END developerknowledge_v1_generated_DeveloperKnowledge_AnswerQuery_sync] diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/batch_get_documents.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/batch_get_documents.rb new file mode 100644 index 000000000000..6ea4b06d9af5 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/batch_get_documents.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +# [START developerknowledge_v1_generated_DeveloperKnowledge_BatchGetDocuments_sync] +require "google/developers/developer_knowledge/v1" + +## +# Snippet for the batch_get_documents call in the DeveloperKnowledge service +# +# This snippet has been automatically generated and should be regarded as a code +# template only. It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in https://cloud.google.com/ruby/docs/reference. +# +# This is an auto-generated example demonstrating basic usage of +# Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents. +# +def batch_get_documents + # Create a client object. The client can be reused for multiple calls. + client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + + # Create a request. To set request fields, pass in keyword arguments. + request = Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new + + # Call the batch_get_documents method. + result = client.batch_get_documents request + + # The returned object is of type Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse. + p result +end +# [END developerknowledge_v1_generated_DeveloperKnowledge_BatchGetDocuments_sync] diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/get_document.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/get_document.rb new file mode 100644 index 000000000000..8cee8fa202c9 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/get_document.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +# [START developerknowledge_v1_generated_DeveloperKnowledge_GetDocument_sync] +require "google/developers/developer_knowledge/v1" + +## +# Snippet for the get_document call in the DeveloperKnowledge service +# +# This snippet has been automatically generated and should be regarded as a code +# template only. It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in https://cloud.google.com/ruby/docs/reference. +# +# This is an auto-generated example demonstrating basic usage of +# Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document. +# +def get_document + # Create a client object. The client can be reused for multiple calls. + client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + + # Create a request. To set request fields, pass in keyword arguments. + request = Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new + + # Call the get_document method. + result = client.get_document request + + # The returned object is of type Google::Developers::DeveloperKnowledge::V1::Document. + p result +end +# [END developerknowledge_v1_generated_DeveloperKnowledge_GetDocument_sync] diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/search_document_chunks.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/search_document_chunks.rb new file mode 100644 index 000000000000..bccd09dd9fcf --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/search_document_chunks.rb @@ -0,0 +1,51 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +# [START developerknowledge_v1_generated_DeveloperKnowledge_SearchDocumentChunks_sync] +require "google/developers/developer_knowledge/v1" + +## +# Snippet for the search_document_chunks call in the DeveloperKnowledge service +# +# This snippet has been automatically generated and should be regarded as a code +# template only. It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in https://cloud.google.com/ruby/docs/reference. +# +# This is an auto-generated example demonstrating basic usage of +# Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks. +# +def search_document_chunks + # Create a client object. The client can be reused for multiple calls. + client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new + + # Create a request. To set request fields, pass in keyword arguments. + request = Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new + + # Call the search_document_chunks method. + result = client.search_document_chunks request + + # The returned object is of type Gapic::PagedEnumerable. You can iterate + # over elements, and API calls will be issued to fetch pages as needed. + result.each do |item| + # Each element is of type ::Google::Developers::DeveloperKnowledge::V1::DocumentChunk. + p item + end +end +# [END developerknowledge_v1_generated_DeveloperKnowledge_SearchDocumentChunks_sync] diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/snippet_metadata_google.developers.knowledge.v1.json b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/snippet_metadata_google.developers.knowledge.v1.json new file mode 100644 index 000000000000..9a973865b831 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/snippet_metadata_google.developers.knowledge.v1.json @@ -0,0 +1,175 @@ +{ + "client_library": { + "name": "google-developers-developer_knowledge-v1", + "version": "", + "language": "RUBY", + "apis": [ + { + "id": "google.developers.knowledge.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "region_tag": "developerknowledge_v1_generated_DeveloperKnowledge_SearchDocumentChunks_sync", + "title": "Snippet for the search_document_chunks call in the DeveloperKnowledge service", + "description": "This is an auto-generated example demonstrating basic usage of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks.", + "file": "developer_knowledge/search_document_chunks.rb", + "language": "RUBY", + "client_method": { + "short_name": "search_document_chunks", + "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks", + "async": false, + "parameters": [ + { + "type": "::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest", + "name": "request" + } + ], + "result_type": "::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse", + "client": { + "short_name": "DeveloperKnowledge::Client", + "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client" + }, + "method": { + "short_name": "SearchDocumentChunks", + "full_name": "google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks", + "service": { + "short_name": "DeveloperKnowledge", + "full_name": "google.developers.knowledge.v1.DeveloperKnowledge" + } + } + }, + "canonical": true, + "origin": "API_DEFINITION", + "segments": [ + { + "start": 20, + "end": 50, + "type": "FULL" + } + ] + }, + { + "region_tag": "developerknowledge_v1_generated_DeveloperKnowledge_GetDocument_sync", + "title": "Snippet for the get_document call in the DeveloperKnowledge service", + "description": "This is an auto-generated example demonstrating basic usage of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document.", + "file": "developer_knowledge/get_document.rb", + "language": "RUBY", + "client_method": { + "short_name": "get_document", + "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document", + "async": false, + "parameters": [ + { + "type": "::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest", + "name": "request" + } + ], + "result_type": "::Google::Developers::DeveloperKnowledge::V1::Document", + "client": { + "short_name": "DeveloperKnowledge::Client", + "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client" + }, + "method": { + "short_name": "GetDocument", + "full_name": "google.developers.knowledge.v1.DeveloperKnowledge.GetDocument", + "service": { + "short_name": "DeveloperKnowledge", + "full_name": "google.developers.knowledge.v1.DeveloperKnowledge" + } + } + }, + "canonical": true, + "origin": "API_DEFINITION", + "segments": [ + { + "start": 20, + "end": 46, + "type": "FULL" + } + ] + }, + { + "region_tag": "developerknowledge_v1_generated_DeveloperKnowledge_BatchGetDocuments_sync", + "title": "Snippet for the batch_get_documents call in the DeveloperKnowledge service", + "description": "This is an auto-generated example demonstrating basic usage of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents.", + "file": "developer_knowledge/batch_get_documents.rb", + "language": "RUBY", + "client_method": { + "short_name": "batch_get_documents", + "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents", + "async": false, + "parameters": [ + { + "type": "::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest", + "name": "request" + } + ], + "result_type": "::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse", + "client": { + "short_name": "DeveloperKnowledge::Client", + "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client" + }, + "method": { + "short_name": "BatchGetDocuments", + "full_name": "google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments", + "service": { + "short_name": "DeveloperKnowledge", + "full_name": "google.developers.knowledge.v1.DeveloperKnowledge" + } + } + }, + "canonical": true, + "origin": "API_DEFINITION", + "segments": [ + { + "start": 20, + "end": 46, + "type": "FULL" + } + ] + }, + { + "region_tag": "developerknowledge_v1_generated_DeveloperKnowledge_AnswerQuery_sync", + "title": "Snippet for the answer_query call in the DeveloperKnowledge service", + "description": "This is an auto-generated example demonstrating basic usage of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query.", + "file": "developer_knowledge/answer_query.rb", + "language": "RUBY", + "client_method": { + "short_name": "answer_query", + "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query", + "async": false, + "parameters": [ + { + "type": "::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest", + "name": "request" + } + ], + "result_type": "::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse", + "client": { + "short_name": "DeveloperKnowledge::Client", + "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client" + }, + "method": { + "short_name": "AnswerQuery", + "full_name": "google.developers.knowledge.v1.DeveloperKnowledge.AnswerQuery", + "service": { + "short_name": "DeveloperKnowledge", + "full_name": "google.developers.knowledge.v1.DeveloperKnowledge" + } + } + }, + "canonical": true, + "origin": "API_DEFINITION", + "segments": [ + { + "start": 20, + "end": 46, + "type": "FULL" + } + ] + } + ] +} \ No newline at end of file diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_paths_test.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_paths_test.rb new file mode 100644 index 000000000000..025870f575c3 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_paths_test.rb @@ -0,0 +1,55 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "helper" + +require "gapic/grpc/service_stub" + +require "google/developers/developer_knowledge/v1/developer_knowledge" + +class ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::ClientPathsTest < Minitest::Test + class DummyStub + def endpoint + "endpoint.example.com" + end + + def universe_domain + "example.com" + end + + def stub_logger + nil + end + + def logger + nil + end + end + + def test_document_path + grpc_channel = ::GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure + ::Gapic::ServiceStub.stub :new, DummyStub.new do + client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.credentials = grpc_channel + end + + path = client.document_path document: "value0" + assert_equal "documents/value0", path + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_rest_test.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_rest_test.rb new file mode 100644 index 000000000000..9521d08dc860 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_rest_test.rb @@ -0,0 +1,320 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "helper" +require "gapic/rest" +require "google/developers/knowledge/v1/developerknowledge_pb" +require "google/developers/developer_knowledge/v1/developer_knowledge/rest" + + +class ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ClientTest < Minitest::Test + class ClientStub + attr_accessor :call_count, :requests + + def initialize response, &block + @response = response + @block = block + @call_count = 0 + @requests = [] + end + + def make_get_request uri:, params: {}, options: {}, method_name: nil + make_http_request :get, uri: uri, body: nil, params: params, options: options, method_name: method_name + end + + def make_delete_request uri:, params: {}, options: {}, method_name: nil + make_http_request :delete, uri: uri, body: nil, params: params, options: options, method_name: method_name + end + + def make_post_request uri:, body: nil, params: {}, options: {}, method_name: nil + make_http_request :post, uri: uri, body: body, params: params, options: options, method_name: method_name + end + + def make_patch_request uri:, body:, params: {}, options: {}, method_name: nil + make_http_request :patch, uri: uri, body: body, params: params, options: options, method_name: method_name + end + + def make_put_request uri:, body:, params: {}, options: {}, method_name: nil + make_http_request :put, uri: uri, body: body, params: params, options: options, method_name: method_name + end + + def make_http_request *args, **kwargs + @call_count += 1 + + @requests << @block&.call(*args, **kwargs) + + @response + end + + def endpoint + "endpoint.example.com" + end + + def universe_domain + "example.com" + end + + def stub_logger + nil + end + + def logger + nil + end + end + + def test_search_document_chunks + # Create test objects. + client_result = ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse.new + http_response = OpenStruct.new body: client_result.to_json + + call_options = {} + + # Create request parameters for a unary method. + query = "hello world" + page_size = 42 + page_token = "hello world" + filter = "hello world" + + search_document_chunks_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:| + assert options.metadata.key? :"x-goog-api-client" + assert options.metadata[:"x-goog-api-client"].include? "rest" + refute options.metadata[:"x-goog-api-client"].include? "grpc" + end + + ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.stub :transcode_search_document_chunks_request, ["", "", {}] do + Gapic::Rest::ClientStub.stub :new, search_document_chunks_client_stub do + # Create client + c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| + config.credentials = :dummy_value + end + + # Use hash object + c.search_document_chunks({ query: query, page_size: page_size, page_token: page_token, filter: filter }) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use named arguments + c.search_document_chunks query: query, page_size: page_size, page_token: page_token, filter: filter do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use protobuf object + c.search_document_chunks ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new(query: query, page_size: page_size, page_token: page_token, filter: filter) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use hash object with options + c.search_document_chunks({ query: query, page_size: page_size, page_token: page_token, filter: filter }, call_options) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use protobuf object with options + c.search_document_chunks(::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new(query: query, page_size: page_size, page_token: page_token, filter: filter), call_options) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Verify method calls + assert_equal 5, search_document_chunks_client_stub.call_count + end + end + end + + def test_get_document + # Create test objects. + client_result = ::Google::Developers::DeveloperKnowledge::V1::Document.new + http_response = OpenStruct.new body: client_result.to_json + + call_options = {} + + # Create request parameters for a unary method. + name = "hello world" + view = :DOCUMENT_VIEW_UNSPECIFIED + + get_document_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:| + assert options.metadata.key? :"x-goog-api-client" + assert options.metadata[:"x-goog-api-client"].include? "rest" + refute options.metadata[:"x-goog-api-client"].include? "grpc" + end + + ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.stub :transcode_get_document_request, ["", "", {}] do + Gapic::Rest::ClientStub.stub :new, get_document_client_stub do + # Create client + c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| + config.credentials = :dummy_value + end + + # Use hash object + c.get_document({ name: name, view: view }) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use named arguments + c.get_document name: name, view: view do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use protobuf object + c.get_document ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new(name: name, view: view) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use hash object with options + c.get_document({ name: name, view: view }, call_options) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use protobuf object with options + c.get_document(::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new(name: name, view: view), call_options) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Verify method calls + assert_equal 5, get_document_client_stub.call_count + end + end + end + + def test_batch_get_documents + # Create test objects. + client_result = ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse.new + http_response = OpenStruct.new body: client_result.to_json + + call_options = {} + + # Create request parameters for a unary method. + names = ["hello world"] + view = :DOCUMENT_VIEW_UNSPECIFIED + + batch_get_documents_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:| + assert options.metadata.key? :"x-goog-api-client" + assert options.metadata[:"x-goog-api-client"].include? "rest" + refute options.metadata[:"x-goog-api-client"].include? "grpc" + end + + ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.stub :transcode_batch_get_documents_request, ["", "", {}] do + Gapic::Rest::ClientStub.stub :new, batch_get_documents_client_stub do + # Create client + c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| + config.credentials = :dummy_value + end + + # Use hash object + c.batch_get_documents({ names: names, view: view }) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use named arguments + c.batch_get_documents names: names, view: view do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use protobuf object + c.batch_get_documents ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new(names: names, view: view) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use hash object with options + c.batch_get_documents({ names: names, view: view }, call_options) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use protobuf object with options + c.batch_get_documents(::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new(names: names, view: view), call_options) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Verify method calls + assert_equal 5, batch_get_documents_client_stub.call_count + end + end + end + + def test_answer_query + # Create test objects. + client_result = ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.new + http_response = OpenStruct.new body: client_result.to_json + + call_options = {} + + # Create request parameters for a unary method. + query = "hello world" + + answer_query_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:| + assert options.metadata.key? :"x-goog-api-client" + assert options.metadata[:"x-goog-api-client"].include? "rest" + refute options.metadata[:"x-goog-api-client"].include? "grpc" + end + + ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.stub :transcode_answer_query_request, ["", "", {}] do + Gapic::Rest::ClientStub.stub :new, answer_query_client_stub do + # Create client + c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| + config.credentials = :dummy_value + end + + # Use hash object + c.answer_query({ query: query }) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use named arguments + c.answer_query query: query do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use protobuf object + c.answer_query ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new(query: query) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use hash object with options + c.answer_query({ query: query }, call_options) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Use protobuf object with options + c.answer_query(::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new(query: query), call_options) do |_result, response| + assert_equal http_response, response.underlying_op + end + + # Verify method calls + assert_equal 5, answer_query_client_stub.call_count + end + end + end + + def test_configure + credentials_token = :dummy_value + + client = block_config = config = nil + dummy_stub = ClientStub.new nil + Gapic::Rest::ClientStub.stub :new, dummy_stub do + client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| + config.credentials = credentials_token + end + end + + config = client.configure do |c| + block_config = c + end + + assert_same block_config, config + assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client::Configuration, config + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_test.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_test.rb new file mode 100644 index 000000000000..a43b73fefb45 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_test.rb @@ -0,0 +1,351 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +require "helper" + +require "gapic/grpc/service_stub" + +require "google/developers/knowledge/v1/developerknowledge_pb" +require "google/developers/developer_knowledge/v1/developer_knowledge" + +class ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::ClientTest < Minitest::Test + class ClientStub + attr_accessor :call_rpc_count, :requests + + def initialize response, operation, &block + @response = response + @operation = operation + @block = block + @call_rpc_count = 0 + @requests = [] + end + + def call_rpc *args, **kwargs + @call_rpc_count += 1 + + @requests << @block&.call(*args, **kwargs) + + catch :response do + yield @response, @operation if block_given? + @response + end + end + + def endpoint + "endpoint.example.com" + end + + def universe_domain + "example.com" + end + + def stub_logger + nil + end + + def logger + nil + end + end + + def test_search_document_chunks + # Create GRPC objects. + grpc_response = ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse.new + grpc_operation = GRPC::ActiveCall::Operation.new nil + grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure + grpc_options = {} + + # Create request parameters for a unary method. + query = "hello world" + page_size = 42 + page_token = "hello world" + filter = "hello world" + + search_document_chunks_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:| + assert_equal :search_document_chunks, name + assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest, request + assert_equal "hello world", request["query"] + assert_equal 42, request["page_size"] + assert_equal "hello world", request["page_token"] + assert_equal "hello world", request["filter"] + refute_nil options + end + + Gapic::ServiceStub.stub :new, search_document_chunks_client_stub do + # Create client + c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.credentials = grpc_channel + end + + # Use hash object + c.search_document_chunks({ query: query, page_size: page_size, page_token: page_token, filter: filter }) do |response, operation| + assert_kind_of Gapic::PagedEnumerable, response + assert_equal grpc_response, response.response + assert_equal grpc_operation, operation + end + + # Use named arguments + c.search_document_chunks query: query, page_size: page_size, page_token: page_token, filter: filter do |response, operation| + assert_kind_of Gapic::PagedEnumerable, response + assert_equal grpc_response, response.response + assert_equal grpc_operation, operation + end + + # Use protobuf object + c.search_document_chunks ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new(query: query, page_size: page_size, page_token: page_token, filter: filter) do |response, operation| + assert_kind_of Gapic::PagedEnumerable, response + assert_equal grpc_response, response.response + assert_equal grpc_operation, operation + end + + # Use hash object with options + c.search_document_chunks({ query: query, page_size: page_size, page_token: page_token, filter: filter }, grpc_options) do |response, operation| + assert_kind_of Gapic::PagedEnumerable, response + assert_equal grpc_response, response.response + assert_equal grpc_operation, operation + end + + # Use protobuf object with options + c.search_document_chunks(::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new(query: query, page_size: page_size, page_token: page_token, filter: filter), grpc_options) do |response, operation| + assert_kind_of Gapic::PagedEnumerable, response + assert_equal grpc_response, response.response + assert_equal grpc_operation, operation + end + + # Verify method calls + assert_equal 5, search_document_chunks_client_stub.call_rpc_count + end + end + + def test_get_document + # Create GRPC objects. + grpc_response = ::Google::Developers::DeveloperKnowledge::V1::Document.new + grpc_operation = GRPC::ActiveCall::Operation.new nil + grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure + grpc_options = {} + + # Create request parameters for a unary method. + name = "hello world" + view = :DOCUMENT_VIEW_UNSPECIFIED + + get_document_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:| + assert_equal :get_document, name + assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, request + assert_equal "hello world", request["name"] + assert_equal :DOCUMENT_VIEW_UNSPECIFIED, request["view"] + refute_nil options + end + + Gapic::ServiceStub.stub :new, get_document_client_stub do + # Create client + c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.credentials = grpc_channel + end + + # Use hash object + c.get_document({ name: name, view: view }) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use named arguments + c.get_document name: name, view: view do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use protobuf object + c.get_document ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new(name: name, view: view) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use hash object with options + c.get_document({ name: name, view: view }, grpc_options) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use protobuf object with options + c.get_document(::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new(name: name, view: view), grpc_options) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Verify method calls + assert_equal 5, get_document_client_stub.call_rpc_count + end + end + + def test_batch_get_documents + # Create GRPC objects. + grpc_response = ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse.new + grpc_operation = GRPC::ActiveCall::Operation.new nil + grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure + grpc_options = {} + + # Create request parameters for a unary method. + names = ["hello world"] + view = :DOCUMENT_VIEW_UNSPECIFIED + + batch_get_documents_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:| + assert_equal :batch_get_documents, name + assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, request + assert_equal ["hello world"], request["names"] + assert_equal :DOCUMENT_VIEW_UNSPECIFIED, request["view"] + refute_nil options + end + + Gapic::ServiceStub.stub :new, batch_get_documents_client_stub do + # Create client + c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.credentials = grpc_channel + end + + # Use hash object + c.batch_get_documents({ names: names, view: view }) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use named arguments + c.batch_get_documents names: names, view: view do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use protobuf object + c.batch_get_documents ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new(names: names, view: view) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use hash object with options + c.batch_get_documents({ names: names, view: view }, grpc_options) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use protobuf object with options + c.batch_get_documents(::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new(names: names, view: view), grpc_options) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Verify method calls + assert_equal 5, batch_get_documents_client_stub.call_rpc_count + end + end + + def test_answer_query + # Create GRPC objects. + grpc_response = ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.new + grpc_operation = GRPC::ActiveCall::Operation.new nil + grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure + grpc_options = {} + + # Create request parameters for a unary method. + query = "hello world" + + answer_query_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:| + assert_equal :answer_query, name + assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, request + assert_equal "hello world", request["query"] + refute_nil options + end + + Gapic::ServiceStub.stub :new, answer_query_client_stub do + # Create client + c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.credentials = grpc_channel + end + + # Use hash object + c.answer_query({ query: query }) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use named arguments + c.answer_query query: query do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use protobuf object + c.answer_query ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new(query: query) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use hash object with options + c.answer_query({ query: query }, grpc_options) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Use protobuf object with options + c.answer_query(::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new(query: query), grpc_options) do |response, operation| + assert_equal grpc_response, response + assert_equal grpc_operation, operation + end + + # Verify method calls + assert_equal 5, answer_query_client_stub.call_rpc_count + end + end + + def test_configure + grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure + + client = block_config = config = nil + dummy_stub = ClientStub.new nil, nil + Gapic::ServiceStub.stub :new, dummy_stub do + client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.credentials = grpc_channel + end + end + + config = client.configure do |c| + block_config = c + end + + assert_same block_config, config + assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client::Configuration, config + end + + def test_credentials + key = OpenSSL::PKey::RSA.new 2048 + cred_json = { + "private_key" => key.to_pem, + "client_email" => "app@developer.gserviceaccount.com", + "type" => "service_account" + } + key_file = StringIO.new cred_json.to_json + creds = Google::Auth::ServiceAccountCredentials.make_creds({ json_key_io: key_file }) + + dummy_stub = ClientStub.new nil, nil + Gapic::ServiceStub.stub :new, dummy_stub do + client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| + config.credentials = creds + end + assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client, client + assert_equal creds, client.configure.credentials + end + end +end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/test/helper.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/test/helper.rb new file mode 100644 index 000000000000..4fb6756ac7e2 --- /dev/null +++ b/owl-bot-staging/google-developers-developer_knowledge-v1/test/helper.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true + +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Auto-generated by gapic-generator-ruby. DO NOT EDIT! + +# Load JUnit XML formatter from googleapis/ruby-common-tools to write +# tmp/reports/sponge_log.xml for Kokoro/TestGrid build health tracking. +if ENV["CI"] || ENV["KOKORO_JOB_NAME"] + begin + require "gapic/minitest_junit_preloader" + rescue LoadError + end +end + +require "minitest/autorun" +require "minitest/focus" +require "minitest/mock" +require "minitest/rg" + +require "grpc" + +require "ostruct" From af0f244d0504da4375e7a63a37f6ff52da68b971 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Sat, 22 Aug 2026 17:59:45 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../knowledge/v1/developerknowledge_pb.rb | 2 +- .../knowledge/v1/developerknowledge.rb | 5 + .../.gitignore | 20 - .../.repo-metadata.json | 17 - .../.rubocop.yml | 33 - .../.toys.rb | 28 - .../.yardopts | 12 - .../AUTHENTICATION.md | 122 --- .../CHANGELOG.md | 2 - .../Gemfile | 15 - .../LICENSE.md | 201 ---- .../README.md | 153 ---- .../Rakefile | 169 ---- .../gapic_metadata.json | 38 - ...-developers-developer_knowledge-v1.gemspec | 28 - ...oogle-developers-developer_knowledge-v1.rb | 21 - .../developers/developer_knowledge/v1.rb | 45 - .../v1/developer_knowledge.rb | 70 -- .../v1/developer_knowledge/client.rb | 861 ------------------ .../v1/developer_knowledge/credentials.rb | 47 - .../v1/developer_knowledge/paths.rb | 47 - .../v1/developer_knowledge/rest.rb | 67 -- .../v1/developer_knowledge/rest/client.rb | 814 ----------------- .../developer_knowledge/rest/service_stub.rb | 320 ------- .../developers/developer_knowledge/v1/rest.rb | 37 - .../developer_knowledge/v1/version.rb | 28 - .../knowledge/v1/developerknowledge_pb.rb | 41 - .../v1/developerknowledge_services_pb.rb | 77 -- .../proto_docs/README.md | 4 - .../proto_docs/google/api/client.rb | 593 ------------ .../proto_docs/google/api/field_behavior.rb | 85 -- .../proto_docs/google/api/launch_stage.rb | 71 -- .../proto_docs/google/api/resource.rb | 227 ----- .../knowledge/v1/developerknowledge.rb | 393 -------- .../proto_docs/google/protobuf/duration.rb | 98 -- .../proto_docs/google/protobuf/timestamp.rb | 128 --- .../snippets/Gemfile | 32 - .../developer_knowledge/answer_query.rb | 47 - .../batch_get_documents.rb | 47 - .../developer_knowledge/get_document.rb | 47 - .../search_document_chunks.rb | 51 -- ...tadata_google.developers.knowledge.v1.json | 175 ---- .../v1/developer_knowledge_paths_test.rb | 55 -- .../v1/developer_knowledge_rest_test.rb | 320 ------- .../v1/developer_knowledge_test.rb | 351 ------- .../test/helper.rb | 35 - 46 files changed, 6 insertions(+), 6073 deletions(-) delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.gitignore delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.repo-metadata.json delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.rubocop.yml delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.toys.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/.yardopts delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/AUTHENTICATION.md delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/CHANGELOG.md delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/Gemfile delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/LICENSE.md delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/README.md delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/Rakefile delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/gapic_metadata.json delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/google-developers-developer_knowledge-v1.gemspec delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google-developers-developer_knowledge-v1.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/credentials.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/paths.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/rest.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/version.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/README.md delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/client.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/field_behavior.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/launch_stage.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/resource.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/duration.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/timestamp.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/Gemfile delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/answer_query.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/batch_get_documents.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/get_document.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/search_document_chunks.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/snippets/snippet_metadata_google.developers.knowledge.v1.json delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_paths_test.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_rest_test.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_test.rb delete mode 100644 owl-bot-staging/google-developers-developer_knowledge-v1/test/helper.rb diff --git a/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb b/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb index f245733bd83a..26518ed4f668 100644 --- a/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb +++ b/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb @@ -11,7 +11,7 @@ require 'google/protobuf/timestamp_pb' -descriptor_data = "\n7google/developers/knowledge/v1/developerknowledge.proto\x12\x1egoogle.developers.knowledge.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x83\x03\n\x08\x44ocument\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x10\n\x03uri\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x65scription\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x61ta_source\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x12\n\x05title\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12?\n\x04view\x18\x08 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x03\x12!\n\x14\x63ontent_length_bytes\x18\t \x01(\x05\x42\x03\xe0\x41\x03:Z\xea\x41W\n*developerknowledge.googleapis.com/Document\x12\x14\x64ocuments/{document}*\tdocuments2\x08\x64ocument\"w\n\x1bSearchDocumentChunksRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x04 \x01(\tB\x03\xe0\x41\x01\"w\n\x1cSearchDocumentChunksResponse\x12>\n\x07results\x18\x01 \x03(\x0b\x32-.google.developers.knowledge.v1.DocumentChunk\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\x97\x01\n\x12GetDocumentRequest\x12@\n\x04name\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"\x9e\x01\n\x18\x42\x61tchGetDocumentsRequest\x12\x41\n\x05names\x18\x01 \x03(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"X\n\x19\x42\x61tchGetDocumentsResponse\x12;\n\tdocuments\x18\x01 \x03(\x0b\x32(.google.developers.knowledge.v1.Document\"(\n\x12\x41nswerQueryRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\"M\n\x13\x41nswerQueryResponse\x12\x36\n\x06\x61nswer\x18\x01 \x01(\x0b\x32&.google.developers.knowledge.v1.Answer\"\xdb\x04\n\x06\x41nswer\x12\x13\n\x0b\x61nswer_text\x18\x01 \x01(\t\x12M\n\tcitations\x18\x02 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.AnswerCitationB\x03\xe0\x41\x03\x12O\n\nreferences\x18\x03 \x03(\x0b\x32\x36.google.developers.knowledge.v1.Answer.AnswerReferenceB\x03\xe0\x41\x03\x1a\x8f\x01\n\x0e\x41nswerCitation\x12\x18\n\x0bstart_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x12\x16\n\tend_index\x18\x02 \x01(\x05\x42\x03\xe0\x41\x03\x12K\n\x07sources\x18\x03 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.CitationSourceB\x03\xe0\x41\x03\x1a.\n\x0e\x43itationSource\x12\x1c\n\x0freference_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x1ay\n\x0f\x41nswerReference\x12[\n\x12\x64ocument_reference\x18\x01 \x01(\x0b\x32\x38.google.developers.knowledge.v1.Answer.DocumentReferenceB\x03\xe0\x41\x03H\x00\x42\t\n\x07\x63ontent\x1a_\n\x11\x44ocumentReference\x12J\n\x0e\x64ocument_chunk\x18\x01 \x01(\x0b\x32-.google.developers.knowledge.v1.DocumentChunkB\x03\xe0\x41\x03\"\xbb\x01\n\rDocumentChunk\x12\x42\n\x06parent\x18\x01 \x01(\tB2\xe0\x41\x03\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12\x0f\n\x02id\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12?\n\x08\x64ocument\x18\x04 \x01(\x0b\x32(.google.developers.knowledge.v1.DocumentB\x03\xe0\x41\x03*y\n\x0c\x44ocumentView\x12\x1d\n\x19\x44OCUMENT_VIEW_UNSPECIFIED\x10\x00\x12\x17\n\x13\x44OCUMENT_VIEW_BASIC\x10\x01\x12\x16\n\x12\x44OCUMENT_VIEW_FULL\x10\x02\x12\x19\n\x15\x44OCUMENT_VIEW_CONTENT\x10\x03\x32\x81\x06\n\x12\x44\x65veloperKnowledge\x12\xbd\x01\n\x14SearchDocumentChunks\x12;.google.developers.knowledge.v1.SearchDocumentChunksRequest\x1a<.google.developers.knowledge.v1.SearchDocumentChunksResponse\"*\x82\xd3\xe4\x93\x02$\x12\"/v1/documents:searchDocumentChunks\x12\x93\x01\n\x0bGetDocument\x12\x32.google.developers.knowledge.v1.GetDocumentRequest\x1a(.google.developers.knowledge.v1.Document\"&\xda\x41\x04name\x82\xd3\xe4\x93\x02\x19\x12\x17/v1/{name=documents/**}\x12\xa8\x01\n\x11\x42\x61tchGetDocuments\x12\x38.google.developers.knowledge.v1.BatchGetDocumentsRequest\x1a\x39.google.developers.knowledge.v1.BatchGetDocumentsResponse\"\x1e\x82\xd3\xe4\x93\x02\x18\x12\x16/v1/documents:batchGet\x12\x92\x01\n\x0b\x41nswerQuery\x12\x32.google.developers.knowledge.v1.AnswerQueryRequest\x1a\x33.google.developers.knowledge.v1.AnswerQueryResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1:answerQuery:\x01*\x1aU\xca\x41!developerknowledge.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x83\x02\n\"com.google.developers.knowledge.v1B\x17\x44\x65veloperKnowledgeProtoP\x01ZAcloud.google.com/go/developerknowledge/apiv1/developerknowledgepb\xaa\x02\'Google.Developers.DeveloperKnowledge.V1\xca\x02\'Google\\Developers\\DeveloperKnowledge\\V1\xea\x02*Google::Developers::DeveloperKnowledge::V1b\x06proto3" +descriptor_data = "\n7google/developers/knowledge/v1/developerknowledge.proto\x12\x1egoogle.developers.knowledge.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x83\x03\n\x08\x44ocument\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x10\n\x03uri\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x65scription\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x61ta_source\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x12\n\x05title\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12?\n\x04view\x18\x08 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x03\x12!\n\x14\x63ontent_length_bytes\x18\t \x01(\x05\x42\x03\xe0\x41\x03:Z\xea\x41W\n*developerknowledge.googleapis.com/Document\x12\x14\x64ocuments/{document}*\tdocuments2\x08\x64ocument\"w\n\x1bSearchDocumentChunksRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x04 \x01(\tB\x03\xe0\x41\x01\"w\n\x1cSearchDocumentChunksResponse\x12>\n\x07results\x18\x01 \x03(\x0b\x32-.google.developers.knowledge.v1.DocumentChunk\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\x97\x01\n\x12GetDocumentRequest\x12@\n\x04name\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"\x9e\x01\n\x18\x42\x61tchGetDocumentsRequest\x12\x41\n\x05names\x18\x01 \x03(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"X\n\x19\x42\x61tchGetDocumentsResponse\x12;\n\tdocuments\x18\x01 \x03(\x0b\x32(.google.developers.knowledge.v1.Document\"(\n\x12\x41nswerQueryRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\"M\n\x13\x41nswerQueryResponse\x12\x36\n\x06\x61nswer\x18\x01 \x01(\x0b\x32&.google.developers.knowledge.v1.Answer\"\xdb\x04\n\x06\x41nswer\x12\x13\n\x0b\x61nswer_text\x18\x01 \x01(\t\x12M\n\tcitations\x18\x02 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.AnswerCitationB\x03\xe0\x41\x03\x12O\n\nreferences\x18\x03 \x03(\x0b\x32\x36.google.developers.knowledge.v1.Answer.AnswerReferenceB\x03\xe0\x41\x03\x1a\x8f\x01\n\x0e\x41nswerCitation\x12\x18\n\x0bstart_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x12\x16\n\tend_index\x18\x02 \x01(\x05\x42\x03\xe0\x41\x03\x12K\n\x07sources\x18\x03 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.CitationSourceB\x03\xe0\x41\x03\x1a.\n\x0e\x43itationSource\x12\x1c\n\x0freference_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x1ay\n\x0f\x41nswerReference\x12[\n\x12\x64ocument_reference\x18\x01 \x01(\x0b\x32\x38.google.developers.knowledge.v1.Answer.DocumentReferenceB\x03\xe0\x41\x03H\x00\x42\t\n\x07\x63ontent\x1a_\n\x11\x44ocumentReference\x12J\n\x0e\x64ocument_chunk\x18\x01 \x01(\x0b\x32-.google.developers.knowledge.v1.DocumentChunkB\x03\xe0\x41\x03\"\xf2\x01\n\rDocumentChunk\x12\x42\n\x06parent\x18\x01 \x01(\tB2\xe0\x41\x03\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12\x0f\n\x02id\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12?\n\x08\x64ocument\x18\x04 \x01(\x0b\x32(.google.developers.knowledge.v1.DocumentB\x03\xe0\x41\x03\x12!\n\x0frelevance_score\x18\x05 \x01(\x01\x42\x03\xe0\x41\x03H\x00\x88\x01\x01\x42\x12\n\x10_relevance_score*y\n\x0c\x44ocumentView\x12\x1d\n\x19\x44OCUMENT_VIEW_UNSPECIFIED\x10\x00\x12\x17\n\x13\x44OCUMENT_VIEW_BASIC\x10\x01\x12\x16\n\x12\x44OCUMENT_VIEW_FULL\x10\x02\x12\x19\n\x15\x44OCUMENT_VIEW_CONTENT\x10\x03\x32\x81\x06\n\x12\x44\x65veloperKnowledge\x12\xbd\x01\n\x14SearchDocumentChunks\x12;.google.developers.knowledge.v1.SearchDocumentChunksRequest\x1a<.google.developers.knowledge.v1.SearchDocumentChunksResponse\"*\x82\xd3\xe4\x93\x02$\x12\"/v1/documents:searchDocumentChunks\x12\x93\x01\n\x0bGetDocument\x12\x32.google.developers.knowledge.v1.GetDocumentRequest\x1a(.google.developers.knowledge.v1.Document\"&\xda\x41\x04name\x82\xd3\xe4\x93\x02\x19\x12\x17/v1/{name=documents/**}\x12\xa8\x01\n\x11\x42\x61tchGetDocuments\x12\x38.google.developers.knowledge.v1.BatchGetDocumentsRequest\x1a\x39.google.developers.knowledge.v1.BatchGetDocumentsResponse\"\x1e\x82\xd3\xe4\x93\x02\x18\x12\x16/v1/documents:batchGet\x12\x92\x01\n\x0b\x41nswerQuery\x12\x32.google.developers.knowledge.v1.AnswerQueryRequest\x1a\x33.google.developers.knowledge.v1.AnswerQueryResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1:answerQuery:\x01*\x1aU\xca\x41!developerknowledge.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x83\x02\n\"com.google.developers.knowledge.v1B\x17\x44\x65veloperKnowledgeProtoP\x01ZAcloud.google.com/go/developerknowledge/apiv1/developerknowledgepb\xaa\x02\'Google.Developers.DeveloperKnowledge.V1\xca\x02\'Google\\Developers\\DeveloperKnowledge\\V1\xea\x02*Google::Developers::DeveloperKnowledge::V1b\x06proto3" pool = ::Google::Protobuf::DescriptorPool.generated_pool pool.add_serialized_file(descriptor_data) diff --git a/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb b/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb index 8b08ba1ec0e7..dd0b79ef3029 100644 --- a/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb +++ b/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb @@ -343,6 +343,11 @@ class DocumentReference # or # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} # to fetch the full document content. + # @!attribute [r] relevance_score + # @return [::Float] + # Output only. Represents the relevance score of the chunk to the search + # query. Higher score indicates higher chunk relevance. The score is in range + # [0.0, 1.0]. class DocumentChunk include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.gitignore b/owl-bot-staging/google-developers-developer_knowledge-v1/.gitignore deleted file mode 100644 index a2e97ac84259..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/.gitignore +++ /dev/null @@ -1,20 +0,0 @@ -gems.locked - -# Ignore documentation output -doc/* -.yardoc/* - -# Ignore test output -coverage/* - -# Ignore build artifacts -pkg/* - -# Ignore files commonly present in certain dev environments -.vagrant -.DS_STORE -.idea -*.iml - -# Ignore synth output -__pycache__ diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.repo-metadata.json b/owl-bot-staging/google-developers-developer_knowledge-v1/.repo-metadata.json deleted file mode 100644 index b76a2b576cdf..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/.repo-metadata.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "api_id": "developerknowledge.googleapis.com", - "api_shortname": "developerknowledge", - "client_documentation": "https://cloud.google.com/ruby/docs/reference/google-developers-developer_knowledge-v1/latest", - "distribution_name": "google-developers-developer_knowledge-v1", - "is_cloud": true, - "language": "ruby", - "name": "developerknowledge", - "name_pretty": "Developer Knowledge V1 API", - "product_documentation": "https://developers.google.com/knowledge", - "release_level": "unreleased", - "repo": "googleapis/google-cloud-ruby", - "requires_billing": true, - "ruby-cloud-description": "The Developer Knowledge API provides access to Google's developer knowledge. Note that google-developers-developer_knowledge-v1 is a version-specific client library. For most uses, we recommend installing the main client library google-developers-developer_knowledge instead. See the readme for more details.", - "ruby-cloud-product-url": "https://developers.google.com/knowledge", - "library_type": "GAPIC_AUTO" -} diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.rubocop.yml b/owl-bot-staging/google-developers-developer_knowledge-v1/.rubocop.yml deleted file mode 100644 index eca990fb3b4d..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/.rubocop.yml +++ /dev/null @@ -1,33 +0,0 @@ -inherit_gem: - google-style: google-style.yml - -AllCops: - Exclude: - - "google-developers-developer_knowledge-v1.gemspec" - - "lib/**/*_pb.rb" - - "proto_docs/**/*" - - "test/**/*" - - "acceptance/**/*" - - "samples/acceptance/**/*" - - "Rakefile" - -Layout/LineLength: - Enabled: false -Metrics/AbcSize: - Enabled: false -Metrics/ClassLength: - Enabled: false -Metrics/CyclomaticComplexity: - Enabled: false -Metrics/MethodLength: - Enabled: false -Metrics/ModuleLength: - Enabled: false -Metrics/PerceivedComplexity: - Enabled: false -Naming/AccessorMethodName: - Exclude: - - "snippets/**/*.rb" -Naming/FileName: - Exclude: - - "lib/google-developers-developer_knowledge-v1.rb" diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.toys.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/.toys.rb deleted file mode 100644 index 177e22456e8a..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/.toys.rb +++ /dev/null @@ -1,28 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -toys_version! ">= 0.15.3" - -if ENV["RUBY_COMMON_TOOLS"] - common_tools_dir = File.expand_path ENV["RUBY_COMMON_TOOLS"] - load File.join(common_tools_dir, "toys", "gapic") -else - load_git remote: "https://github.com/googleapis/ruby-common-tools.git", - path: "toys/gapic", - update: true -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/.yardopts b/owl-bot-staging/google-developers-developer_knowledge-v1/.yardopts deleted file mode 100644 index 029e31f7886d..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/.yardopts +++ /dev/null @@ -1,12 +0,0 @@ ---no-private ---title="Developer Knowledge V1 API" ---exclude _pb\.rb$ ---markup markdown ---markup-provider redcarpet - -./lib/**/*.rb -./proto_docs/**/*.rb -- -README.md -LICENSE.md -AUTHENTICATION.md diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/AUTHENTICATION.md b/owl-bot-staging/google-developers-developer_knowledge-v1/AUTHENTICATION.md deleted file mode 100644 index cb46050750cd..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/AUTHENTICATION.md +++ /dev/null @@ -1,122 +0,0 @@ -# Authentication - -The recommended way to authenticate to the google-developers-developer_knowledge-v1 library is to use -[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials). -To review all of your authentication options, see [Credentials lookup](#credential-lookup). - -## Quickstart - -The following example shows how to set up authentication for a local development -environment with your user credentials. - -**NOTE:** This method is _not_ recommended for running in production. User credentials -should be used only during development. - -1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk). -2. Set up a local ADC file with your user credentials: - -```sh -gcloud auth application-default login -``` - -3. Write code as if already authenticated. - -For more information about setting up authentication for a local development environment, see -[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev). - -## Credential Lookup - -The google-developers-developer_knowledge-v1 library provides several mechanisms to configure your system. -Generally, using Application Default Credentials to facilitate automatic -credentials discovery is the easist method. But if you need to explicitly specify -credentials, there are several methods available to you. - -Credentials are accepted in the following ways, in the following order or precedence: - -1. Credentials specified in method arguments -2. Credentials specified in configuration -3. Credentials pointed to or included in environment variables -4. Credentials found in local ADC file -5. Credentials returned by the metadata server for the attached service account (GCP) - -### Configuration - -You can configure a path to a JSON credentials file, either for an individual client object or -globally, for all client objects. The JSON file can contain credentials created for -[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation), -[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a -[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key). - -Note: Service account keys are a security risk if not managed correctly. You should -[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree) -whenever possible. - -To configure a credentials file for an individual client initialization: - -```ruby -require "google/developers/developer_knowledge/v1" - -client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.credentials = "path/to/credentialfile.json" -end -``` - -To configure a credentials file globally for all clients: - -```ruby -require "google/developers/developer_knowledge/v1" - -::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.configure do |config| - config.credentials = "path/to/credentialfile.json" -end - -client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new -``` - -### Environment Variables - -You can also use an environment variable to provide a JSON credentials file. -The environment variable can contain a path to the credentials file or, for -environments such as Docker containers where writing files is not encouraged, -you can include the credentials file itself. - -The JSON file can contain credentials created for -[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation), -[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a -[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key). - -Note: Service account keys are a security risk if not managed correctly. You should -[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree) -whenever possible. - -The environment variables that google-developers-developer_knowledge-v1 -checks for credentials are: - -* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents -* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file - -```ruby -require "google/developers/developer_knowledge/v1" - -ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json" - -client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new -``` - -### Local ADC file - -You can set up a local ADC file with your user credentials for authentication during -development. If credentials are not provided in code or in environment variables, -then the local ADC credentials are discovered. - -Follow the steps in [Quickstart](#quickstart) to set up a local ADC file. - -### Google Cloud Platform environments - -When running on Google Cloud Platform (GCP), including Google Compute Engine -(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud -Functions (GCF) and Cloud Run, credentials are retrieved from the attached -service account automatically. Code should be written as if already authenticated. - -For more information, see -[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa). diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/CHANGELOG.md b/owl-bot-staging/google-developers-developer_knowledge-v1/CHANGELOG.md deleted file mode 100644 index f88957a62ba2..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/CHANGELOG.md +++ /dev/null @@ -1,2 +0,0 @@ -# Release History - diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/Gemfile b/owl-bot-staging/google-developers-developer_knowledge-v1/Gemfile deleted file mode 100644 index 823c136ec3c0..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/Gemfile +++ /dev/null @@ -1,15 +0,0 @@ -source "https://rubygems.org" - -gemspec - -gem "google-style", "~> 1.32.0" -gem "irb", "~> 1.17" -gem "minitest", "~> 6.0.2" -gem "minitest-focus", "~> 1.4" -gem "minitest-mock", "~> 5.27" -gem "minitest-reporters", "~> 1.8.0", require: false -gem "minitest-rg", "~> 5.3" -gem "ostruct", "~> 0.5.5" -gem "rake", ">= 13.0" -gem "redcarpet", "~> 3.6" -gem "yard", "~> 0.9" diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/LICENSE.md b/owl-bot-staging/google-developers-developer_knowledge-v1/LICENSE.md deleted file mode 100644 index c261857ba6ad..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/LICENSE.md +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/README.md b/owl-bot-staging/google-developers-developer_knowledge-v1/README.md deleted file mode 100644 index b4b5340b19fc..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/README.md +++ /dev/null @@ -1,153 +0,0 @@ -# Ruby Client for the Developer Knowledge V1 API - -The Developer Knowledge API provides access to Google's developer knowledge. - - -https://github.com/googleapis/google-cloud-ruby - -This gem is a _versioned_ client. It provides basic client classes for a -specific version of the Developer Knowledge V1 API. Most users should consider using -the main client gem, -[google-developers-developer_knowledge](https://rubygems.org/gems/google-developers-developer_knowledge). -See the section below titled *Which client should I use?* for more information. - -## Installation - -``` -$ gem install google-developers-developer_knowledge-v1 -``` - -## Before You Begin - -In order to use this library, you first need to go through the following steps: - -1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project) -1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project) -1. [Enable the API.](https://console.cloud.google.com/apis/library/developerknowledge.googleapis.com) -1. [Set up authentication.](AUTHENTICATION.md) - -## Quick Start - -```ruby -require "google/developers/developer_knowledge/v1" - -client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new -request = ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new # (request fields as keyword arguments...) -response = client.search_document_chunks request -``` - -View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-developers-developer_knowledge-v1/latest) -for class and method documentation. - -See also the [Product Documentation](https://developers.google.com/knowledge) -for general usage information. - -## Debug Logging - -This library comes with opt-in Debug Logging that can help you troubleshoot -your application's integration with the API. When logging is activated, key -events such as requests and responses, along with data payloads and metadata -such as headers and client configuration, are logged to the standard error -stream. - -**WARNING:** Client Library Debug Logging includes your data payloads in -plaintext, which could include sensitive data such as PII for yourself or your -customers, private keys, or other security data that could be compromising if -leaked. Always practice good data hygiene with your application logs, and follow -the principle of least access. Google also recommends that Client Library Debug -Logging be enabled only temporarily during active debugging, and not used -permanently in production. - -To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS` -to the value `all`. Alternatively, you can set the value to a comma-delimited -list of client library gem names. This will select the default logging behavior, -which writes logs to the standard error stream. On a local workstation, this may -result in logs appearing on the console. When running on a Google Cloud hosting -service such as [Google Cloud Run](https://cloud.google.com/run), this generally -results in logs appearing alongside your application logs in the -[Google Cloud Logging](https://cloud.google.com/logging/) service. - -You can customize logging by modifying the `logger` configuration when -constructing a client object. For example: - -```ruby -require "google/developers/developer_knowledge/v1" -require "logger" - -client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.logger = Logger.new "my-app.log" -end -``` - -## Google Cloud Samples - -To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples). - -## Supported Ruby Versions - -This library is supported on Ruby 3.2+. - -Google provides official support for Ruby versions that are actively supported -by Ruby Core—that is, Ruby versions that are either in normal maintenance or -in security maintenance, and not end of life. Older versions of Ruby _may_ -still work, but are unsupported and not recommended. See -https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby -support schedule. - -## Which client should I use? - -Most modern Ruby client libraries for Google APIs come in two flavors: the main -client library with a name such as `google-developers-developer_knowledge`, -and lower-level _versioned_ client libraries with names such as -`google-developers-developer_knowledge-v1`. -_In most cases, you should install the main client._ - -### What's the difference between the main client and a versioned client? - -A _versioned client_ provides a basic set of data types and client classes for -a _single version_ of a specific service. (That is, for a service with multiple -versions, there might be a separate versioned client for each service version.) -Most versioned clients are written and maintained by a code generator. - -The _main client_ is designed to provide you with the _recommended_ client -interfaces for the service. There will be only one main client for any given -service, even a service with multiple versions. The main client includes -factory methods for constructing the client objects we recommend for most -users. In some cases, those will be classes provided by an underlying versioned -client; in other cases, they will be handwritten higher-level client objects -with additional capabilities, convenience methods, or best practices built in. -Generally, the main client will default to a recommended service version, -although in some cases you can override this if you need to talk to a specific -service version. - -### Why would I want to use the main client? - -We recommend that most users install the main client gem for a service. You can -identify this gem as the one _without_ a version in its name, e.g. -`google-developers-developer_knowledge`. -The main client is recommended because it will embody the best practices for -accessing the service, and may also provide more convenient interfaces or -tighter integration into frameworks and third-party libraries. In addition, the -documentation and samples published by Google will generally demonstrate use of -the main client. - -### Why would I want to use a versioned client? - -You can use a versioned client if you are content with a possibly lower-level -class interface, you explicitly want to avoid features provided by the main -client, or you want to access a specific service version not be covered by the -main client. You can identify versioned client gems because the service version -is part of the name, e.g. `google-developers-developer_knowledge-v1`. - -### What about the google-apis- clients? - -Client library gems with names that begin with `google-apis-` are based on an -older code generation technology. They talk to a REST/JSON backend (whereas -most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may -not offer the same performance, features, and ease of use provided by more -modern clients. - -The `google-apis-` clients have wide coverage across Google services, so you -might need to use one if there is no modern client available for the service. -However, if a modern client is available, we generally recommend it over the -older `google-apis-` clients. diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/Rakefile b/owl-bot-staging/google-developers-developer_knowledge-v1/Rakefile deleted file mode 100644 index ca756f3b2f8a..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/Rakefile +++ /dev/null @@ -1,169 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "bundler/setup" -require "bundler/gem_tasks" - -require "rubocop/rake_task" -RuboCop::RakeTask.new - -require "rake/testtask" -desc "Run tests." -Rake::TestTask.new do |t| - t.libs << "test" - t.test_files = FileList["test/**/*_test.rb"] - t.warning = false -end - -desc "Runs the smoke tests." -Rake::TestTask.new :smoke_test do |t| - t.test_files = FileList["acceptance/**/*smoke_test.rb"] - t.warning = false -end - -# Acceptance tests -desc "Run the google-developers-developer_knowledge-v1 acceptance tests." -task :acceptance, :project, :keyfile do |t, args| - project = args[:project] - project ||= - ENV["GOOGLE_CLOUD_TEST_PROJECT"] || - ENV["GCLOUD_TEST_PROJECT"] - keyfile = args[:keyfile] - keyfile ||= - ENV["GOOGLE_CLOUD_TEST_KEYFILE"] || - ENV["GCLOUD_TEST_KEYFILE"] - if keyfile - keyfile = File.read keyfile - else - keyfile ||= - ENV["GOOGLE_CLOUD_TEST_KEYFILE_JSON"] || - ENV["GCLOUD_TEST_KEYFILE_JSON"] - end - if project.nil? || keyfile.nil? - fail "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or GOOGLE_CLOUD_TEST_PROJECT=test123 GOOGLE_CLOUD_TEST_KEYFILE=/path/to/keyfile.json rake acceptance" - end - require "google/developers/developer_knowledge/v1/developer_knowledge/credentials" - ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Credentials.env_vars.each do |path| - ENV[path] = nil - end - ENV["GOOGLE_CLOUD_PROJECT"] = project - ENV["GOOGLE_CLOUD_TEST_PROJECT"] = project - ENV["GOOGLE_CLOUD_KEYFILE_JSON"] = keyfile - - Rake::Task["acceptance:run"].invoke -end - -namespace :acceptance do - task :run do - if File.directory? "acceptance" - Rake::Task[:smoke_test].invoke - else - puts "The google-developers-developer_knowledge-v1 gem has no acceptance tests." - end - end - - desc "Run acceptance cleanup." - task :cleanup do - end -end - -task :samples do - Rake::Task["samples:latest"].invoke -end - -namespace :samples do - task :latest do - if File.directory? "samples" - Dir.chdir "samples" do - Bundler.with_clean_env do - ENV["GOOGLE_CLOUD_SAMPLES_TEST"] = "not_master" - sh "bundle update" - sh "bundle exec rake test" - end - end - else - puts "The google-developers-developer_knowledge-v1 gem has no samples to test." - end - end - - task :master do - if File.directory? "samples" - Dir.chdir "samples" do - Bundler.with_clean_env do - ENV["GOOGLE_CLOUD_SAMPLES_TEST"] = "master" - sh "bundle update" - sh "bundle exec rake test" - end - end - else - puts "The google-developers-developer_knowledge-v1 gem has no samples to test." - end - end -end - -require "yard" -require "yard/rake/yardoc_task" -YARD::Rake::YardocTask.new do |y| - y.options << "--fail-on-warning" -end - -desc "Run yard-doctest example tests." -task :doctest do - puts "The google-developers-developer_knowledge-v1 gem does not have doctest tests." -end - -desc "Run the CI build" -task :ci do - header "BUILDING google-developers-developer_knowledge-v1" - header "google-developers-developer_knowledge-v1 rubocop", "*" - Rake::Task[:rubocop].invoke - header "google-developers-developer_knowledge-v1 yard", "*" - Rake::Task[:yard].invoke - header "google-developers-developer_knowledge-v1 test", "*" - Rake::Task[:test].invoke -end - -namespace :ci do - desc "Run the CI build, with smoke tests." - task :smoke_test do - Rake::Task[:ci].invoke - header "google-developers-developer_knowledge-v1 smoke_test", "*" - Rake::Task[:smoke_test].invoke - end - desc "Run the CI build, with acceptance tests." - task :acceptance do - Rake::Task[:ci].invoke - header "google-developers-developer_knowledge-v1 acceptance", "*" - Rake::Task[:acceptance].invoke - end - task :a do - # This is a handy shortcut to save typing - Rake::Task["ci:acceptance"].invoke - end -end - -task default: :test - -def header str, token = "#" - line_length = str.length + 8 - puts "" - puts token * line_length - puts "#{token * 3} #{str} #{token * 3}" - puts token * line_length - puts "" -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/gapic_metadata.json b/owl-bot-staging/google-developers-developer_knowledge-v1/gapic_metadata.json deleted file mode 100644 index 37fb4a1b5f6d..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/gapic_metadata.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "schema": "1.0", - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "ruby", - "protoPackage": "google.developers.knowledge.v1", - "libraryPackage": "::Google::Developers::DeveloperKnowledge::V1", - "services": { - "DeveloperKnowledge": { - "clients": { - "grpc": { - "libraryClient": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client", - "rpcs": { - "SearchDocumentChunks": { - "methods": [ - "search_document_chunks" - ] - }, - "GetDocument": { - "methods": [ - "get_document" - ] - }, - "BatchGetDocuments": { - "methods": [ - "batch_get_documents" - ] - }, - "AnswerQuery": { - "methods": [ - "answer_query" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/google-developers-developer_knowledge-v1.gemspec b/owl-bot-staging/google-developers-developer_knowledge-v1/google-developers-developer_knowledge-v1.gemspec deleted file mode 100644 index ff236befee57..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/google-developers-developer_knowledge-v1.gemspec +++ /dev/null @@ -1,28 +0,0 @@ -# -*- ruby -*- -# encoding: utf-8 - -require File.expand_path("lib/google/developers/developer_knowledge/v1/version", __dir__) - -Gem::Specification.new do |gem| - gem.name = "google-developers-developer_knowledge-v1" - gem.version = Google::Developers::DeveloperKnowledge::V1::VERSION - - gem.authors = ["Google LLC"] - gem.email = "googleapis-packages@google.com" - gem.description = "The Developer Knowledge API provides access to Google's developer knowledge. Note that google-developers-developer_knowledge-v1 is a version-specific client library. For most uses, we recommend installing the main client library google-developers-developer_knowledge instead. See the readme for more details." - gem.summary = "The Developer Knowledge API provides access to Google's developer knowledge." - gem.homepage = "https://github.com/googleapis/google-cloud-ruby" - gem.license = "Apache-2.0" - - gem.platform = Gem::Platform::RUBY - - gem.files = `git ls-files -- lib/*`.split("\n") + - `git ls-files -- proto_docs/*`.split("\n") + - ["README.md", "LICENSE.md", "AUTHENTICATION.md", ".yardopts"] - gem.require_paths = ["lib"] - - gem.required_ruby_version = ">= 3.2" - - gem.add_dependency "gapic-common", "~> 1.3" - gem.add_dependency "google-cloud-errors", "~> 1.0" -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google-developers-developer_knowledge-v1.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google-developers-developer_knowledge-v1.rb deleted file mode 100644 index b1e644ed99d8..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google-developers-developer_knowledge-v1.rb +++ /dev/null @@ -1,21 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -# This gem does not autoload during Bundler.require. To load this gem, -# issue explicit require statements for the packages desired, e.g.: -# require "google/developers/developer_knowledge/v1" diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1.rb deleted file mode 100644 index d9cee294ec23..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1.rb +++ /dev/null @@ -1,45 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "google/developers/developer_knowledge/v1/developer_knowledge" -require "google/developers/developer_knowledge/v1/version" - -module Google - module Developers - module DeveloperKnowledge - ## - # API client module. - # - # @example Load this package, including all its services, and instantiate a gRPC client - # - # require "google/developers/developer_knowledge/v1" - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - # - # @example Load this package, including all its services, and instantiate a REST client - # - # require "google/developers/developer_knowledge/v1" - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - module V1 - end - end - end -end - -helper_path = ::File.join __dir__, "v1", "_helpers.rb" -require "google/developers/developer_knowledge/v1/_helpers" if ::File.file? helper_path diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge.rb deleted file mode 100644 index e18de241d98e..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge.rb +++ /dev/null @@ -1,70 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "gapic/common" -require "gapic/config" -require "gapic/config/method" - -require "google/developers/developer_knowledge/v1/version" - -require "google/developers/developer_knowledge/v1/developer_knowledge/credentials" -require "google/developers/developer_knowledge/v1/developer_knowledge/paths" -require "google/developers/developer_knowledge/v1/developer_knowledge/client" -require "google/developers/developer_knowledge/v1/developer_knowledge/rest" - -module Google - module Developers - module DeveloperKnowledge - module V1 - ## - # The Developer Knowledge API provides programmatic access to Google's public - # developer documentation, enabling you to integrate this knowledge base into - # your own applications and workflows. - # - # The API is designed to be the canonical source for machine-readable access to - # Google's developer documentation. - # - # A typical use case is to first use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks} - # to find relevant page URIs based on a query, and then use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # to fetch the full content of the top results. - # - # All document content is provided in Markdown format. - # - # @example Load this service and instantiate a gRPC client - # - # require "google/developers/developer_knowledge/v1/developer_knowledge" - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - # - # @example Load this service and instantiate a REST client - # - # require "google/developers/developer_knowledge/v1/developer_knowledge/rest" - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - module DeveloperKnowledge - end - end - end - end -end - -helper_path = ::File.join __dir__, "developer_knowledge", "helpers.rb" -require "google/developers/developer_knowledge/v1/developer_knowledge/helpers" if ::File.file? helper_path diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb deleted file mode 100644 index 14fbd2c1ffca..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb +++ /dev/null @@ -1,861 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "google/cloud/errors" -require "google/developers/knowledge/v1/developerknowledge_pb" - -module Google - module Developers - module DeveloperKnowledge - module V1 - module DeveloperKnowledge - ## - # Client for the DeveloperKnowledge service. - # - # The Developer Knowledge API provides programmatic access to Google's public - # developer documentation, enabling you to integrate this knowledge base into - # your own applications and workflows. - # - # The API is designed to be the canonical source for machine-readable access to - # Google's developer documentation. - # - # A typical use case is to first use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks} - # to find relevant page URIs based on a query, and then use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # to fetch the full content of the top results. - # - # All document content is provided in Markdown format. - # - class Client - # @private - API_VERSION = "" - - # @private - DEFAULT_ENDPOINT_TEMPLATE = "developerknowledge.$UNIVERSE_DOMAIN$" - - include Paths - - # @private - attr_reader :developer_knowledge_stub - - ## - # Configure the DeveloperKnowledge Client class. - # - # See {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client::Configuration} - # for a description of the configuration fields. - # - # @example - # - # # Modify the configuration for all DeveloperKnowledge clients - # ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.configure do |config| - # config.timeout = 10.0 - # end - # - # @yield [config] Configure the Client client. - # @yieldparam config [Client::Configuration] - # - # @return [Client::Configuration] - # - def self.configure - @configure ||= begin - namespace = ["Google", "Developers", "DeveloperKnowledge", "V1"] - parent_config = while namespace.any? - parent_name = namespace.join "::" - parent_const = const_get parent_name - break parent_const.configure if parent_const.respond_to? :configure - namespace.pop - end - default_config = Client::Configuration.new parent_config - - default_config.rpcs.get_document.timeout = 60.0 - default_config.rpcs.get_document.retry_policy = { - initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] - } - - default_config.rpcs.batch_get_documents.timeout = 60.0 - default_config.rpcs.batch_get_documents.retry_policy = { - initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] - } - - default_config - end - yield @configure if block_given? - @configure - end - - ## - # Configure the DeveloperKnowledge Client instance. - # - # The configuration is set to the derived mode, meaning that values can be changed, - # but structural changes (adding new fields, etc.) are not allowed. Structural changes - # should be made on {Client.configure}. - # - # See {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client::Configuration} - # for a description of the configuration fields. - # - # @yield [config] Configure the Client client. - # @yieldparam config [Client::Configuration] - # - # @return [Client::Configuration] - # - def configure - yield @config if block_given? - @config - end - - ## - # The effective universe domain - # - # @return [String] - # - def universe_domain - @developer_knowledge_stub.universe_domain - end - - ## - # Create a new DeveloperKnowledge client object. - # - # @example - # - # # Create a client using the default configuration - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - # - # # Create a client using a custom configuration - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - # config.timeout = 10.0 - # end - # - # @yield [config] Configure the DeveloperKnowledge client. - # @yieldparam config [Client::Configuration] - # - def initialize - # These require statements are intentionally placed here to initialize - # the gRPC module only when it's required. - # See https://github.com/googleapis/toolkit/issues/446 - require "gapic/grpc" - require "google/developers/knowledge/v1/developerknowledge_services_pb" - - # Create the configuration object - @config = Configuration.new Client.configure - - # Yield the configuration if needed - yield @config if block_given? - - # Create credentials - credentials = @config.credentials - # Use self-signed JWT if the endpoint is unchanged from default, - # but only if the default endpoint does not have a region prefix. - enable_self_signed_jwt = @config.endpoint.nil? || - (@config.endpoint == Configuration::DEFAULT_ENDPOINT && - !@config.endpoint.split(".").first.include?("-")) - credentials ||= Credentials.default scope: @config.scope, - enable_self_signed_jwt: enable_self_signed_jwt - if credentials.is_a?(::String) || credentials.is_a?(::Hash) - credentials = Credentials.new credentials, scope: @config.scope - end - @quota_project_id = @config.quota_project - @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id - - @developer_knowledge_stub = ::Gapic::ServiceStub.new( - ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Stub, - credentials: credentials, - endpoint: @config.endpoint, - endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, - universe_domain: @config.universe_domain, - channel_args: @config.channel_args, - interceptors: @config.interceptors, - channel_pool_config: @config.channel_pool, - logger: @config.logger - ) - - @developer_knowledge_stub.stub_logger&.info do |entry| - entry.set_system_name - entry.set_service - entry.message = "Created client for #{entry.service}" - entry.set_credentials_fields credentials - entry.set "customEndpoint", @config.endpoint if @config.endpoint - entry.set "defaultTimeout", @config.timeout if @config.timeout - entry.set "quotaProject", @quota_project_id if @quota_project_id - end - end - - ## - # The logger used for request/response debug logging. - # - # @return [Logger] - # - def logger - @developer_knowledge_stub.logger - end - - # Service calls - - ## - # Searches for developer knowledge across Google's developer documentation. - # Returns {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s - # based on the user's query. There may be many chunks from the same - # {::Google::Developers::DeveloperKnowledge::V1::Document Document}. To retrieve full - # documents, use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # with the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk#parent DocumentChunk.parent} - # returned in the - # {::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse#results SearchDocumentChunksResponse.results}. - # - # @overload search_document_chunks(request, options = nil) - # Pass arguments to `search_document_chunks` via a request object, either of type - # {::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest} or an equivalent Hash. - # - # @param request [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest, ::Hash] - # A request object representing the call parameters. Required. To specify no - # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [::Gapic::CallOptions, ::Hash] - # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. - # - # @overload search_document_chunks(query: nil, page_size: nil, page_token: nil, filter: nil) - # Pass arguments to `search_document_chunks` via keyword arguments. Note that at - # least one keyword argument is required. To specify no parameters, or to keep all - # the default parameter values, pass an empty Hash as a request object (see above). - # - # @param query [::String] - # Required. Provides the raw query string provided by the user, such as "How - # to create a Cloud Storage bucket?". The query must not exceed 500 - # characters; values longer than 500 characters will result in an - # `INVALID_ARGUMENT` error. - # @param page_size [::Integer] - # Optional. Specifies the maximum number of results to return. The service - # may return fewer than this value. - # - # If unspecified, at most 5 results will be returned. - # - # The maximum value is 100; values above 100 will be coerced to 100. - # @param page_token [::String] - # Optional. Contains a page token, received from a previous - # `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. - # @param filter [::String] - # Optional. Applies a strict filter to the search results. The expression - # supports a subset of the syntax described at https://google.aip.dev/160. - # - # While `SearchDocumentChunks` returns - # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s, the filter - # is applied to `DocumentChunk.document` fields. - # - # Supported fields for filtering: - # - # * `content_length_bytes` (INTEGER): The length of the `Document.content` - # field in bytes. - # * `data_source` (STRING): The source of the document, e.g. - # `docs.cloud.google.com`. See - # https://developers.google.com/knowledge/reference/corpus-reference for - # the complete list of data sources in the corpus. - # * `update_time` (TIMESTAMP): The timestamp of when the document was last - # meaningfully updated. A meaningful update is one that changes document's - # markdown content or metadata. - # * `uri` (STRING): The document URI, e.g. - # `https://docs.cloud.google.com/bigquery/docs/tables`. - # - # INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. - # - # STRING fields support `=` (equals) and `!=` (not equals) operators for - # **exact match** on the whole string. Partial match, prefix match, and - # regexp match are not supported. - # - # TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. - # Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. - # - # Note: Field names must be in `snake_case` (e.g., `data_source`). Values on - # the right-hand side of filtering expressions must be string literals - # enclosed in double quotes (e.g., `"docs.cloud.google.com"`). - # - # You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical - # operators. `OR` has higher precedence than `AND`. Use parentheses for - # explicit precedence grouping. - # - # Examples: - # - # * Filter by `Document.content_length_bytes`: - # `content_length_bytes < 50000` - # * `data_source = "docs.cloud.google.com" OR data_source = - # "firebase.google.com"` - # * `data_source != "firebase.google.com"` - # * `update_time < "2024-01-01T00:00:00Z"` - # * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = - # "developer.chrome.com" OR data_source = "web.dev")` - # * `uri = "https://docs.cloud.google.com/release-notes"` - # - # The `filter` string must not exceed 500 characters; values longer than 500 - # characters will result in an `INVALID_ARGUMENT` error. - # - # @yield [response, operation] Access the result along with the RPC operation - # @yieldparam response [::Gapic::PagedEnumerable<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] - # @yieldparam operation [::GRPC::ActiveCall::Operation] - # - # @return [::Gapic::PagedEnumerable<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] - # - # @raise [::Google::Cloud::Error] if the RPC is aborted. - # - # @example Basic example - # require "google/developers/developer_knowledge/v1" - # - # # Create a client object. The client can be reused for multiple calls. - # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - # - # # Create a request. To set request fields, pass in keyword arguments. - # request = Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new - # - # # Call the search_document_chunks method. - # result = client.search_document_chunks request - # - # # The returned object is of type Gapic::PagedEnumerable. You can iterate - # # over elements, and API calls will be issued to fetch pages as needed. - # result.each do |item| - # # Each element is of type ::Google::Developers::DeveloperKnowledge::V1::DocumentChunk. - # p item - # end - # - def search_document_chunks request, options = nil - raise ::ArgumentError, "request must be provided" if request.nil? - - request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest - - # Converts hash and nil to an options object - options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h - - # Customize the options with defaults - metadata = @config.rpcs.search_document_chunks.metadata.to_h - - # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers - metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ - lib_name: @config.lib_name, lib_version: @config.lib_version, - gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION - metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? - metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - - options.apply_defaults timeout: @config.rpcs.search_document_chunks.timeout, - metadata: metadata, - retry_policy: @config.rpcs.search_document_chunks.retry_policy - - options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata, - retry_policy: @config.retry_policy - - @developer_knowledge_stub.call_rpc :search_document_chunks, request, options: options do |response, operation| - response = ::Gapic::PagedEnumerable.new @developer_knowledge_stub, :search_document_chunks, request, response, operation, options - yield response, operation if block_given? - throw :response, response - end - rescue ::GRPC::BadStatus => e - raise ::Google::Cloud::Error.from_error(e) - end - - ## - # Retrieves a single document with its full Markdown content. - # - # @overload get_document(request, options = nil) - # Pass arguments to `get_document` via a request object, either of type - # {::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest} or an equivalent Hash. - # - # @param request [::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, ::Hash] - # A request object representing the call parameters. Required. To specify no - # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [::Gapic::CallOptions, ::Hash] - # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. - # - # @overload get_document(name: nil, view: nil) - # Pass arguments to `get_document` via keyword arguments. Note that at - # least one keyword argument is required. To specify no parameters, or to keep all - # the default parameter values, pass an empty Hash as a request object (see above). - # - # @param name [::String] - # Required. Specifies the name of the document to retrieve. - # Format: `documents/{uri_without_scheme}` - # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - # - # The name must not exceed 500 characters; values longer than 500 characters - # will result in an `INVALID_ARGUMENT` error. - # @param view [::Google::Developers::DeveloperKnowledge::V1::DocumentView] - # Optional. Specifies the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the - # document. If unspecified, - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # defaults to `DOCUMENT_VIEW_CONTENT`. - # - # @yield [response, operation] Access the result along with the RPC operation - # @yieldparam response [::Google::Developers::DeveloperKnowledge::V1::Document] - # @yieldparam operation [::GRPC::ActiveCall::Operation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::Document] - # - # @raise [::Google::Cloud::Error] if the RPC is aborted. - # - # @example Basic example - # require "google/developers/developer_knowledge/v1" - # - # # Create a client object. The client can be reused for multiple calls. - # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - # - # # Create a request. To set request fields, pass in keyword arguments. - # request = Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new - # - # # Call the get_document method. - # result = client.get_document request - # - # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::Document. - # p result - # - def get_document request, options = nil - raise ::ArgumentError, "request must be provided" if request.nil? - - request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest - - # Converts hash and nil to an options object - options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h - - # Customize the options with defaults - metadata = @config.rpcs.get_document.metadata.to_h - - # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers - metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ - lib_name: @config.lib_name, lib_version: @config.lib_version, - gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION - metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? - metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - - header_params = {} - if request.name - header_params["name"] = request.name - end - - request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") - metadata[:"x-goog-request-params"] ||= request_params_header - - options.apply_defaults timeout: @config.rpcs.get_document.timeout, - metadata: metadata, - retry_policy: @config.rpcs.get_document.retry_policy - - options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata, - retry_policy: @config.retry_policy - - @developer_knowledge_stub.call_rpc :get_document, request, options: options do |response, operation| - yield response, operation if block_given? - end - rescue ::GRPC::BadStatus => e - raise ::Google::Cloud::Error.from_error(e) - end - - ## - # Retrieves multiple documents, each with its full Markdown content. - # - # @overload batch_get_documents(request, options = nil) - # Pass arguments to `batch_get_documents` via a request object, either of type - # {::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest} or an equivalent Hash. - # - # @param request [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, ::Hash] - # A request object representing the call parameters. Required. To specify no - # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [::Gapic::CallOptions, ::Hash] - # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. - # - # @overload batch_get_documents(names: nil, view: nil) - # Pass arguments to `batch_get_documents` via keyword arguments. Note that at - # least one keyword argument is required. To specify no parameters, or to keep all - # the default parameter values, pass an empty Hash as a request object (see above). - # - # @param names [::Array<::String>] - # Required. Specifies the names of the documents to retrieve. A maximum of 20 - # documents can be retrieved in a batch. The documents are returned in the - # same order as the `names` in the request. - # - # Format: `documents/{uri_without_scheme}` - # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - # - # Each name must not exceed 500 characters; values longer than 500 characters - # will result in an `INVALID_ARGUMENT` error. - # @param view [::Google::Developers::DeveloperKnowledge::V1::DocumentView] - # Optional. Specifies the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the - # document. If unspecified, - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # defaults to `DOCUMENT_VIEW_CONTENT`. - # - # @yield [response, operation] Access the result along with the RPC operation - # @yieldparam response [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] - # @yieldparam operation [::GRPC::ActiveCall::Operation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] - # - # @raise [::Google::Cloud::Error] if the RPC is aborted. - # - # @example Basic example - # require "google/developers/developer_knowledge/v1" - # - # # Create a client object. The client can be reused for multiple calls. - # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - # - # # Create a request. To set request fields, pass in keyword arguments. - # request = Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new - # - # # Call the batch_get_documents method. - # result = client.batch_get_documents request - # - # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse. - # p result - # - def batch_get_documents request, options = nil - raise ::ArgumentError, "request must be provided" if request.nil? - - request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest - - # Converts hash and nil to an options object - options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h - - # Customize the options with defaults - metadata = @config.rpcs.batch_get_documents.metadata.to_h - - # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers - metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ - lib_name: @config.lib_name, lib_version: @config.lib_version, - gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION - metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? - metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - - options.apply_defaults timeout: @config.rpcs.batch_get_documents.timeout, - metadata: metadata, - retry_policy: @config.rpcs.batch_get_documents.retry_policy - - options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata, - retry_policy: @config.retry_policy - - @developer_knowledge_stub.call_rpc :batch_get_documents, request, options: options do |response, operation| - yield response, operation if block_given? - end - rescue ::GRPC::BadStatus => e - raise ::Google::Cloud::Error.from_error(e) - end - - ## - # Answers a query using grounded generation. - # - # @overload answer_query(request, options = nil) - # Pass arguments to `answer_query` via a request object, either of type - # {::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest} or an equivalent Hash. - # - # @param request [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Hash] - # A request object representing the call parameters. Required. To specify no - # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [::Gapic::CallOptions, ::Hash] - # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. - # - # @overload answer_query(query: nil) - # Pass arguments to `answer_query` via keyword arguments. Note that at - # least one keyword argument is required. To specify no parameters, or to keep all - # the default parameter values, pass an empty Hash as a request object (see above). - # - # @param query [::String] - # Required. The query to answer. - # - # @yield [response, operation] Access the result along with the RPC operation - # @yieldparam response [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] - # @yieldparam operation [::GRPC::ActiveCall::Operation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] - # - # @raise [::Google::Cloud::Error] if the RPC is aborted. - # - # @example Basic example - # require "google/developers/developer_knowledge/v1" - # - # # Create a client object. The client can be reused for multiple calls. - # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - # - # # Create a request. To set request fields, pass in keyword arguments. - # request = Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new - # - # # Call the answer_query method. - # result = client.answer_query request - # - # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse. - # p result - # - def answer_query request, options = nil - raise ::ArgumentError, "request must be provided" if request.nil? - - request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest - - # Converts hash and nil to an options object - options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h - - # Customize the options with defaults - metadata = @config.rpcs.answer_query.metadata.to_h - - # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers - metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ - lib_name: @config.lib_name, lib_version: @config.lib_version, - gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION - metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? - metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - - options.apply_defaults timeout: @config.rpcs.answer_query.timeout, - metadata: metadata, - retry_policy: @config.rpcs.answer_query.retry_policy - - options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata, - retry_policy: @config.retry_policy - - @developer_knowledge_stub.call_rpc :answer_query, request, options: options do |response, operation| - yield response, operation if block_given? - end - rescue ::GRPC::BadStatus => e - raise ::Google::Cloud::Error.from_error(e) - end - - ## - # Configuration class for the DeveloperKnowledge API. - # - # This class represents the configuration for DeveloperKnowledge, - # providing control over timeouts, retry behavior, logging, transport - # parameters, and other low-level controls. Certain parameters can also be - # applied individually to specific RPCs. See - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client::Configuration::Rpcs} - # for a list of RPCs that can be configured independently. - # - # Configuration can be applied globally to all clients, or to a single client - # on construction. - # - # @example - # - # # Modify the global config, setting the timeout for - # # search_document_chunks to 20 seconds, - # # and all remaining timeouts to 10 seconds. - # ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.configure do |config| - # config.timeout = 10.0 - # config.rpcs.search_document_chunks.timeout = 20.0 - # end - # - # # Apply the above configuration only to a new client. - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - # config.timeout = 10.0 - # config.rpcs.search_document_chunks.timeout = 20.0 - # end - # - # @!attribute [rw] endpoint - # A custom service endpoint, as a hostname or hostname:port. The default is - # nil, indicating to use the default endpoint in the current universe domain. - # @return [::String,nil] - # @!attribute [rw] credentials - # Credentials to send with calls. You may provide any of the following types: - # * (`Google::Auth::Credentials`) A googleauth credentials object - # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) - # * (`Signet::OAuth2::Client`) A signet oauth2 client object - # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) - # * (`GRPC::Core::Channel`) a gRPC channel with included credentials - # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object - # * (`nil`) indicating no credentials - # - # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials - # is deprecated. Providing an unvalidated credential configuration to - # Google APIs can compromise the security of your systems and data. - # - # @example - # - # # The recommended way to provide credentials is to use the `make_creds` method - # # on the appropriate credentials class for your environment. - # - # require "googleauth" - # - # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds( - # json_key_io: ::File.open("/path/to/keyfile.json") - # ) - # - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - # config.credentials = credentials - # end - # - # @note Warning: If you accept a credential configuration (JSON file or Hash) from an - # external source for authentication to Google Cloud, you must validate it before - # providing it to a Google API client library. Providing an unvalidated credential - # configuration to Google APIs can compromise the security of your systems and data. - # For more information, refer to [Validate credential configurations from external - # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials). - # @return [::Object] - # @!attribute [rw] scope - # The OAuth scopes - # @return [::Array<::String>] - # @!attribute [rw] lib_name - # The library name as recorded in instrumentation and logging - # @return [::String] - # @!attribute [rw] lib_version - # The library version as recorded in instrumentation and logging - # @return [::String] - # @!attribute [rw] channel_args - # Extra parameters passed to the gRPC channel. Note: this is ignored if a - # `GRPC::Core::Channel` object is provided as the credential. - # @return [::Hash] - # @!attribute [rw] interceptors - # An array of interceptors that are run before calls are executed. - # @return [::Array<::GRPC::ClientInterceptor>] - # @!attribute [rw] timeout - # The call timeout in seconds. - # @return [::Numeric] - # @!attribute [rw] metadata - # Additional gRPC headers to be sent with the call. - # @return [::Hash{::Symbol=>::String}] - # @!attribute [rw] retry_policy - # The retry policy. The value is a hash with the following keys: - # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. - # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. - # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. - # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0. - # * `:retry_codes` (*type:* `Array`) - The error codes that should - # trigger a retry. - # @return [::Hash] - # @!attribute [rw] quota_project - # A separate project against which to charge quota. - # @return [::String] - # @!attribute [rw] universe_domain - # The universe domain within which to make requests. This determines the - # default endpoint URL. The default value of nil uses the environment - # universe (usually the default "googleapis.com" universe). - # @return [::String,nil] - # @!attribute [rw] logger - # A custom logger to use for request/response debug logging, or the value - # `:default` (the default) to construct a default logger, or `nil` to - # explicitly disable logging. - # @return [::Logger,:default,nil] - # - class Configuration - extend ::Gapic::Config - - # @private - # The endpoint specific to the default "googleapis.com" universe. Deprecated. - DEFAULT_ENDPOINT = "developerknowledge.googleapis.com" - - config_attr :endpoint, nil, ::String, nil - config_attr :credentials, nil do |value| - allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil] - allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel - allowed.any? { |klass| klass === value } - end - config_attr :scope, nil, ::String, ::Array, nil - config_attr :lib_name, nil, ::String, nil - config_attr :lib_version, nil, ::String, nil - config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) - config_attr :interceptors, nil, ::Array, nil - config_attr :timeout, nil, ::Numeric, nil - config_attr :metadata, nil, ::Hash, nil - config_attr :retry_policy, nil, ::Hash, ::Proc, nil - config_attr :quota_project, nil, ::String, nil - config_attr :universe_domain, nil, ::String, nil - config_attr :logger, :default, ::Logger, nil, :default - - # @private - def initialize parent_config = nil - @parent_config = parent_config unless parent_config.nil? - - yield self if block_given? - end - - ## - # Configurations for individual RPCs - # @return [Rpcs] - # - def rpcs - @rpcs ||= begin - parent_rpcs = nil - parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) - Rpcs.new parent_rpcs - end - end - - ## - # Configuration for the channel pool - # @return [::Gapic::ServiceStub::ChannelPool::Configuration] - # - def channel_pool - @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new - end - - ## - # Configuration RPC class for the DeveloperKnowledge API. - # - # Includes fields providing the configuration for each RPC in this service. - # Each configuration object is of type `Gapic::Config::Method` and includes - # the following configuration fields: - # - # * `timeout` (*type:* `Numeric`) - The call timeout in seconds - # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers - # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields - # include the following keys: - # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. - # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. - # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. - # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0. - # * `:retry_codes` (*type:* `Array`) - The error codes that should - # trigger a retry. - # - class Rpcs - ## - # RPC-specific configuration for `search_document_chunks` - # @return [::Gapic::Config::Method] - # - attr_reader :search_document_chunks - ## - # RPC-specific configuration for `get_document` - # @return [::Gapic::Config::Method] - # - attr_reader :get_document - ## - # RPC-specific configuration for `batch_get_documents` - # @return [::Gapic::Config::Method] - # - attr_reader :batch_get_documents - ## - # RPC-specific configuration for `answer_query` - # @return [::Gapic::Config::Method] - # - attr_reader :answer_query - - # @private - def initialize parent_rpcs = nil - search_document_chunks_config = parent_rpcs.search_document_chunks if parent_rpcs.respond_to? :search_document_chunks - @search_document_chunks = ::Gapic::Config::Method.new search_document_chunks_config - get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document - @get_document = ::Gapic::Config::Method.new get_document_config - batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents - @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config - answer_query_config = parent_rpcs.answer_query if parent_rpcs.respond_to? :answer_query - @answer_query = ::Gapic::Config::Method.new answer_query_config - - yield self if block_given? - end - end - end - end - end - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/credentials.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/credentials.rb deleted file mode 100644 index 4d6b73d55cf7..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/credentials.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "googleauth" - -module Google - module Developers - module DeveloperKnowledge - module V1 - module DeveloperKnowledge - # Credentials for the DeveloperKnowledge API. - class Credentials < ::Google::Auth::Credentials - self.scope = [ - "https://www.googleapis.com/auth/cloud-platform" - ] - self.env_vars = [ - "GOOGLE_CLOUD_CREDENTIALS", - "GOOGLE_CLOUD_KEYFILE", - "GCLOUD_KEYFILE", - "GOOGLE_CLOUD_CREDENTIALS_JSON", - "GOOGLE_CLOUD_KEYFILE_JSON", - "GCLOUD_KEYFILE_JSON" - ] - self.paths = [ - "~/.config/google_cloud/application_default_credentials.json" - ] - end - end - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/paths.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/paths.rb deleted file mode 100644 index 6389c8f3c5e6..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/paths.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Developers - module DeveloperKnowledge - module V1 - module DeveloperKnowledge - # Path helper methods for the DeveloperKnowledge API. - module Paths - ## - # Create a fully-qualified Document resource string. - # - # The resource will be in the following format: - # - # `documents/{document}` - # - # @param document [String] - # - # @return [::String] - def document_path document: - "documents/#{document}" - end - - extend self - end - end - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest.rb deleted file mode 100644 index 6b7630f75bd6..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest.rb +++ /dev/null @@ -1,67 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "gapic/rest" -require "gapic/config" -require "gapic/config/method" - -require "google/developers/developer_knowledge/v1/version" - -require "google/developers/developer_knowledge/v1/developer_knowledge/credentials" -require "google/developers/developer_knowledge/v1/developer_knowledge/paths" -require "google/developers/developer_knowledge/v1/developer_knowledge/rest/client" - -module Google - module Developers - module DeveloperKnowledge - module V1 - ## - # The Developer Knowledge API provides programmatic access to Google's public - # developer documentation, enabling you to integrate this knowledge base into - # your own applications and workflows. - # - # The API is designed to be the canonical source for machine-readable access to - # Google's developer documentation. - # - # A typical use case is to first use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks} - # to find relevant page URIs based on a query, and then use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # to fetch the full content of the top results. - # - # All document content is provided in Markdown format. - # - # To load this service and instantiate a REST client: - # - # require "google/developers/developer_knowledge/v1/developer_knowledge/rest" - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - module DeveloperKnowledge - # Client for the REST transport - module Rest - end - end - end - end - end -end - -helper_path = ::File.join __dir__, "rest", "helpers.rb" -require "google/developers/developer_knowledge/v1/developer_knowledge/rest/helpers" if ::File.file? helper_path diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb deleted file mode 100644 index 22d73f37ff82..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb +++ /dev/null @@ -1,814 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "google/cloud/errors" -require "google/developers/knowledge/v1/developerknowledge_pb" -require "google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub" - -module Google - module Developers - module DeveloperKnowledge - module V1 - module DeveloperKnowledge - module Rest - ## - # REST client for the DeveloperKnowledge service. - # - # The Developer Knowledge API provides programmatic access to Google's public - # developer documentation, enabling you to integrate this knowledge base into - # your own applications and workflows. - # - # The API is designed to be the canonical source for machine-readable access to - # Google's developer documentation. - # - # A typical use case is to first use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks} - # to find relevant page URIs based on a query, and then use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # to fetch the full content of the top results. - # - # All document content is provided in Markdown format. - # - class Client - # @private - API_VERSION = "" - - # @private - DEFAULT_ENDPOINT_TEMPLATE = "developerknowledge.$UNIVERSE_DOMAIN$" - - include Paths - - # @private - attr_reader :developer_knowledge_stub - - ## - # Configure the DeveloperKnowledge Client class. - # - # See {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client::Configuration} - # for a description of the configuration fields. - # - # @example - # - # # Modify the configuration for all DeveloperKnowledge clients - # ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.configure do |config| - # config.timeout = 10.0 - # end - # - # @yield [config] Configure the Client client. - # @yieldparam config [Client::Configuration] - # - # @return [Client::Configuration] - # - def self.configure - @configure ||= begin - namespace = ["Google", "Developers", "DeveloperKnowledge", "V1"] - parent_config = while namespace.any? - parent_name = namespace.join "::" - parent_const = const_get parent_name - break parent_const.configure if parent_const.respond_to? :configure - namespace.pop - end - default_config = Client::Configuration.new parent_config - - default_config.rpcs.get_document.timeout = 60.0 - default_config.rpcs.get_document.retry_policy = { - initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] - } - - default_config.rpcs.batch_get_documents.timeout = 60.0 - default_config.rpcs.batch_get_documents.retry_policy = { - initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] - } - - default_config - end - yield @configure if block_given? - @configure - end - - ## - # Configure the DeveloperKnowledge Client instance. - # - # The configuration is set to the derived mode, meaning that values can be changed, - # but structural changes (adding new fields, etc.) are not allowed. Structural changes - # should be made on {Client.configure}. - # - # See {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client::Configuration} - # for a description of the configuration fields. - # - # @yield [config] Configure the Client client. - # @yieldparam config [Client::Configuration] - # - # @return [Client::Configuration] - # - def configure - yield @config if block_given? - @config - end - - ## - # The effective universe domain - # - # @return [String] - # - def universe_domain - @developer_knowledge_stub.universe_domain - end - - ## - # Create a new DeveloperKnowledge REST client object. - # - # @example - # - # # Create a client using the default configuration - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - # # Create a client using a custom configuration - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| - # config.timeout = 10.0 - # end - # - # @yield [config] Configure the DeveloperKnowledge client. - # @yieldparam config [Client::Configuration] - # - def initialize - # Create the configuration object - @config = Configuration.new Client.configure - - # Yield the configuration if needed - yield @config if block_given? - - # Create credentials - credentials = @config.credentials - # Use self-signed JWT if the endpoint is unchanged from default, - # but only if the default endpoint does not have a region prefix. - enable_self_signed_jwt = @config.endpoint.nil? || - (@config.endpoint == Configuration::DEFAULT_ENDPOINT && - !@config.endpoint.split(".").first.include?("-")) - credentials ||= Credentials.default scope: @config.scope, - enable_self_signed_jwt: enable_self_signed_jwt - if credentials.is_a?(::String) || credentials.is_a?(::Hash) - credentials = Credentials.new credentials, scope: @config.scope - end - - @quota_project_id = @config.quota_project - @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id - - @developer_knowledge_stub = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.new( - endpoint: @config.endpoint, - endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, - universe_domain: @config.universe_domain, - credentials: credentials, - logger: @config.logger - ) - - @developer_knowledge_stub.logger(stub: true)&.info do |entry| - entry.set_system_name - entry.set_service - entry.message = "Created client for #{entry.service}" - entry.set_credentials_fields credentials - entry.set "customEndpoint", @config.endpoint if @config.endpoint - entry.set "defaultTimeout", @config.timeout if @config.timeout - entry.set "quotaProject", @quota_project_id if @quota_project_id - end - end - - ## - # The logger used for request/response debug logging. - # - # @return [Logger] - # - def logger - @developer_knowledge_stub.logger - end - - # Service calls - - ## - # Searches for developer knowledge across Google's developer documentation. - # Returns {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s - # based on the user's query. There may be many chunks from the same - # {::Google::Developers::DeveloperKnowledge::V1::Document Document}. To retrieve full - # documents, use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # with the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk#parent DocumentChunk.parent} - # returned in the - # {::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse#results SearchDocumentChunksResponse.results}. - # - # @overload search_document_chunks(request, options = nil) - # Pass arguments to `search_document_chunks` via a request object, either of type - # {::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest} or an equivalent Hash. - # - # @param request [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest, ::Hash] - # A request object representing the call parameters. Required. To specify no - # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [::Gapic::CallOptions, ::Hash] - # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # - # @overload search_document_chunks(query: nil, page_size: nil, page_token: nil, filter: nil) - # Pass arguments to `search_document_chunks` via keyword arguments. Note that at - # least one keyword argument is required. To specify no parameters, or to keep all - # the default parameter values, pass an empty Hash as a request object (see above). - # - # @param query [::String] - # Required. Provides the raw query string provided by the user, such as "How - # to create a Cloud Storage bucket?". The query must not exceed 500 - # characters; values longer than 500 characters will result in an - # `INVALID_ARGUMENT` error. - # @param page_size [::Integer] - # Optional. Specifies the maximum number of results to return. The service - # may return fewer than this value. - # - # If unspecified, at most 5 results will be returned. - # - # The maximum value is 100; values above 100 will be coerced to 100. - # @param page_token [::String] - # Optional. Contains a page token, received from a previous - # `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. - # @param filter [::String] - # Optional. Applies a strict filter to the search results. The expression - # supports a subset of the syntax described at https://google.aip.dev/160. - # - # While `SearchDocumentChunks` returns - # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s, the filter - # is applied to `DocumentChunk.document` fields. - # - # Supported fields for filtering: - # - # * `content_length_bytes` (INTEGER): The length of the `Document.content` - # field in bytes. - # * `data_source` (STRING): The source of the document, e.g. - # `docs.cloud.google.com`. See - # https://developers.google.com/knowledge/reference/corpus-reference for - # the complete list of data sources in the corpus. - # * `update_time` (TIMESTAMP): The timestamp of when the document was last - # meaningfully updated. A meaningful update is one that changes document's - # markdown content or metadata. - # * `uri` (STRING): The document URI, e.g. - # `https://docs.cloud.google.com/bigquery/docs/tables`. - # - # INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. - # - # STRING fields support `=` (equals) and `!=` (not equals) operators for - # **exact match** on the whole string. Partial match, prefix match, and - # regexp match are not supported. - # - # TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. - # Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. - # - # Note: Field names must be in `snake_case` (e.g., `data_source`). Values on - # the right-hand side of filtering expressions must be string literals - # enclosed in double quotes (e.g., `"docs.cloud.google.com"`). - # - # You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical - # operators. `OR` has higher precedence than `AND`. Use parentheses for - # explicit precedence grouping. - # - # Examples: - # - # * Filter by `Document.content_length_bytes`: - # `content_length_bytes < 50000` - # * `data_source = "docs.cloud.google.com" OR data_source = - # "firebase.google.com"` - # * `data_source != "firebase.google.com"` - # * `update_time < "2024-01-01T00:00:00Z"` - # * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = - # "developer.chrome.com" OR data_source = "web.dev")` - # * `uri = "https://docs.cloud.google.com/release-notes"` - # - # The `filter` string must not exceed 500 characters; values longer than 500 - # characters will result in an `INVALID_ARGUMENT` error. - # @yield [result, operation] Access the result along with the TransportOperation object - # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] - # @yieldparam operation [::Gapic::Rest::TransportOperation] - # - # @return [::Gapic::Rest::PagedEnumerable<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] - # - # @raise [::Google::Cloud::Error] if the REST call is aborted. - # - # @example Basic example - # require "google/developers/developer_knowledge/v1" - # - # # Create a client object. The client can be reused for multiple calls. - # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - # # Create a request. To set request fields, pass in keyword arguments. - # request = Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new - # - # # Call the search_document_chunks method. - # result = client.search_document_chunks request - # - # # The returned object is of type Gapic::PagedEnumerable. You can iterate - # # over elements, and API calls will be issued to fetch pages as needed. - # result.each do |item| - # # Each element is of type ::Google::Developers::DeveloperKnowledge::V1::DocumentChunk. - # p item - # end - # - def search_document_chunks request, options = nil - raise ::ArgumentError, "request must be provided" if request.nil? - - request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest - - # Converts hash and nil to an options object - options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h - - # Customize the options with defaults - call_metadata = @config.rpcs.search_document_chunks.metadata.to_h - - # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers - call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ - lib_name: @config.lib_name, lib_version: @config.lib_version, - gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION, - transports_version_send: [:rest] - - call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? - call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - - options.apply_defaults timeout: @config.rpcs.search_document_chunks.timeout, - metadata: call_metadata, - retry_policy: @config.rpcs.search_document_chunks.retry_policy - - options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata, - retry_policy: @config.retry_policy - - @developer_knowledge_stub.search_document_chunks request, options do |result, operation| - result = ::Gapic::Rest::PagedEnumerable.new @developer_knowledge_stub, :search_document_chunks, "results", request, result, options - yield result, operation if block_given? - throw :response, result - end - rescue ::Gapic::Rest::Error => e - raise ::Google::Cloud::Error.from_error(e) - end - - ## - # Retrieves a single document with its full Markdown content. - # - # @overload get_document(request, options = nil) - # Pass arguments to `get_document` via a request object, either of type - # {::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest} or an equivalent Hash. - # - # @param request [::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, ::Hash] - # A request object representing the call parameters. Required. To specify no - # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [::Gapic::CallOptions, ::Hash] - # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # - # @overload get_document(name: nil, view: nil) - # Pass arguments to `get_document` via keyword arguments. Note that at - # least one keyword argument is required. To specify no parameters, or to keep all - # the default parameter values, pass an empty Hash as a request object (see above). - # - # @param name [::String] - # Required. Specifies the name of the document to retrieve. - # Format: `documents/{uri_without_scheme}` - # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - # - # The name must not exceed 500 characters; values longer than 500 characters - # will result in an `INVALID_ARGUMENT` error. - # @param view [::Google::Developers::DeveloperKnowledge::V1::DocumentView] - # Optional. Specifies the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the - # document. If unspecified, - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#get_document DeveloperKnowledge.GetDocument} - # defaults to `DOCUMENT_VIEW_CONTENT`. - # @yield [result, operation] Access the result along with the TransportOperation object - # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::Document] - # @yieldparam operation [::Gapic::Rest::TransportOperation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::Document] - # - # @raise [::Google::Cloud::Error] if the REST call is aborted. - # - # @example Basic example - # require "google/developers/developer_knowledge/v1" - # - # # Create a client object. The client can be reused for multiple calls. - # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - # # Create a request. To set request fields, pass in keyword arguments. - # request = Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new - # - # # Call the get_document method. - # result = client.get_document request - # - # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::Document. - # p result - # - def get_document request, options = nil - raise ::ArgumentError, "request must be provided" if request.nil? - - request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest - - # Converts hash and nil to an options object - options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h - - # Customize the options with defaults - call_metadata = @config.rpcs.get_document.metadata.to_h - - # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers - call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ - lib_name: @config.lib_name, lib_version: @config.lib_version, - gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION, - transports_version_send: [:rest] - - call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? - call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - - options.apply_defaults timeout: @config.rpcs.get_document.timeout, - metadata: call_metadata, - retry_policy: @config.rpcs.get_document.retry_policy - - options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata, - retry_policy: @config.retry_policy - - @developer_knowledge_stub.get_document request, options do |result, operation| - yield result, operation if block_given? - end - rescue ::Gapic::Rest::Error => e - raise ::Google::Cloud::Error.from_error(e) - end - - ## - # Retrieves multiple documents, each with its full Markdown content. - # - # @overload batch_get_documents(request, options = nil) - # Pass arguments to `batch_get_documents` via a request object, either of type - # {::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest} or an equivalent Hash. - # - # @param request [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, ::Hash] - # A request object representing the call parameters. Required. To specify no - # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [::Gapic::CallOptions, ::Hash] - # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # - # @overload batch_get_documents(names: nil, view: nil) - # Pass arguments to `batch_get_documents` via keyword arguments. Note that at - # least one keyword argument is required. To specify no parameters, or to keep all - # the default parameter values, pass an empty Hash as a request object (see above). - # - # @param names [::Array<::String>] - # Required. Specifies the names of the documents to retrieve. A maximum of 20 - # documents can be retrieved in a batch. The documents are returned in the - # same order as the `names` in the request. - # - # Format: `documents/{uri_without_scheme}` - # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - # - # Each name must not exceed 500 characters; values longer than 500 characters - # will result in an `INVALID_ARGUMENT` error. - # @param view [::Google::Developers::DeveloperKnowledge::V1::DocumentView] - # Optional. Specifies the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the - # document. If unspecified, - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # defaults to `DOCUMENT_VIEW_CONTENT`. - # @yield [result, operation] Access the result along with the TransportOperation object - # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] - # @yieldparam operation [::Gapic::Rest::TransportOperation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] - # - # @raise [::Google::Cloud::Error] if the REST call is aborted. - # - # @example Basic example - # require "google/developers/developer_knowledge/v1" - # - # # Create a client object. The client can be reused for multiple calls. - # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - # # Create a request. To set request fields, pass in keyword arguments. - # request = Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new - # - # # Call the batch_get_documents method. - # result = client.batch_get_documents request - # - # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse. - # p result - # - def batch_get_documents request, options = nil - raise ::ArgumentError, "request must be provided" if request.nil? - - request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest - - # Converts hash and nil to an options object - options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h - - # Customize the options with defaults - call_metadata = @config.rpcs.batch_get_documents.metadata.to_h - - # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers - call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ - lib_name: @config.lib_name, lib_version: @config.lib_version, - gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION, - transports_version_send: [:rest] - - call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? - call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - - options.apply_defaults timeout: @config.rpcs.batch_get_documents.timeout, - metadata: call_metadata, - retry_policy: @config.rpcs.batch_get_documents.retry_policy - - options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata, - retry_policy: @config.retry_policy - - @developer_knowledge_stub.batch_get_documents request, options do |result, operation| - yield result, operation if block_given? - end - rescue ::Gapic::Rest::Error => e - raise ::Google::Cloud::Error.from_error(e) - end - - ## - # Answers a query using grounded generation. - # - # @overload answer_query(request, options = nil) - # Pass arguments to `answer_query` via a request object, either of type - # {::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest} or an equivalent Hash. - # - # @param request [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Hash] - # A request object representing the call parameters. Required. To specify no - # parameters, or to keep all the default parameter values, pass an empty Hash. - # @param options [::Gapic::CallOptions, ::Hash] - # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # - # @overload answer_query(query: nil) - # Pass arguments to `answer_query` via keyword arguments. Note that at - # least one keyword argument is required. To specify no parameters, or to keep all - # the default parameter values, pass an empty Hash as a request object (see above). - # - # @param query [::String] - # Required. The query to answer. - # @yield [result, operation] Access the result along with the TransportOperation object - # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] - # @yieldparam operation [::Gapic::Rest::TransportOperation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] - # - # @raise [::Google::Cloud::Error] if the REST call is aborted. - # - # @example Basic example - # require "google/developers/developer_knowledge/v1" - # - # # Create a client object. The client can be reused for multiple calls. - # client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - # # Create a request. To set request fields, pass in keyword arguments. - # request = Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new - # - # # Call the answer_query method. - # result = client.answer_query request - # - # # The returned object is of type Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse. - # p result - # - def answer_query request, options = nil - raise ::ArgumentError, "request must be provided" if request.nil? - - request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest - - # Converts hash and nil to an options object - options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h - - # Customize the options with defaults - call_metadata = @config.rpcs.answer_query.metadata.to_h - - # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers - call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ - lib_name: @config.lib_name, lib_version: @config.lib_version, - gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION, - transports_version_send: [:rest] - - call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? - call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - - options.apply_defaults timeout: @config.rpcs.answer_query.timeout, - metadata: call_metadata, - retry_policy: @config.rpcs.answer_query.retry_policy - - options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata, - retry_policy: @config.retry_policy - - @developer_knowledge_stub.answer_query request, options do |result, operation| - yield result, operation if block_given? - end - rescue ::Gapic::Rest::Error => e - raise ::Google::Cloud::Error.from_error(e) - end - - ## - # Configuration class for the DeveloperKnowledge REST API. - # - # This class represents the configuration for DeveloperKnowledge REST, - # providing control over timeouts, retry behavior, logging, transport - # parameters, and other low-level controls. Certain parameters can also be - # applied individually to specific RPCs. See - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client::Configuration::Rpcs} - # for a list of RPCs that can be configured independently. - # - # Configuration can be applied globally to all clients, or to a single client - # on construction. - # - # @example - # - # # Modify the global config, setting the timeout for - # # search_document_chunks to 20 seconds, - # # and all remaining timeouts to 10 seconds. - # ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.configure do |config| - # config.timeout = 10.0 - # config.rpcs.search_document_chunks.timeout = 20.0 - # end - # - # # Apply the above configuration only to a new client. - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| - # config.timeout = 10.0 - # config.rpcs.search_document_chunks.timeout = 20.0 - # end - # - # @!attribute [rw] endpoint - # A custom service endpoint, as a hostname or hostname:port. The default is - # nil, indicating to use the default endpoint in the current universe domain. - # @return [::String,nil] - # @!attribute [rw] credentials - # Credentials to send with calls. You may provide any of the following types: - # * (`String`) The path to a service account key file in JSON format - # * (`Hash`) A service account key as a Hash - # * (`Google::Auth::Credentials`) A googleauth credentials object - # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) - # * (`Signet::OAuth2::Client`) A signet oauth2 client object - # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) - # * (`nil`) indicating no credentials - # - # Warning: If you accept a credential configuration (JSON file or Hash) from an - # external source for authentication to Google Cloud, you must validate it before - # providing it to a Google API client library. Providing an unvalidated credential - # configuration to Google APIs can compromise the security of your systems and data. - # For more information, refer to [Validate credential configurations from external - # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials). - # @return [::Object] - # @!attribute [rw] scope - # The OAuth scopes - # @return [::Array<::String>] - # @!attribute [rw] lib_name - # The library name as recorded in instrumentation and logging - # @return [::String] - # @!attribute [rw] lib_version - # The library version as recorded in instrumentation and logging - # @return [::String] - # @!attribute [rw] timeout - # The call timeout in seconds. - # @return [::Numeric] - # @!attribute [rw] metadata - # Additional headers to be sent with the call. - # @return [::Hash{::Symbol=>::String}] - # @!attribute [rw] retry_policy - # The retry policy. The value is a hash with the following keys: - # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. - # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. - # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. - # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0. - # * `:retry_codes` (*type:* `Array`) - The error codes that should - # trigger a retry. - # @return [::Hash] - # @!attribute [rw] quota_project - # A separate project against which to charge quota. - # @return [::String] - # @!attribute [rw] universe_domain - # The universe domain within which to make requests. This determines the - # default endpoint URL. The default value of nil uses the environment - # universe (usually the default "googleapis.com" universe). - # @return [::String,nil] - # @!attribute [rw] logger - # A custom logger to use for request/response debug logging, or the value - # `:default` (the default) to construct a default logger, or `nil` to - # explicitly disable logging. - # @return [::Logger,:default,nil] - # - class Configuration - extend ::Gapic::Config - - # @private - # The endpoint specific to the default "googleapis.com" universe. Deprecated. - DEFAULT_ENDPOINT = "developerknowledge.googleapis.com" - - config_attr :endpoint, nil, ::String, nil - config_attr :credentials, nil do |value| - allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil] - allowed.any? { |klass| klass === value } - end - config_attr :scope, nil, ::String, ::Array, nil - config_attr :lib_name, nil, ::String, nil - config_attr :lib_version, nil, ::String, nil - config_attr :timeout, nil, ::Numeric, nil - config_attr :metadata, nil, ::Hash, nil - config_attr :retry_policy, nil, ::Hash, ::Proc, nil - config_attr :quota_project, nil, ::String, nil - config_attr :universe_domain, nil, ::String, nil - config_attr :logger, :default, ::Logger, nil, :default - - # @private - def initialize parent_config = nil - @parent_config = parent_config unless parent_config.nil? - - yield self if block_given? - end - - ## - # Configurations for individual RPCs - # @return [Rpcs] - # - def rpcs - @rpcs ||= begin - parent_rpcs = nil - parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) - Rpcs.new parent_rpcs - end - end - - ## - # Configuration RPC class for the DeveloperKnowledge API. - # - # Includes fields providing the configuration for each RPC in this service. - # Each configuration object is of type `Gapic::Config::Method` and includes - # the following configuration fields: - # - # * `timeout` (*type:* `Numeric`) - The call timeout in seconds - # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers - # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields - # include the following keys: - # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. - # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. - # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. - # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0. - # * `:retry_codes` (*type:* `Array`) - The error codes that should - # trigger a retry. - # - class Rpcs - ## - # RPC-specific configuration for `search_document_chunks` - # @return [::Gapic::Config::Method] - # - attr_reader :search_document_chunks - ## - # RPC-specific configuration for `get_document` - # @return [::Gapic::Config::Method] - # - attr_reader :get_document - ## - # RPC-specific configuration for `batch_get_documents` - # @return [::Gapic::Config::Method] - # - attr_reader :batch_get_documents - ## - # RPC-specific configuration for `answer_query` - # @return [::Gapic::Config::Method] - # - attr_reader :answer_query - - # @private - def initialize parent_rpcs = nil - search_document_chunks_config = parent_rpcs.search_document_chunks if parent_rpcs.respond_to? :search_document_chunks - @search_document_chunks = ::Gapic::Config::Method.new search_document_chunks_config - get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document - @get_document = ::Gapic::Config::Method.new get_document_config - batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents - @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config - answer_query_config = parent_rpcs.answer_query if parent_rpcs.respond_to? :answer_query - @answer_query = ::Gapic::Config::Method.new answer_query_config - - yield self if block_given? - end - end - end - end - end - end - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb deleted file mode 100644 index 2b64ff55126a..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb +++ /dev/null @@ -1,320 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "google/developers/knowledge/v1/developerknowledge_pb" - -module Google - module Developers - module DeveloperKnowledge - module V1 - module DeveloperKnowledge - module Rest - ## - # REST service stub for the DeveloperKnowledge service. - # Service stub contains baseline method implementations - # including transcoding, making the REST call, and deserialing the response. - # - class ServiceStub - # @private - def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger: - # These require statements are intentionally placed here to initialize - # the REST modules only when it's required. - require "gapic/rest" - - @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, - endpoint_template: endpoint_template, - universe_domain: universe_domain, - credentials: credentials, - numeric_enums: true, - service_name: self.class, - raise_faraday_errors: false, - logger: logger - end - - ## - # The effective universe domain - # - # @return [String] - # - def universe_domain - @client_stub.universe_domain - end - - ## - # The effective endpoint - # - # @return [String] - # - def endpoint - @client_stub.endpoint - end - - ## - # The logger used for request/response debug logging. - # - # @return [Logger] - # - def logger stub: false - stub ? @client_stub.stub_logger : @client_stub.logger - end - - ## - # Baseline implementation for the search_document_chunks REST call - # - # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest] - # A request object representing the call parameters. Required. - # @param options [::Gapic::CallOptions] - # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # - # @yield [result, operation] Access the result along with the TransportOperation object - # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse] - # @yieldparam operation [::Gapic::Rest::TransportOperation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse] - # A result object deserialized from the server's reply - def search_document_chunks request_pb, options = nil - raise ::ArgumentError, "request must be provided" if request_pb.nil? - - verb, uri, query_string_params, body = ServiceStub.transcode_search_document_chunks_request request_pb - query_string_params = if query_string_params.any? - query_string_params.to_h { |p| p.split "=", 2 } - else - {} - end - - response = @client_stub.make_http_request( - verb, - uri: uri, - body: body || "", - params: query_string_params, - method_name: "search_document_chunks", - options: options - ) - operation = ::Gapic::Rest::TransportOperation.new response - result = ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse.decode_json response.body, ignore_unknown_fields: true - catch :response do - yield result, operation if block_given? - result - end - end - - ## - # Baseline implementation for the get_document REST call - # - # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest] - # A request object representing the call parameters. Required. - # @param options [::Gapic::CallOptions] - # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # - # @yield [result, operation] Access the result along with the TransportOperation object - # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::Document] - # @yieldparam operation [::Gapic::Rest::TransportOperation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::Document] - # A result object deserialized from the server's reply - def get_document request_pb, options = nil - raise ::ArgumentError, "request must be provided" if request_pb.nil? - - verb, uri, query_string_params, body = ServiceStub.transcode_get_document_request request_pb - query_string_params = if query_string_params.any? - query_string_params.to_h { |p| p.split "=", 2 } - else - {} - end - - response = @client_stub.make_http_request( - verb, - uri: uri, - body: body || "", - params: query_string_params, - method_name: "get_document", - options: options - ) - operation = ::Gapic::Rest::TransportOperation.new response - result = ::Google::Developers::DeveloperKnowledge::V1::Document.decode_json response.body, ignore_unknown_fields: true - catch :response do - yield result, operation if block_given? - result - end - end - - ## - # Baseline implementation for the batch_get_documents REST call - # - # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest] - # A request object representing the call parameters. Required. - # @param options [::Gapic::CallOptions] - # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # - # @yield [result, operation] Access the result along with the TransportOperation object - # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] - # @yieldparam operation [::Gapic::Rest::TransportOperation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse] - # A result object deserialized from the server's reply - def batch_get_documents request_pb, options = nil - raise ::ArgumentError, "request must be provided" if request_pb.nil? - - verb, uri, query_string_params, body = ServiceStub.transcode_batch_get_documents_request request_pb - query_string_params = if query_string_params.any? - query_string_params.to_h { |p| p.split "=", 2 } - else - {} - end - - response = @client_stub.make_http_request( - verb, - uri: uri, - body: body || "", - params: query_string_params, - method_name: "batch_get_documents", - options: options - ) - operation = ::Gapic::Rest::TransportOperation.new response - result = ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse.decode_json response.body, ignore_unknown_fields: true - catch :response do - yield result, operation if block_given? - result - end - end - - ## - # Baseline implementation for the answer_query REST call - # - # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest] - # A request object representing the call parameters. Required. - # @param options [::Gapic::CallOptions] - # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # - # @yield [result, operation] Access the result along with the TransportOperation object - # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] - # @yieldparam operation [::Gapic::Rest::TransportOperation] - # - # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse] - # A result object deserialized from the server's reply - def answer_query request_pb, options = nil - raise ::ArgumentError, "request must be provided" if request_pb.nil? - - verb, uri, query_string_params, body = ServiceStub.transcode_answer_query_request request_pb - query_string_params = if query_string_params.any? - query_string_params.to_h { |p| p.split "=", 2 } - else - {} - end - - response = @client_stub.make_http_request( - verb, - uri: uri, - body: body || "", - params: query_string_params, - method_name: "answer_query", - options: options - ) - operation = ::Gapic::Rest::TransportOperation.new response - result = ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.decode_json response.body, ignore_unknown_fields: true - catch :response do - yield result, operation if block_given? - result - end - end - - ## - # @private - # - # GRPC transcoding helper method for the search_document_chunks REST call - # - # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest] - # A request object representing the call parameters. Required. - # @return [Array(String, [String, nil], Hash{String => String})] - # Uri, Body, Query string parameters - def self.transcode_search_document_chunks_request request_pb - transcoder = Gapic::Rest::GrpcTranscoder.new - .with_bindings( - uri_method: :get, - uri_template: "/v1/documents:searchDocumentChunks", - matches: [] - ) - transcoder.transcode request_pb - end - - ## - # @private - # - # GRPC transcoding helper method for the get_document REST call - # - # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest] - # A request object representing the call parameters. Required. - # @return [Array(String, [String, nil], Hash{String => String})] - # Uri, Body, Query string parameters - def self.transcode_get_document_request request_pb - transcoder = Gapic::Rest::GrpcTranscoder.new - .with_bindings( - uri_method: :get, - uri_template: "/v1/{name}", - matches: [ - ["name", %r{^documents(?:/(?<__wildcard__>.*))?$}, true] - ] - ) - transcoder.transcode request_pb - end - - ## - # @private - # - # GRPC transcoding helper method for the batch_get_documents REST call - # - # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest] - # A request object representing the call parameters. Required. - # @return [Array(String, [String, nil], Hash{String => String})] - # Uri, Body, Query string parameters - def self.transcode_batch_get_documents_request request_pb - transcoder = Gapic::Rest::GrpcTranscoder.new - .with_bindings( - uri_method: :get, - uri_template: "/v1/documents:batchGet", - matches: [] - ) - transcoder.transcode request_pb - end - - ## - # @private - # - # GRPC transcoding helper method for the answer_query REST call - # - # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest] - # A request object representing the call parameters. Required. - # @return [Array(String, [String, nil], Hash{String => String})] - # Uri, Body, Query string parameters - def self.transcode_answer_query_request request_pb - transcoder = Gapic::Rest::GrpcTranscoder.new - .with_bindings( - uri_method: :post, - uri_template: "/v1:answerQuery", - body: "*", - matches: [] - ) - transcoder.transcode request_pb - end - end - end - end - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/rest.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/rest.rb deleted file mode 100644 index 564abffb5326..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/rest.rb +++ /dev/null @@ -1,37 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "google/developers/developer_knowledge/v1/developer_knowledge/rest" -require "google/developers/developer_knowledge/v1/version" - -module Google - module Developers - module DeveloperKnowledge - ## - # To load just the REST part of this package, including all its services, and instantiate a REST client: - # - # @example - # - # require "google/developers/developer_knowledge/v1/rest" - # client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new - # - module V1 - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/version.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/version.rb deleted file mode 100644 index 27f225b083b3..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/developer_knowledge/v1/version.rb +++ /dev/null @@ -1,28 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Developers - module DeveloperKnowledge - module V1 - VERSION = "0.0.1" - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb deleted file mode 100644 index 26518ed4f668..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_pb.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true -# Generated by the protocol buffer compiler. DO NOT EDIT! -# source: google/developers/knowledge/v1/developerknowledge.proto - -require 'google/protobuf' - -require 'google/api/annotations_pb' -require 'google/api/client_pb' -require 'google/api/field_behavior_pb' -require 'google/api/resource_pb' -require 'google/protobuf/timestamp_pb' - - -descriptor_data = "\n7google/developers/knowledge/v1/developerknowledge.proto\x12\x1egoogle.developers.knowledge.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x83\x03\n\x08\x44ocument\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x10\n\x03uri\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x65scription\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x61ta_source\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x12\n\x05title\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12?\n\x04view\x18\x08 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x03\x12!\n\x14\x63ontent_length_bytes\x18\t \x01(\x05\x42\x03\xe0\x41\x03:Z\xea\x41W\n*developerknowledge.googleapis.com/Document\x12\x14\x64ocuments/{document}*\tdocuments2\x08\x64ocument\"w\n\x1bSearchDocumentChunksRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x04 \x01(\tB\x03\xe0\x41\x01\"w\n\x1cSearchDocumentChunksResponse\x12>\n\x07results\x18\x01 \x03(\x0b\x32-.google.developers.knowledge.v1.DocumentChunk\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\x97\x01\n\x12GetDocumentRequest\x12@\n\x04name\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"\x9e\x01\n\x18\x42\x61tchGetDocumentsRequest\x12\x41\n\x05names\x18\x01 \x03(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"X\n\x19\x42\x61tchGetDocumentsResponse\x12;\n\tdocuments\x18\x01 \x03(\x0b\x32(.google.developers.knowledge.v1.Document\"(\n\x12\x41nswerQueryRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\"M\n\x13\x41nswerQueryResponse\x12\x36\n\x06\x61nswer\x18\x01 \x01(\x0b\x32&.google.developers.knowledge.v1.Answer\"\xdb\x04\n\x06\x41nswer\x12\x13\n\x0b\x61nswer_text\x18\x01 \x01(\t\x12M\n\tcitations\x18\x02 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.AnswerCitationB\x03\xe0\x41\x03\x12O\n\nreferences\x18\x03 \x03(\x0b\x32\x36.google.developers.knowledge.v1.Answer.AnswerReferenceB\x03\xe0\x41\x03\x1a\x8f\x01\n\x0e\x41nswerCitation\x12\x18\n\x0bstart_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x12\x16\n\tend_index\x18\x02 \x01(\x05\x42\x03\xe0\x41\x03\x12K\n\x07sources\x18\x03 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.CitationSourceB\x03\xe0\x41\x03\x1a.\n\x0e\x43itationSource\x12\x1c\n\x0freference_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x1ay\n\x0f\x41nswerReference\x12[\n\x12\x64ocument_reference\x18\x01 \x01(\x0b\x32\x38.google.developers.knowledge.v1.Answer.DocumentReferenceB\x03\xe0\x41\x03H\x00\x42\t\n\x07\x63ontent\x1a_\n\x11\x44ocumentReference\x12J\n\x0e\x64ocument_chunk\x18\x01 \x01(\x0b\x32-.google.developers.knowledge.v1.DocumentChunkB\x03\xe0\x41\x03\"\xf2\x01\n\rDocumentChunk\x12\x42\n\x06parent\x18\x01 \x01(\tB2\xe0\x41\x03\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12\x0f\n\x02id\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12?\n\x08\x64ocument\x18\x04 \x01(\x0b\x32(.google.developers.knowledge.v1.DocumentB\x03\xe0\x41\x03\x12!\n\x0frelevance_score\x18\x05 \x01(\x01\x42\x03\xe0\x41\x03H\x00\x88\x01\x01\x42\x12\n\x10_relevance_score*y\n\x0c\x44ocumentView\x12\x1d\n\x19\x44OCUMENT_VIEW_UNSPECIFIED\x10\x00\x12\x17\n\x13\x44OCUMENT_VIEW_BASIC\x10\x01\x12\x16\n\x12\x44OCUMENT_VIEW_FULL\x10\x02\x12\x19\n\x15\x44OCUMENT_VIEW_CONTENT\x10\x03\x32\x81\x06\n\x12\x44\x65veloperKnowledge\x12\xbd\x01\n\x14SearchDocumentChunks\x12;.google.developers.knowledge.v1.SearchDocumentChunksRequest\x1a<.google.developers.knowledge.v1.SearchDocumentChunksResponse\"*\x82\xd3\xe4\x93\x02$\x12\"/v1/documents:searchDocumentChunks\x12\x93\x01\n\x0bGetDocument\x12\x32.google.developers.knowledge.v1.GetDocumentRequest\x1a(.google.developers.knowledge.v1.Document\"&\xda\x41\x04name\x82\xd3\xe4\x93\x02\x19\x12\x17/v1/{name=documents/**}\x12\xa8\x01\n\x11\x42\x61tchGetDocuments\x12\x38.google.developers.knowledge.v1.BatchGetDocumentsRequest\x1a\x39.google.developers.knowledge.v1.BatchGetDocumentsResponse\"\x1e\x82\xd3\xe4\x93\x02\x18\x12\x16/v1/documents:batchGet\x12\x92\x01\n\x0b\x41nswerQuery\x12\x32.google.developers.knowledge.v1.AnswerQueryRequest\x1a\x33.google.developers.knowledge.v1.AnswerQueryResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1:answerQuery:\x01*\x1aU\xca\x41!developerknowledge.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x83\x02\n\"com.google.developers.knowledge.v1B\x17\x44\x65veloperKnowledgeProtoP\x01ZAcloud.google.com/go/developerknowledge/apiv1/developerknowledgepb\xaa\x02\'Google.Developers.DeveloperKnowledge.V1\xca\x02\'Google\\Developers\\DeveloperKnowledge\\V1\xea\x02*Google::Developers::DeveloperKnowledge::V1b\x06proto3" - -pool = ::Google::Protobuf::DescriptorPool.generated_pool -pool.add_serialized_file(descriptor_data) - -module Google - module Developers - module DeveloperKnowledge - module V1 - Document = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Document").msgclass - SearchDocumentChunksRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.SearchDocumentChunksRequest").msgclass - SearchDocumentChunksResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.SearchDocumentChunksResponse").msgclass - GetDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.GetDocumentRequest").msgclass - BatchGetDocumentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.BatchGetDocumentsRequest").msgclass - BatchGetDocumentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.BatchGetDocumentsResponse").msgclass - AnswerQueryRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.AnswerQueryRequest").msgclass - AnswerQueryResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.AnswerQueryResponse").msgclass - Answer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer").msgclass - Answer::AnswerCitation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.AnswerCitation").msgclass - Answer::CitationSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.CitationSource").msgclass - Answer::AnswerReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.AnswerReference").msgclass - Answer::DocumentReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.DocumentReference").msgclass - DocumentChunk = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.DocumentChunk").msgclass - DocumentView = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.DocumentView").enummodule - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb deleted file mode 100644 index b8d1a647457b..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb +++ /dev/null @@ -1,77 +0,0 @@ -# Generated by the protocol buffer compiler. DO NOT EDIT! -# Source: google/developers/knowledge/v1/developerknowledge.proto for package 'Google.Developers.DeveloperKnowledge.V1' -# Original file comments: -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -require 'grpc' -require 'google/developers/knowledge/v1/developerknowledge_pb' - -module Google - module Developers - module DeveloperKnowledge - module V1 - module DeveloperKnowledge - # The Developer Knowledge API provides programmatic access to Google's public - # developer documentation, enabling you to integrate this knowledge base into - # your own applications and workflows. - # - # The API is designed to be the canonical source for machine-readable access to - # Google's developer documentation. - # - # A typical use case is to first use - # [DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks] - # to find relevant page URIs based on a query, and then use - # [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] - # or - # [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] - # to fetch the full content of the top results. - # - # All document content is provided in Markdown format. - class Service - - include ::GRPC::GenericService - - self.marshal_class_method = :encode - self.unmarshal_class_method = :decode - self.service_name = 'google.developers.knowledge.v1.DeveloperKnowledge' - - # Searches for developer knowledge across Google's developer documentation. - # Returns [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s - # based on the user's query. There may be many chunks from the same - # [Document][google.developers.knowledge.v1.Document]. To retrieve full - # documents, use - # [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] - # or - # [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments] - # with the - # [DocumentChunk.parent][google.developers.knowledge.v1.DocumentChunk.parent] - # returned in the - # [SearchDocumentChunksResponse.results][google.developers.knowledge.v1.SearchDocumentChunksResponse.results]. - rpc :SearchDocumentChunks, ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest, ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse - # Retrieves a single document with its full Markdown content. - rpc :GetDocument, ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, ::Google::Developers::DeveloperKnowledge::V1::Document - # Retrieves multiple documents, each with its full Markdown content. - rpc :BatchGetDocuments, ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse - # Answers a query using grounded generation. - rpc :AnswerQuery, ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse - end - - Stub = Service.rpc_stub_class - end - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/README.md b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/README.md deleted file mode 100644 index 76079269bdd8..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Developer Knowledge V1 Protocol Buffer Documentation - -These files are for the YARD documentation of the generated protobuf files. -They are not intended to be required or loaded at runtime. diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/client.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/client.rb deleted file mode 100644 index 3ab0b096d445..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/client.rb +++ /dev/null @@ -1,593 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Api - # Required information for every language. - # @!attribute [rw] reference_docs_uri - # @deprecated This field is deprecated and may be removed in the next major version update. - # @return [::String] - # Link to automatically generated reference documentation. Example: - # https://cloud.google.com/nodejs/docs/reference/asset/latest - # @!attribute [rw] destinations - # @return [::Array<::Google::Api::ClientLibraryDestination>] - # The destination where API teams want this client library to be published. - # @!attribute [rw] selective_gapic_generation - # @return [::Google::Api::SelectiveGapicGeneration] - # Configuration for which RPCs should be generated in the GAPIC client. - # - # Note: This field should not be used in most cases. - class CommonLanguageSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Details about how and where to publish client libraries. - # @!attribute [rw] version - # @return [::String] - # Version of the API to apply these settings to. This is the full protobuf - # package for the API, ending in the version element. - # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1". - # @!attribute [rw] launch_stage - # @return [::Google::Api::LaunchStage] - # Launch stage of this version of the API. - # @!attribute [rw] rest_numeric_enums - # @return [::Boolean] - # When using transport=rest, the client request will encode enums as - # numbers rather than strings. - # @!attribute [rw] java_settings - # @return [::Google::Api::JavaSettings] - # Settings for legacy Java features, supported in the Service YAML. - # @!attribute [rw] cpp_settings - # @return [::Google::Api::CppSettings] - # Settings for C++ client libraries. - # @!attribute [rw] php_settings - # @return [::Google::Api::PhpSettings] - # Settings for PHP client libraries. - # @!attribute [rw] python_settings - # @return [::Google::Api::PythonSettings] - # Settings for Python client libraries. - # @!attribute [rw] node_settings - # @return [::Google::Api::NodeSettings] - # Settings for Node client libraries. - # @!attribute [rw] dotnet_settings - # @return [::Google::Api::DotnetSettings] - # Settings for .NET client libraries. - # @!attribute [rw] ruby_settings - # @return [::Google::Api::RubySettings] - # Settings for Ruby client libraries. - # @!attribute [rw] go_settings - # @return [::Google::Api::GoSettings] - # Settings for Go client libraries. - class ClientLibrarySettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # This message configures the settings for publishing [Google Cloud Client - # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) - # generated from the service config. - # @!attribute [rw] method_settings - # @return [::Array<::Google::Api::MethodSettings>] - # A list of API method settings, e.g. the behavior for methods that use the - # long-running operation pattern. - # @!attribute [rw] new_issue_uri - # @return [::String] - # Link to a *public* URI where users can report issues. Example: - # https://issuetracker.google.com/issues/new?component=190865&template=1161103 - # @!attribute [rw] documentation_uri - # @return [::String] - # Link to product home page. Example: - # https://cloud.google.com/asset-inventory/docs/overview - # @!attribute [rw] api_short_name - # @return [::String] - # Used as a tracking tag when collecting data about the APIs developer - # relations artifacts like docs, packages delivered to package managers, - # etc. Example: "speech". - # @!attribute [rw] github_label - # @return [::String] - # GitHub label to apply to issues and pull requests opened for this API. - # @!attribute [rw] codeowner_github_teams - # @return [::Array<::String>] - # GitHub teams to be added to CODEOWNERS in the directory in GitHub - # containing source code for the client libraries for this API. - # @!attribute [rw] doc_tag_prefix - # @return [::String] - # A prefix used in sample code when demarking regions to be included in - # documentation. - # @!attribute [rw] organization - # @return [::Google::Api::ClientLibraryOrganization] - # For whom the client library is being published. - # @!attribute [rw] library_settings - # @return [::Array<::Google::Api::ClientLibrarySettings>] - # Client library settings. If the same version string appears multiple - # times in this list, then the last one wins. Settings from earlier - # settings with the same version string are discarded. - # @!attribute [rw] proto_reference_documentation_uri - # @return [::String] - # Optional link to proto reference documentation. Example: - # https://cloud.google.com/pubsub/lite/docs/reference/rpc - # @!attribute [rw] rest_reference_documentation_uri - # @return [::String] - # Optional link to REST reference documentation. Example: - # https://cloud.google.com/pubsub/lite/docs/reference/rest - class Publishing - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Settings for Java client libraries. - # @!attribute [rw] library_package - # @return [::String] - # The package name to use in Java. Clobbers the java_package option - # set in the protobuf. This should be used **only** by APIs - # who have already set the language_settings.java.package_name" field - # in gapic.yaml. API teams should use the protobuf java_package option - # where possible. - # - # Example of a YAML configuration:: - # - # publishing: - # library_settings: - # java_settings: - # library_package: com.google.cloud.pubsub.v1 - # @!attribute [rw] service_class_names - # @return [::Google::Protobuf::Map{::String => ::String}] - # Configure the Java class name to use instead of the service's for its - # corresponding generated GAPIC client. Keys are fully-qualified - # service names as they appear in the protobuf (including the full - # the language_settings.java.interface_names" field in gapic.yaml. API - # teams should otherwise use the service name as it appears in the - # protobuf. - # - # Example of a YAML configuration:: - # - # publishing: - # java_settings: - # service_class_names: - # - google.pubsub.v1.Publisher: TopicAdmin - # - google.pubsub.v1.Subscriber: SubscriptionAdmin - # @!attribute [rw] common - # @return [::Google::Api::CommonLanguageSettings] - # Some settings. - class JavaSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - - # @!attribute [rw] key - # @return [::String] - # @!attribute [rw] value - # @return [::String] - class ServiceClassNamesEntry - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end - - # Settings for C++ client libraries. - # @!attribute [rw] common - # @return [::Google::Api::CommonLanguageSettings] - # Some settings. - class CppSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Settings for Php client libraries. - # @!attribute [rw] common - # @return [::Google::Api::CommonLanguageSettings] - # Some settings. - # @!attribute [rw] library_package - # @return [::String] - # The package name to use in Php. Clobbers the php_namespace option - # set in the protobuf. This should be used **only** by APIs - # who have already set the language_settings.php.package_name" field - # in gapic.yaml. API teams should use the protobuf php_namespace option - # where possible. - # - # Example of a YAML configuration:: - # - # publishing: - # library_settings: - # php_settings: - # library_package: Google\Cloud\PubSub\V1 - class PhpSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Settings for Python client libraries. - # @!attribute [rw] common - # @return [::Google::Api::CommonLanguageSettings] - # Some settings. - # @!attribute [rw] experimental_features - # @return [::Google::Api::PythonSettings::ExperimentalFeatures] - # Experimental features to be included during client library generation. - class PythonSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - - # Experimental features to be included during client library generation. - # These fields will be deprecated once the feature graduates and is enabled - # by default. - # @!attribute [rw] rest_async_io_enabled - # @return [::Boolean] - # Enables generation of asynchronous REST clients if `rest` transport is - # enabled. By default, asynchronous REST clients will not be generated. - # This feature will be enabled by default 1 month after launching the - # feature in preview packages. - # @!attribute [rw] protobuf_pythonic_types_enabled - # @return [::Boolean] - # Enables generation of protobuf code using new types that are more - # Pythonic which are included in `protobuf>=5.29.x`. This feature will be - # enabled by default 1 month after launching the feature in preview - # packages. - # @!attribute [rw] unversioned_package_disabled - # @return [::Boolean] - # Disables generation of an unversioned Python package for this client - # library. This means that the module names will need to be versioned in - # import statements. For example `import google.cloud.library_v2` instead - # of `import google.cloud.library`. - class ExperimentalFeatures - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end - - # Settings for Node client libraries. - # @!attribute [rw] common - # @return [::Google::Api::CommonLanguageSettings] - # Some settings. - class NodeSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Settings for Dotnet client libraries. - # @!attribute [rw] common - # @return [::Google::Api::CommonLanguageSettings] - # Some settings. - # @!attribute [rw] renamed_services - # @return [::Google::Protobuf::Map{::String => ::String}] - # Map from original service names to renamed versions. - # This is used when the default generated types - # would cause a naming conflict. (Neither name is - # fully-qualified.) - # Example: Subscriber to SubscriberServiceApi. - # @!attribute [rw] renamed_resources - # @return [::Google::Protobuf::Map{::String => ::String}] - # Map from full resource types to the effective short name - # for the resource. This is used when otherwise resource - # named from different services would cause naming collisions. - # Example entry: - # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" - # @!attribute [rw] ignored_resources - # @return [::Array<::String>] - # List of full resource types to ignore during generation. - # This is typically used for API-specific Location resources, - # which should be handled by the generator as if they were actually - # the common Location resources. - # Example entry: "documentai.googleapis.com/Location" - # @!attribute [rw] forced_namespace_aliases - # @return [::Array<::String>] - # Namespaces which must be aliased in snippets due to - # a known (but non-generator-predictable) naming collision - # @!attribute [rw] handwritten_signatures - # @return [::Array<::String>] - # Method signatures (in the form "service.method(signature)") - # which are provided separately, so shouldn't be generated. - # Snippets *calling* these methods are still generated, however. - class DotnetSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - - # @!attribute [rw] key - # @return [::String] - # @!attribute [rw] value - # @return [::String] - class RenamedServicesEntry - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # @!attribute [rw] key - # @return [::String] - # @!attribute [rw] value - # @return [::String] - class RenamedResourcesEntry - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end - - # Settings for Ruby client libraries. - # @!attribute [rw] common - # @return [::Google::Api::CommonLanguageSettings] - # Some settings. - class RubySettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Settings for Go client libraries. - # @!attribute [rw] common - # @return [::Google::Api::CommonLanguageSettings] - # Some settings. - # @!attribute [rw] renamed_services - # @return [::Google::Protobuf::Map{::String => ::String}] - # Map of service names to renamed services. Keys are the package relative - # service names and values are the name to be used for the service client - # and call options. - # - # Example: - # - # publishing: - # go_settings: - # renamed_services: - # Publisher: TopicAdmin - class GoSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - - # @!attribute [rw] key - # @return [::String] - # @!attribute [rw] value - # @return [::String] - class RenamedServicesEntry - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end - - # Describes the generator configuration for a method. - # @!attribute [rw] selector - # @return [::String] - # The fully qualified name of the method, for which the options below apply. - # This is used to find the method to apply the options. - # - # Example: - # - # publishing: - # method_settings: - # - selector: google.storage.control.v2.StorageControl.CreateFolder - # # method settings for CreateFolder... - # @!attribute [rw] long_running - # @return [::Google::Api::MethodSettings::LongRunning] - # Describes settings to use for long-running operations when generating - # API methods for RPCs. Complements RPCs that use the annotations in - # google/longrunning/operations.proto. - # - # Example of a YAML configuration:: - # - # publishing: - # method_settings: - # - selector: google.cloud.speech.v2.Speech.BatchRecognize - # long_running: - # initial_poll_delay: 60s # 1 minute - # poll_delay_multiplier: 1.5 - # max_poll_delay: 360s # 6 minutes - # total_poll_timeout: 54000s # 90 minutes - # @!attribute [rw] auto_populated_fields - # @return [::Array<::String>] - # List of top-level fields of the request message, that should be - # automatically populated by the client libraries based on their - # (google.api.field_info).format. Currently supported format: UUID4. - # - # Example of a YAML configuration: - # - # publishing: - # method_settings: - # - selector: google.example.v1.ExampleService.CreateExample - # auto_populated_fields: - # - request_id - # @!attribute [rw] batching - # @return [::Google::Api::BatchingConfigProto] - # Batching configuration for an API method in client libraries. - # - # Example of a YAML configuration: - # - # publishing: - # method_settings: - # - selector: google.example.v1.ExampleService.BatchCreateExample - # batching: - # element_count_threshold: 1000 - # request_byte_threshold: 100000000 - # delay_threshold_millis: 10 - class MethodSettings - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - - # Describes settings to use when generating API methods that use the - # long-running operation pattern. - # All default values below are from those used in the client library - # generators (e.g. - # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). - # @!attribute [rw] initial_poll_delay - # @return [::Google::Protobuf::Duration] - # Initial delay after which the first poll request will be made. - # Default value: 5 seconds. - # @!attribute [rw] poll_delay_multiplier - # @return [::Float] - # Multiplier to gradually increase delay between subsequent polls until it - # reaches max_poll_delay. - # Default value: 1.5. - # @!attribute [rw] max_poll_delay - # @return [::Google::Protobuf::Duration] - # Maximum time between two subsequent poll requests. - # Default value: 45 seconds. - # @!attribute [rw] total_poll_timeout - # @return [::Google::Protobuf::Duration] - # Total polling timeout. - # Default value: 5 minutes. - class LongRunning - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end - - # This message is used to configure the generation of a subset of the RPCs in - # a service for client libraries. - # - # Note: This feature should not be used in most cases. - # @!attribute [rw] methods - # @return [::Array<::String>] - # An allowlist of the fully qualified names of RPCs that should be included - # on public client surfaces. - # @!attribute [rw] generate_omitted_as_internal - # @return [::Boolean] - # Setting this to true indicates to the client generators that methods - # that would be excluded from the generation should instead be generated - # in a way that indicates these methods should not be consumed by - # end users. How this is expressed is up to individual language - # implementations to decide. Some examples may be: added annotations, - # obfuscated identifiers, or other language idiomatic patterns. - class SelectiveGapicGeneration - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # `BatchingConfigProto` defines the batching configuration for an API method. - # @!attribute [rw] thresholds - # @return [::Google::Api::BatchingSettingsProto] - # The thresholds which trigger a batched request to be sent. - # @!attribute [rw] batch_descriptor - # @return [::Google::Api::BatchingDescriptorProto] - # The request and response fields used in batching. - class BatchingConfigProto - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # `BatchingSettingsProto` specifies a set of batching thresholds, each of - # which acts as a trigger to send a batch of messages as a request. At least - # one threshold must be positive nonzero. - # @!attribute [rw] element_count_threshold - # @return [::Integer] - # The number of elements of a field collected into a batch which, if - # exceeded, causes the batch to be sent. - # @!attribute [rw] request_byte_threshold - # @return [::Integer] - # The aggregated size of the batched field which, if exceeded, causes the - # batch to be sent. This size is computed by aggregating the sizes of the - # request field to be batched, not of the entire request message. - # @!attribute [rw] delay_threshold - # @return [::Google::Protobuf::Duration] - # The duration after which a batch should be sent, starting from the addition - # of the first message to that batch. - # @!attribute [rw] element_count_limit - # @return [::Integer] - # The maximum number of elements collected in a batch that could be accepted - # by server. - # @!attribute [rw] request_byte_limit - # @return [::Integer] - # The maximum size of the request that could be accepted by server. - # @!attribute [rw] flow_control_element_limit - # @return [::Integer] - # The maximum number of elements allowed by flow control. - # @!attribute [rw] flow_control_byte_limit - # @return [::Integer] - # The maximum size of data allowed by flow control. - # @!attribute [rw] flow_control_limit_exceeded_behavior - # @return [::Google::Api::FlowControlLimitExceededBehaviorProto] - # The behavior to take when the flow control limit is exceeded. - class BatchingSettingsProto - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # `BatchingDescriptorProto` specifies the fields of the request message to be - # used for batching, and, optionally, the fields of the response message to be - # used for demultiplexing. - # @!attribute [rw] batched_field - # @return [::String] - # The repeated field in the request message to be aggregated by batching. - # @!attribute [rw] discriminator_fields - # @return [::Array<::String>] - # A list of the fields in the request message. Two requests will be batched - # together only if the values of every field specified in - # `request_discriminator_fields` is equal between the two requests. - # @!attribute [rw] subresponse_field - # @return [::String] - # Optional. When present, indicates the field in the response message to be - # used to demultiplex the response into multiple response messages, in - # correspondence with the multiple request messages originally batched - # together. - class BatchingDescriptorProto - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # The organization for which the client libraries are being published. - # Affects the url where generated docs are published, etc. - module ClientLibraryOrganization - # Not useful. - CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0 - - # Google Cloud Platform Org. - CLOUD = 1 - - # Ads (Advertising) Org. - ADS = 2 - - # Photos Org. - PHOTOS = 3 - - # Street View Org. - STREET_VIEW = 4 - - # Shopping Org. - SHOPPING = 5 - - # Geo Org. - GEO = 6 - - # Generative AI - https://developers.generativeai.google - GENERATIVE_AI = 7 - end - - # To where should client libraries be published? - module ClientLibraryDestination - # Client libraries will neither be generated nor published to package - # managers. - CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0 - - # Generate the client library in a repo under github.com/googleapis, - # but don't publish it to package managers. - GITHUB = 10 - - # Publish the library to package managers like nuget.org and npmjs.com. - PACKAGE_MANAGER = 20 - end - - # The behavior to take when the flow control limit is exceeded. - module FlowControlLimitExceededBehaviorProto - # Default behavior, system-defined. - UNSET_BEHAVIOR = 0 - - # Stop operation, raise error. - THROW_EXCEPTION = 1 - - # Pause operation until limit clears. - BLOCK = 2 - - # Continue operation, disregard limit. - IGNORE = 3 - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/field_behavior.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/field_behavior.rb deleted file mode 100644 index 582be187d115..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/field_behavior.rb +++ /dev/null @@ -1,85 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Api - # An indicator of the behavior of a given field (for example, that a field - # is required in requests, or given as output but ignored as input). - # This **does not** change the behavior in protocol buffers itself; it only - # denotes the behavior and may affect how API tooling handles the field. - # - # Note: This enum **may** receive new values in the future. - module FieldBehavior - # Conventional default for enums. Do not use this. - FIELD_BEHAVIOR_UNSPECIFIED = 0 - - # Specifically denotes a field as optional. - # While all fields in protocol buffers are optional, this may be specified - # for emphasis if appropriate. - OPTIONAL = 1 - - # Denotes a field as required. - # This indicates that the field **must** be provided as part of the request, - # and failure to do so will cause an error (usually `INVALID_ARGUMENT`). - REQUIRED = 2 - - # Denotes a field as output only. - # This indicates that the field is provided in responses, but including the - # field in a request does nothing (the server *must* ignore it and - # *must not* throw an error as a result of the field's presence). - OUTPUT_ONLY = 3 - - # Denotes a field as input only. - # This indicates that the field is provided in requests, and the - # corresponding field is not included in output. - INPUT_ONLY = 4 - - # Denotes a field as immutable. - # This indicates that the field may be set once in a request to create a - # resource, but may not be changed thereafter. - IMMUTABLE = 5 - - # Denotes that a (repeated) field is an unordered list. - # This indicates that the service may provide the elements of the list - # in any arbitrary order, rather than the order the user originally - # provided. Additionally, the list's order may or may not be stable. - UNORDERED_LIST = 6 - - # Denotes that this field returns a non-empty default value if not set. - # This indicates that if the user provides the empty value in a request, - # a non-empty value will be returned. The user will not be aware of what - # non-empty value to expect. - NON_EMPTY_DEFAULT = 7 - - # Denotes that the field in a resource (a message annotated with - # google.api.resource) is used in the resource name to uniquely identify the - # resource. For AIP-compliant APIs, this should only be applied to the - # `name` field on the resource. - # - # This behavior should not be applied to references to other resources within - # the message. - # - # The identifier field of resources often have different field behavior - # depending on the request it is embedded in (e.g. for Create methods name - # is optional and unused, while for Update methods it is required). Instead - # of method-specific annotations, only `IDENTIFIER` is required. - IDENTIFIER = 8 - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/launch_stage.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/launch_stage.rb deleted file mode 100644 index 9392a413fb1b..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/launch_stage.rb +++ /dev/null @@ -1,71 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Api - # The launch stage as defined by [Google Cloud Platform - # Launch Stages](https://cloud.google.com/terms/launch-stages). - module LaunchStage - # Do not use this default value. - LAUNCH_STAGE_UNSPECIFIED = 0 - - # The feature is not yet implemented. Users can not use it. - UNIMPLEMENTED = 6 - - # Prelaunch features are hidden from users and are only visible internally. - PRELAUNCH = 7 - - # Early Access features are limited to a closed group of testers. To use - # these features, you must sign up in advance and sign a Trusted Tester - # agreement (which includes confidentiality provisions). These features may - # be unstable, changed in backward-incompatible ways, and are not - # guaranteed to be released. - EARLY_ACCESS = 1 - - # Alpha is a limited availability test for releases before they are cleared - # for widespread use. By Alpha, all significant design issues are resolved - # and we are in the process of verifying functionality. Alpha customers - # need to apply for access, agree to applicable terms, and have their - # projects allowlisted. Alpha releases don't have to be feature complete, - # no SLAs are provided, and there are no technical support obligations, but - # they will be far enough along that customers can actually use them in - # test environments or for limited-use tests -- just like they would in - # normal production cases. - ALPHA = 2 - - # Beta is the point at which we are ready to open a release for any - # customer to use. There are no SLA or technical support obligations in a - # Beta release. Products will be complete from a feature perspective, but - # may have some open outstanding issues. Beta releases are suitable for - # limited production use cases. - BETA = 3 - - # GA features are open to all developers and are considered stable and - # fully qualified for production use. - GA = 4 - - # Deprecated features are scheduled to be shut down and removed. For more - # information, see the "Deprecation Policy" section of our [Terms of - # Service](https://cloud.google.com/terms/) - # and the [Google Cloud Platform Subject to the Deprecation - # Policy](https://cloud.google.com/terms/deprecation) documentation. - DEPRECATED = 5 - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/resource.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/resource.rb deleted file mode 100644 index 25dec4847ac1..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/api/resource.rb +++ /dev/null @@ -1,227 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Api - # A simple descriptor of a resource type. - # - # ResourceDescriptor annotates a resource message (either by means of a - # protobuf annotation or use in the service config), and associates the - # resource's schema, the resource type, and the pattern of the resource name. - # - # Example: - # - # message Topic { - # // Indicates this message defines a resource schema. - # // Declares the resource type in the format of {service}/{kind}. - # // For Kubernetes resources, the format is {api group}/{kind}. - # option (google.api.resource) = { - # type: "pubsub.googleapis.com/Topic" - # pattern: "projects/{project}/topics/{topic}" - # }; - # } - # - # The ResourceDescriptor Yaml config will look like: - # - # resources: - # - type: "pubsub.googleapis.com/Topic" - # pattern: "projects/{project}/topics/{topic}" - # - # Sometimes, resources have multiple patterns, typically because they can - # live under multiple parents. - # - # Example: - # - # message LogEntry { - # option (google.api.resource) = { - # type: "logging.googleapis.com/LogEntry" - # pattern: "projects/{project}/logs/{log}" - # pattern: "folders/{folder}/logs/{log}" - # pattern: "organizations/{organization}/logs/{log}" - # pattern: "billingAccounts/{billing_account}/logs/{log}" - # }; - # } - # - # The ResourceDescriptor Yaml config will look like: - # - # resources: - # - type: 'logging.googleapis.com/LogEntry' - # pattern: "projects/{project}/logs/{log}" - # pattern: "folders/{folder}/logs/{log}" - # pattern: "organizations/{organization}/logs/{log}" - # pattern: "billingAccounts/{billing_account}/logs/{log}" - # @!attribute [rw] type - # @return [::String] - # The resource type. It must be in the format of - # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be - # singular and must not include version numbers. - # - # Example: `storage.googleapis.com/Bucket` - # - # The value of the resource_type_kind must follow the regular expression - # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and - # should use PascalCase (UpperCamelCase). The maximum number of - # characters allowed for the `resource_type_kind` is 100. - # @!attribute [rw] pattern - # @return [::Array<::String>] - # Optional. The relative resource name pattern associated with this resource - # type. The DNS prefix of the full resource name shouldn't be specified here. - # - # The path pattern must follow the syntax, which aligns with HTTP binding - # syntax: - # - # Template = Segment { "/" Segment } ; - # Segment = LITERAL | Variable ; - # Variable = "{" LITERAL "}" ; - # - # Examples: - # - # - "projects/\\{project}/topics/\\{topic}" - # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}" - # - # The components in braces correspond to the IDs for each resource in the - # hierarchy. It is expected that, if multiple patterns are provided, - # the same component name (e.g. "project") refers to IDs of the same - # type of resource. - # @!attribute [rw] name_field - # @return [::String] - # Optional. The field on the resource that designates the resource name - # field. If omitted, this is assumed to be "name". - # @!attribute [rw] history - # @return [::Google::Api::ResourceDescriptor::History] - # Optional. The historical or future-looking state of the resource pattern. - # - # Example: - # - # // The InspectTemplate message originally only supported resource - # // names with organization, and project was added later. - # message InspectTemplate { - # option (google.api.resource) = { - # type: "dlp.googleapis.com/InspectTemplate" - # pattern: - # "organizations/{organization}/inspectTemplates/{inspect_template}" - # pattern: "projects/{project}/inspectTemplates/{inspect_template}" - # history: ORIGINALLY_SINGLE_PATTERN - # }; - # } - # @!attribute [rw] plural - # @return [::String] - # The plural name used in the resource name and permission names, such as - # 'projects' for the resource name of 'projects/\\{project}' and the permission - # name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception - # to this is for Nested Collections that have stuttering names, as defined - # in [AIP-122](https://google.aip.dev/122#nested-collections), where the - # collection ID in the resource name pattern does not necessarily directly - # match the `plural` value. - # - # It is the same concept of the `plural` field in k8s CRD spec - # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ - # - # Note: The plural form is required even for singleton resources. See - # https://aip.dev/156 - # @!attribute [rw] singular - # @return [::String] - # The same concept of the `singular` field in k8s CRD spec - # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ - # Such as "project" for the `resourcemanager.googleapis.com/Project` type. - # @!attribute [rw] style - # @return [::Array<::Google::Api::ResourceDescriptor::Style>] - # Style flag(s) for this resource. - # These indicate that a resource is expected to conform to a given - # style. See the specific style flags for additional information. - class ResourceDescriptor - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - - # A description of the historical or future-looking state of the - # resource pattern. - module History - # The "unset" value. - HISTORY_UNSPECIFIED = 0 - - # The resource originally had one pattern and launched as such, and - # additional patterns were added later. - ORIGINALLY_SINGLE_PATTERN = 1 - - # The resource has one pattern, but the API owner expects to add more - # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents - # that from being necessary once there are multiple patterns.) - FUTURE_MULTI_PATTERN = 2 - end - - # A flag representing a specific style that a resource claims to conform to. - module Style - # The unspecified value. Do not use. - STYLE_UNSPECIFIED = 0 - - # This resource is intended to be "declarative-friendly". - # - # Declarative-friendly resources must be more strictly consistent, and - # setting this to true communicates to tools that this resource should - # adhere to declarative-friendly expectations. - # - # Note: This is used by the API linter (linter.aip.dev) to enable - # additional checks. - DECLARATIVE_FRIENDLY = 1 - end - end - - # Defines a proto annotation that describes a string field that refers to - # an API resource. - # @!attribute [rw] type - # @return [::String] - # The resource type that the annotated field references. - # - # Example: - # - # message Subscription { - # string topic = 2 [(google.api.resource_reference) = { - # type: "pubsub.googleapis.com/Topic" - # }]; - # } - # - # Occasionally, a field may reference an arbitrary resource. In this case, - # APIs use the special value * in their resource reference. - # - # Example: - # - # message GetIamPolicyRequest { - # string resource = 2 [(google.api.resource_reference) = { - # type: "*" - # }]; - # } - # @!attribute [rw] child_type - # @return [::String] - # The resource type of a child collection that the annotated field - # references. This is useful for annotating the `parent` field that - # doesn't have a fixed resource type. - # - # Example: - # - # message ListLogEntriesRequest { - # string parent = 1 [(google.api.resource_reference) = { - # child_type: "logging.googleapis.com/LogEntry" - # }; - # } - class ResourceReference - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb deleted file mode 100644 index dd0b79ef3029..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/developers/knowledge/v1/developerknowledge.rb +++ /dev/null @@ -1,393 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Developers - module DeveloperKnowledge - module V1 - # A Document represents a page of documentation in the Developer Knowledge - # corpus, like the page at - # https://docs.cloud.google.com/storage/docs/creating-buckets. - # @!attribute [rw] name - # @return [::String] - # Identifier. Contains the resource name of the document. - # Format: `documents/{uri_without_scheme}` - # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - # @!attribute [r] uri - # @return [::String] - # Output only. Provides the URI of the content, such as - # `docs.cloud.google.com/storage/docs/creating-buckets`. - # @!attribute [r] content - # @return [::String] - # Output only. Contains the full content of the document in Markdown format. - # @!attribute [r] description - # @return [::String] - # Output only. Provides a description of the document. - # @!attribute [r] data_source - # @return [::String] - # Output only. Specifies the data source of the document. - # Example data source: `firebase.google.com` - # @!attribute [r] title - # @return [::String] - # Output only. Provides the title of the document. - # @!attribute [r] update_time - # @return [::Google::Protobuf::Timestamp] - # Output only. Represents the timestamp when the content or metadata of the - # document was last updated. - # @!attribute [r] view - # @return [::Google::Developers::DeveloperKnowledge::V1::DocumentView] - # Output only. Specifies the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the - # document. - # @!attribute [r] content_length_bytes - # @return [::Integer] - # Output only. The length of the `content` field in bytes. - class Document - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Request message for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks}. - # @!attribute [rw] query - # @return [::String] - # Required. Provides the raw query string provided by the user, such as "How - # to create a Cloud Storage bucket?". The query must not exceed 500 - # characters; values longer than 500 characters will result in an - # `INVALID_ARGUMENT` error. - # @!attribute [rw] page_size - # @return [::Integer] - # Optional. Specifies the maximum number of results to return. The service - # may return fewer than this value. - # - # If unspecified, at most 5 results will be returned. - # - # The maximum value is 100; values above 100 will be coerced to 100. - # @!attribute [rw] page_token - # @return [::String] - # Optional. Contains a page token, received from a previous - # `SearchDocumentChunks` call. Provide this to retrieve the subsequent page. - # @!attribute [rw] filter - # @return [::String] - # Optional. Applies a strict filter to the search results. The expression - # supports a subset of the syntax described at https://google.aip.dev/160. - # - # While `SearchDocumentChunks` returns - # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk}s, the filter - # is applied to `DocumentChunk.document` fields. - # - # Supported fields for filtering: - # - # * `content_length_bytes` (INTEGER): The length of the `Document.content` - # field in bytes. - # * `data_source` (STRING): The source of the document, e.g. - # `docs.cloud.google.com`. See - # https://developers.google.com/knowledge/reference/corpus-reference for - # the complete list of data sources in the corpus. - # * `update_time` (TIMESTAMP): The timestamp of when the document was last - # meaningfully updated. A meaningful update is one that changes document's - # markdown content or metadata. - # * `uri` (STRING): The document URI, e.g. - # `https://docs.cloud.google.com/bigquery/docs/tables`. - # - # INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. - # - # STRING fields support `=` (equals) and `!=` (not equals) operators for - # **exact match** on the whole string. Partial match, prefix match, and - # regexp match are not supported. - # - # TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. - # Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. - # - # Note: Field names must be in `snake_case` (e.g., `data_source`). Values on - # the right-hand side of filtering expressions must be string literals - # enclosed in double quotes (e.g., `"docs.cloud.google.com"`). - # - # You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical - # operators. `OR` has higher precedence than `AND`. Use parentheses for - # explicit precedence grouping. - # - # Examples: - # - # * Filter by `Document.content_length_bytes`: - # `content_length_bytes < 50000` - # * `data_source = "docs.cloud.google.com" OR data_source = - # "firebase.google.com"` - # * `data_source != "firebase.google.com"` - # * `update_time < "2024-01-01T00:00:00Z"` - # * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = - # "developer.chrome.com" OR data_source = "web.dev")` - # * `uri = "https://docs.cloud.google.com/release-notes"` - # - # The `filter` string must not exceed 500 characters; values longer than 500 - # characters will result in an `INVALID_ARGUMENT` error. - class SearchDocumentChunksRequest - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Response message for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks}. - # @!attribute [rw] results - # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::DocumentChunk>] - # Contains the search results for the given query. Each - # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk DocumentChunk} in this list - # contains a snippet of content relevant to the search query. Use the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentChunk#parent DocumentChunk.parent} - # field of each result with - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # to retrieve the full document content. - # @!attribute [rw] next_page_token - # @return [::String] - # Provides a token that can be sent as `page_token` to retrieve the next - # page. - # If this field is omitted, there are no subsequent pages. - class SearchDocumentChunksResponse - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Request message for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument}. - # @!attribute [rw] name - # @return [::String] - # Required. Specifies the name of the document to retrieve. - # Format: `documents/{uri_without_scheme}` - # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - # - # The name must not exceed 500 characters; values longer than 500 characters - # will result in an `INVALID_ARGUMENT` error. - # @!attribute [rw] view - # @return [::Google::Developers::DeveloperKnowledge::V1::DocumentView] - # Optional. Specifies the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the - # document. If unspecified, - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # defaults to `DOCUMENT_VIEW_CONTENT`. - class GetDocumentRequest - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Request message for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments}. - # @!attribute [rw] names - # @return [::Array<::String>] - # Required. Specifies the names of the documents to retrieve. A maximum of 20 - # documents can be retrieved in a batch. The documents are returned in the - # same order as the `names` in the request. - # - # Format: `documents/{uri_without_scheme}` - # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - # - # Each name must not exceed 500 characters; values longer than 500 characters - # will result in an `INVALID_ARGUMENT` error. - # @!attribute [rw] view - # @return [::Google::Developers::DeveloperKnowledge::V1::DocumentView] - # Optional. Specifies the - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the - # document. If unspecified, - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # defaults to `DOCUMENT_VIEW_CONTENT`. - class BatchGetDocumentsRequest - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Response message for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments}. - # @!attribute [rw] documents - # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Document>] - # Contains the documents requested. - class BatchGetDocumentsResponse - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Request message for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query DeveloperKnowledge.AnswerQuery}. - # @!attribute [rw] query - # @return [::String] - # Required. The query to answer. - class AnswerQueryRequest - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Response message for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query DeveloperKnowledge.AnswerQuery}. - # @!attribute [rw] answer - # @return [::Google::Developers::DeveloperKnowledge::V1::Answer] - # The answer to the query. - class AnswerQueryResponse - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # An answer to a query. - # @!attribute [rw] answer_text - # @return [::String] - # Contains the text of the answer. - # @!attribute [r] citations - # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerCitation>] - # Output only. Contains citations for the answer. - # @!attribute [r] references - # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerReference>] - # Output only. Contains references for the answer. - class Answer - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - - # Citation info for a segment. - # @!attribute [r] start_index - # @return [::Integer] - # Output only. Indicates the start of the segment, measured in bytes (UTF-8 - # unicode), inclusive. If there are multi-byte characters, such as - # non-ASCII characters, the index measurement is longer than the string - # length. - # @!attribute [r] end_index - # @return [::Integer] - # Output only. Indicates the end of the segment, measured in bytes (UTF-8 - # unicode), exclusive. If there are multi-byte characters, such as - # non-ASCII characters, the index measurement is longer than the string - # length. - # @!attribute [r] sources - # @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::CitationSource>] - # Output only. Contains citation sources for the attributed segment. - class AnswerCitation - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Citation source. - # @!attribute [r] reference_index - # @return [::Integer] - # Output only. Contains the index of the - # {::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerReference Answer.AnswerReference} - # in the `references` repeated field. - class CitationSource - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Represents a reference to a source. - # @!attribute [r] document_reference - # @return [::Google::Developers::DeveloperKnowledge::V1::Answer::DocumentReference] - # Output only. The reference document. - class AnswerReference - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Represents a reference to a document. - # @!attribute [r] document_chunk - # @return [::Google::Developers::DeveloperKnowledge::V1::DocumentChunk] - # Output only. Contains the document chunk. The `document_chunk.id` field - # is not set and will be empty. - class DocumentReference - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end - - # A DocumentChunk represents a piece of content from a - # {::Google::Developers::DeveloperKnowledge::V1::Document Document} in the DeveloperKnowledge - # corpus. To fetch the entire document content, pass the `parent` to - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments}. - # @!attribute [r] parent - # @return [::String] - # Output only. Contains the resource name of the document this chunk is from. - # Format: `documents/{uri_without_scheme}` - # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` - # @!attribute [r] id - # @return [::String] - # Output only. Specifies the ID of this chunk within the document. The chunk - # ID is unique within a document, but not globally unique across documents. - # The chunk ID is not stable and may change over time. - # @!attribute [r] content - # @return [::String] - # Output only. Contains the content of the document chunk. - # @!attribute [r] document - # @return [::Google::Developers::DeveloperKnowledge::V1::Document] - # Output only. Represents metadata about the - # {::Google::Developers::DeveloperKnowledge::V1::Document Document} this chunk is from. The - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of this - # {::Google::Developers::DeveloperKnowledge::V1::Document Document} message will be set to - # `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients - # do not need to call - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # if they only need the metadata fields. Otherwise, clients should use - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # or - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments} - # to fetch the full document content. - # @!attribute [r] relevance_score - # @return [::Float] - # Output only. Represents the relevance score of the chunk to the search - # query. Higher score indicates higher chunk relevance. The score is in range - # [0.0, 1.0]. - class DocumentChunk - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - - # Specifies which fields of the - # {::Google::Developers::DeveloperKnowledge::V1::Document Document} are included. - module DocumentView - # The default / unset value. See each API method for its default value if - # {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} is not - # specified. - DOCUMENT_VIEW_UNSPECIFIED = 0 - - # Includes only the basic metadata fields: - # - # - `name` - # - `uri` - # - `data_source` - # - `title` - # - `description` - # - `update_time` - # - `view` - # - `content_length_bytes` - # - # This is the default of view for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks}. - DOCUMENT_VIEW_BASIC = 1 - - # Includes all {::Google::Developers::DeveloperKnowledge::V1::Document Document} fields. - DOCUMENT_VIEW_FULL = 2 - - # Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. - # - # This is the default of view for - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document DeveloperKnowledge.GetDocument} - # and - # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents DeveloperKnowledge.BatchGetDocuments}. - DOCUMENT_VIEW_CONTENT = 3 - end - end - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/duration.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/duration.rb deleted file mode 100644 index ea59f1f91daf..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/duration.rb +++ /dev/null @@ -1,98 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Protobuf - # A Duration represents a signed, fixed-length span of time represented - # as a count of seconds and fractions of seconds at nanosecond - # resolution. It is independent of any calendar and concepts like "day" - # or "month". It is related to Timestamp in that the difference between - # two Timestamp values is a Duration and it can be added or subtracted - # from a Timestamp. Range is approximately +-10,000 years. - # - # # Examples - # - # Example 1: Compute Duration from two Timestamps in pseudo code. - # - # Timestamp start = ...; - # Timestamp end = ...; - # Duration duration = ...; - # - # duration.seconds = end.seconds - start.seconds; - # duration.nanos = end.nanos - start.nanos; - # - # if (duration.seconds < 0 && duration.nanos > 0) { - # duration.seconds += 1; - # duration.nanos -= 1000000000; - # } else if (duration.seconds > 0 && duration.nanos < 0) { - # duration.seconds -= 1; - # duration.nanos += 1000000000; - # } - # - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # - # Timestamp start = ...; - # Duration duration = ...; - # Timestamp end = ...; - # - # end.seconds = start.seconds + duration.seconds; - # end.nanos = start.nanos + duration.nanos; - # - # if (end.nanos < 0) { - # end.seconds -= 1; - # end.nanos += 1000000000; - # } else if (end.nanos >= 1000000000) { - # end.seconds += 1; - # end.nanos -= 1000000000; - # } - # - # Example 3: Compute Duration from datetime.timedelta in Python. - # - # td = datetime.timedelta(days=3, minutes=10) - # duration = Duration() - # duration.FromTimedelta(td) - # - # # JSON Mapping - # - # In JSON format, the Duration type is encoded as a string rather than an - # object, where the string ends in the suffix "s" (indicating seconds) and - # is preceded by the number of seconds, with nanoseconds expressed as - # fractional seconds. For example, 3 seconds with 0 nanoseconds should be - # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should - # be expressed in JSON format as "3.000000001s", and 3 seconds and 1 - # microsecond should be expressed in JSON format as "3.000001s". - # @!attribute [rw] seconds - # @return [::Integer] - # Signed seconds of the span of time. Must be from -315,576,000,000 - # to +315,576,000,000 inclusive. Note: these bounds are computed from: - # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - # @!attribute [rw] nanos - # @return [::Integer] - # Signed fractions of a second at nanosecond resolution of the span - # of time. Durations less than one second are represented with a 0 - # `seconds` field and a positive or negative `nanos` field. For durations - # of one second or more, a non-zero value for the `nanos` field must be - # of the same sign as the `seconds` field. Must be from -999,999,999 - # to +999,999,999 inclusive. - class Duration - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/timestamp.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/timestamp.rb deleted file mode 100644 index e58202461f88..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/proto_docs/google/protobuf/timestamp.rb +++ /dev/null @@ -1,128 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - - -module Google - module Protobuf - # A Timestamp represents a point in time independent of any time zone or local - # calendar, encoded as a count of seconds and fractions of seconds at - # nanosecond resolution. The count is relative to an epoch at UTC midnight on - # January 1, 1970, in the proleptic Gregorian calendar which extends the - # Gregorian calendar backwards to year one. - # - # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - # second table is needed for interpretation, using a [24-hour linear - # smear](https://developers.google.com/time/smear). - # - # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - # restricting to that range, we ensure that we can convert to and from [RFC - # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. - # - # # Examples - # - # Example 1: Compute Timestamp from POSIX `time()`. - # - # Timestamp timestamp; - # timestamp.set_seconds(time(NULL)); - # timestamp.set_nanos(0); - # - # Example 2: Compute Timestamp from POSIX `gettimeofday()`. - # - # struct timeval tv; - # gettimeofday(&tv, NULL); - # - # Timestamp timestamp; - # timestamp.set_seconds(tv.tv_sec); - # timestamp.set_nanos(tv.tv_usec * 1000); - # - # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - # - # FILETIME ft; - # GetSystemTimeAsFileTime(&ft); - # UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; - # - # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z - # // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. - # Timestamp timestamp; - # timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - # timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - # - # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - # - # long millis = System.currentTimeMillis(); - # - # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) - # .setNanos((int) ((millis % 1000) * 1000000)).build(); - # - # Example 5: Compute Timestamp from Java `Instant.now()`. - # - # Instant now = Instant.now(); - # - # Timestamp timestamp = - # Timestamp.newBuilder().setSeconds(now.getEpochSecond()) - # .setNanos(now.getNano()).build(); - # - # Example 6: Compute Timestamp from current time in Python. - # - # timestamp = Timestamp() - # timestamp.GetCurrentTime() - # - # # JSON Mapping - # - # In JSON format, the Timestamp type is encoded as a string in the - # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the - # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z" - # where \\{year} is always expressed using four digits while \\{month}, \\{day}, - # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional - # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), - # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone - # is required. A proto3 JSON serializer should always use UTC (as indicated by - # "Z") when printing the Timestamp type and a proto3 JSON parser should be - # able to accept both UTC and other timezones (as indicated by an offset). - # - # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past - # 01:30 UTC on January 15, 2017. - # - # In JavaScript, one can convert a Date object to this format using the - # standard - # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) - # method. In Python, a standard `datetime.datetime` object can be converted - # to this format using - # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with - # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use - # the Joda Time's [`ISODateTimeFormat.dateTime()`]( - # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() - # ) to obtain a formatter capable of generating timestamps in this format. - # @!attribute [rw] seconds - # @return [::Integer] - # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must - # be between -315576000000 and 315576000000 inclusive (which corresponds to - # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z). - # @!attribute [rw] nanos - # @return [::Integer] - # Non-negative fractions of a second at nanosecond resolution. This field is - # the nanosecond portion of the duration, not an alternative to seconds. - # Negative second values with fractions must still have non-negative nanos - # values that count forward in time. Must be between 0 and 999,999,999 - # inclusive. - class Timestamp - include ::Google::Protobuf::MessageExts - extend ::Google::Protobuf::MessageExts::ClassMethods - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/Gemfile b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/Gemfile deleted file mode 100644 index c5326ddd4ac6..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/Gemfile +++ /dev/null @@ -1,32 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -source "https://rubygems.org" - -if ENV["GOOGLE_CLOUD_SAMPLES_TEST"] == "master" - gem "google-developers-developer_knowledge-v1", path: "../" -else - gem "google-developers-developer_knowledge-v1" -end - -group :test do - gem "google-style", "~> 1.26.1" - gem "minitest", "~> 5.16" - gem "minitest-focus", "~> 1.1" - gem "minitest-hooks", "~> 1.5" -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/answer_query.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/answer_query.rb deleted file mode 100644 index 1da8579829f3..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/answer_query.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -# [START developerknowledge_v1_generated_DeveloperKnowledge_AnswerQuery_sync] -require "google/developers/developer_knowledge/v1" - -## -# Snippet for the answer_query call in the DeveloperKnowledge service -# -# This snippet has been automatically generated and should be regarded as a code -# template only. It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in https://cloud.google.com/ruby/docs/reference. -# -# This is an auto-generated example demonstrating basic usage of -# Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query. -# -def answer_query - # Create a client object. The client can be reused for multiple calls. - client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - - # Create a request. To set request fields, pass in keyword arguments. - request = Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new - - # Call the answer_query method. - result = client.answer_query request - - # The returned object is of type Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse. - p result -end -# [END developerknowledge_v1_generated_DeveloperKnowledge_AnswerQuery_sync] diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/batch_get_documents.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/batch_get_documents.rb deleted file mode 100644 index 6ea4b06d9af5..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/batch_get_documents.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -# [START developerknowledge_v1_generated_DeveloperKnowledge_BatchGetDocuments_sync] -require "google/developers/developer_knowledge/v1" - -## -# Snippet for the batch_get_documents call in the DeveloperKnowledge service -# -# This snippet has been automatically generated and should be regarded as a code -# template only. It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in https://cloud.google.com/ruby/docs/reference. -# -# This is an auto-generated example demonstrating basic usage of -# Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents. -# -def batch_get_documents - # Create a client object. The client can be reused for multiple calls. - client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - - # Create a request. To set request fields, pass in keyword arguments. - request = Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new - - # Call the batch_get_documents method. - result = client.batch_get_documents request - - # The returned object is of type Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse. - p result -end -# [END developerknowledge_v1_generated_DeveloperKnowledge_BatchGetDocuments_sync] diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/get_document.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/get_document.rb deleted file mode 100644 index 8cee8fa202c9..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/get_document.rb +++ /dev/null @@ -1,47 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -# [START developerknowledge_v1_generated_DeveloperKnowledge_GetDocument_sync] -require "google/developers/developer_knowledge/v1" - -## -# Snippet for the get_document call in the DeveloperKnowledge service -# -# This snippet has been automatically generated and should be regarded as a code -# template only. It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in https://cloud.google.com/ruby/docs/reference. -# -# This is an auto-generated example demonstrating basic usage of -# Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document. -# -def get_document - # Create a client object. The client can be reused for multiple calls. - client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - - # Create a request. To set request fields, pass in keyword arguments. - request = Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new - - # Call the get_document method. - result = client.get_document request - - # The returned object is of type Google::Developers::DeveloperKnowledge::V1::Document. - p result -end -# [END developerknowledge_v1_generated_DeveloperKnowledge_GetDocument_sync] diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/search_document_chunks.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/search_document_chunks.rb deleted file mode 100644 index bccd09dd9fcf..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/developer_knowledge/search_document_chunks.rb +++ /dev/null @@ -1,51 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -# [START developerknowledge_v1_generated_DeveloperKnowledge_SearchDocumentChunks_sync] -require "google/developers/developer_knowledge/v1" - -## -# Snippet for the search_document_chunks call in the DeveloperKnowledge service -# -# This snippet has been automatically generated and should be regarded as a code -# template only. It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in https://cloud.google.com/ruby/docs/reference. -# -# This is an auto-generated example demonstrating basic usage of -# Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks. -# -def search_document_chunks - # Create a client object. The client can be reused for multiple calls. - client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new - - # Create a request. To set request fields, pass in keyword arguments. - request = Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new - - # Call the search_document_chunks method. - result = client.search_document_chunks request - - # The returned object is of type Gapic::PagedEnumerable. You can iterate - # over elements, and API calls will be issued to fetch pages as needed. - result.each do |item| - # Each element is of type ::Google::Developers::DeveloperKnowledge::V1::DocumentChunk. - p item - end -end -# [END developerknowledge_v1_generated_DeveloperKnowledge_SearchDocumentChunks_sync] diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/snippet_metadata_google.developers.knowledge.v1.json b/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/snippet_metadata_google.developers.knowledge.v1.json deleted file mode 100644 index 9a973865b831..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/snippets/snippet_metadata_google.developers.knowledge.v1.json +++ /dev/null @@ -1,175 +0,0 @@ -{ - "client_library": { - "name": "google-developers-developer_knowledge-v1", - "version": "", - "language": "RUBY", - "apis": [ - { - "id": "google.developers.knowledge.v1", - "version": "v1" - } - ] - }, - "snippets": [ - { - "region_tag": "developerknowledge_v1_generated_DeveloperKnowledge_SearchDocumentChunks_sync", - "title": "Snippet for the search_document_chunks call in the DeveloperKnowledge service", - "description": "This is an auto-generated example demonstrating basic usage of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks.", - "file": "developer_knowledge/search_document_chunks.rb", - "language": "RUBY", - "client_method": { - "short_name": "search_document_chunks", - "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks", - "async": false, - "parameters": [ - { - "type": "::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest", - "name": "request" - } - ], - "result_type": "::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse", - "client": { - "short_name": "DeveloperKnowledge::Client", - "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client" - }, - "method": { - "short_name": "SearchDocumentChunks", - "full_name": "google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks", - "service": { - "short_name": "DeveloperKnowledge", - "full_name": "google.developers.knowledge.v1.DeveloperKnowledge" - } - } - }, - "canonical": true, - "origin": "API_DEFINITION", - "segments": [ - { - "start": 20, - "end": 50, - "type": "FULL" - } - ] - }, - { - "region_tag": "developerknowledge_v1_generated_DeveloperKnowledge_GetDocument_sync", - "title": "Snippet for the get_document call in the DeveloperKnowledge service", - "description": "This is an auto-generated example demonstrating basic usage of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document.", - "file": "developer_knowledge/get_document.rb", - "language": "RUBY", - "client_method": { - "short_name": "get_document", - "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#get_document", - "async": false, - "parameters": [ - { - "type": "::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest", - "name": "request" - } - ], - "result_type": "::Google::Developers::DeveloperKnowledge::V1::Document", - "client": { - "short_name": "DeveloperKnowledge::Client", - "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client" - }, - "method": { - "short_name": "GetDocument", - "full_name": "google.developers.knowledge.v1.DeveloperKnowledge.GetDocument", - "service": { - "short_name": "DeveloperKnowledge", - "full_name": "google.developers.knowledge.v1.DeveloperKnowledge" - } - } - }, - "canonical": true, - "origin": "API_DEFINITION", - "segments": [ - { - "start": 20, - "end": 46, - "type": "FULL" - } - ] - }, - { - "region_tag": "developerknowledge_v1_generated_DeveloperKnowledge_BatchGetDocuments_sync", - "title": "Snippet for the batch_get_documents call in the DeveloperKnowledge service", - "description": "This is an auto-generated example demonstrating basic usage of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents.", - "file": "developer_knowledge/batch_get_documents.rb", - "language": "RUBY", - "client_method": { - "short_name": "batch_get_documents", - "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#batch_get_documents", - "async": false, - "parameters": [ - { - "type": "::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest", - "name": "request" - } - ], - "result_type": "::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse", - "client": { - "short_name": "DeveloperKnowledge::Client", - "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client" - }, - "method": { - "short_name": "BatchGetDocuments", - "full_name": "google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments", - "service": { - "short_name": "DeveloperKnowledge", - "full_name": "google.developers.knowledge.v1.DeveloperKnowledge" - } - } - }, - "canonical": true, - "origin": "API_DEFINITION", - "segments": [ - { - "start": 20, - "end": 46, - "type": "FULL" - } - ] - }, - { - "region_tag": "developerknowledge_v1_generated_DeveloperKnowledge_AnswerQuery_sync", - "title": "Snippet for the answer_query call in the DeveloperKnowledge service", - "description": "This is an auto-generated example demonstrating basic usage of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query.", - "file": "developer_knowledge/answer_query.rb", - "language": "RUBY", - "client_method": { - "short_name": "answer_query", - "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query", - "async": false, - "parameters": [ - { - "type": "::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest", - "name": "request" - } - ], - "result_type": "::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse", - "client": { - "short_name": "DeveloperKnowledge::Client", - "full_name": "::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client" - }, - "method": { - "short_name": "AnswerQuery", - "full_name": "google.developers.knowledge.v1.DeveloperKnowledge.AnswerQuery", - "service": { - "short_name": "DeveloperKnowledge", - "full_name": "google.developers.knowledge.v1.DeveloperKnowledge" - } - } - }, - "canonical": true, - "origin": "API_DEFINITION", - "segments": [ - { - "start": 20, - "end": 46, - "type": "FULL" - } - ] - } - ] -} \ No newline at end of file diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_paths_test.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_paths_test.rb deleted file mode 100644 index 025870f575c3..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_paths_test.rb +++ /dev/null @@ -1,55 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "helper" - -require "gapic/grpc/service_stub" - -require "google/developers/developer_knowledge/v1/developer_knowledge" - -class ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::ClientPathsTest < Minitest::Test - class DummyStub - def endpoint - "endpoint.example.com" - end - - def universe_domain - "example.com" - end - - def stub_logger - nil - end - - def logger - nil - end - end - - def test_document_path - grpc_channel = ::GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure - ::Gapic::ServiceStub.stub :new, DummyStub.new do - client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.credentials = grpc_channel - end - - path = client.document_path document: "value0" - assert_equal "documents/value0", path - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_rest_test.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_rest_test.rb deleted file mode 100644 index 9521d08dc860..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_rest_test.rb +++ /dev/null @@ -1,320 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "helper" -require "gapic/rest" -require "google/developers/knowledge/v1/developerknowledge_pb" -require "google/developers/developer_knowledge/v1/developer_knowledge/rest" - - -class ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ClientTest < Minitest::Test - class ClientStub - attr_accessor :call_count, :requests - - def initialize response, &block - @response = response - @block = block - @call_count = 0 - @requests = [] - end - - def make_get_request uri:, params: {}, options: {}, method_name: nil - make_http_request :get, uri: uri, body: nil, params: params, options: options, method_name: method_name - end - - def make_delete_request uri:, params: {}, options: {}, method_name: nil - make_http_request :delete, uri: uri, body: nil, params: params, options: options, method_name: method_name - end - - def make_post_request uri:, body: nil, params: {}, options: {}, method_name: nil - make_http_request :post, uri: uri, body: body, params: params, options: options, method_name: method_name - end - - def make_patch_request uri:, body:, params: {}, options: {}, method_name: nil - make_http_request :patch, uri: uri, body: body, params: params, options: options, method_name: method_name - end - - def make_put_request uri:, body:, params: {}, options: {}, method_name: nil - make_http_request :put, uri: uri, body: body, params: params, options: options, method_name: method_name - end - - def make_http_request *args, **kwargs - @call_count += 1 - - @requests << @block&.call(*args, **kwargs) - - @response - end - - def endpoint - "endpoint.example.com" - end - - def universe_domain - "example.com" - end - - def stub_logger - nil - end - - def logger - nil - end - end - - def test_search_document_chunks - # Create test objects. - client_result = ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse.new - http_response = OpenStruct.new body: client_result.to_json - - call_options = {} - - # Create request parameters for a unary method. - query = "hello world" - page_size = 42 - page_token = "hello world" - filter = "hello world" - - search_document_chunks_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:| - assert options.metadata.key? :"x-goog-api-client" - assert options.metadata[:"x-goog-api-client"].include? "rest" - refute options.metadata[:"x-goog-api-client"].include? "grpc" - end - - ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.stub :transcode_search_document_chunks_request, ["", "", {}] do - Gapic::Rest::ClientStub.stub :new, search_document_chunks_client_stub do - # Create client - c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| - config.credentials = :dummy_value - end - - # Use hash object - c.search_document_chunks({ query: query, page_size: page_size, page_token: page_token, filter: filter }) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use named arguments - c.search_document_chunks query: query, page_size: page_size, page_token: page_token, filter: filter do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use protobuf object - c.search_document_chunks ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new(query: query, page_size: page_size, page_token: page_token, filter: filter) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use hash object with options - c.search_document_chunks({ query: query, page_size: page_size, page_token: page_token, filter: filter }, call_options) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use protobuf object with options - c.search_document_chunks(::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new(query: query, page_size: page_size, page_token: page_token, filter: filter), call_options) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Verify method calls - assert_equal 5, search_document_chunks_client_stub.call_count - end - end - end - - def test_get_document - # Create test objects. - client_result = ::Google::Developers::DeveloperKnowledge::V1::Document.new - http_response = OpenStruct.new body: client_result.to_json - - call_options = {} - - # Create request parameters for a unary method. - name = "hello world" - view = :DOCUMENT_VIEW_UNSPECIFIED - - get_document_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:| - assert options.metadata.key? :"x-goog-api-client" - assert options.metadata[:"x-goog-api-client"].include? "rest" - refute options.metadata[:"x-goog-api-client"].include? "grpc" - end - - ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.stub :transcode_get_document_request, ["", "", {}] do - Gapic::Rest::ClientStub.stub :new, get_document_client_stub do - # Create client - c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| - config.credentials = :dummy_value - end - - # Use hash object - c.get_document({ name: name, view: view }) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use named arguments - c.get_document name: name, view: view do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use protobuf object - c.get_document ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new(name: name, view: view) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use hash object with options - c.get_document({ name: name, view: view }, call_options) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use protobuf object with options - c.get_document(::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new(name: name, view: view), call_options) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Verify method calls - assert_equal 5, get_document_client_stub.call_count - end - end - end - - def test_batch_get_documents - # Create test objects. - client_result = ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse.new - http_response = OpenStruct.new body: client_result.to_json - - call_options = {} - - # Create request parameters for a unary method. - names = ["hello world"] - view = :DOCUMENT_VIEW_UNSPECIFIED - - batch_get_documents_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:| - assert options.metadata.key? :"x-goog-api-client" - assert options.metadata[:"x-goog-api-client"].include? "rest" - refute options.metadata[:"x-goog-api-client"].include? "grpc" - end - - ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.stub :transcode_batch_get_documents_request, ["", "", {}] do - Gapic::Rest::ClientStub.stub :new, batch_get_documents_client_stub do - # Create client - c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| - config.credentials = :dummy_value - end - - # Use hash object - c.batch_get_documents({ names: names, view: view }) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use named arguments - c.batch_get_documents names: names, view: view do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use protobuf object - c.batch_get_documents ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new(names: names, view: view) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use hash object with options - c.batch_get_documents({ names: names, view: view }, call_options) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use protobuf object with options - c.batch_get_documents(::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new(names: names, view: view), call_options) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Verify method calls - assert_equal 5, batch_get_documents_client_stub.call_count - end - end - end - - def test_answer_query - # Create test objects. - client_result = ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.new - http_response = OpenStruct.new body: client_result.to_json - - call_options = {} - - # Create request parameters for a unary method. - query = "hello world" - - answer_query_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:| - assert options.metadata.key? :"x-goog-api-client" - assert options.metadata[:"x-goog-api-client"].include? "rest" - refute options.metadata[:"x-goog-api-client"].include? "grpc" - end - - ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::ServiceStub.stub :transcode_answer_query_request, ["", "", {}] do - Gapic::Rest::ClientStub.stub :new, answer_query_client_stub do - # Create client - c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| - config.credentials = :dummy_value - end - - # Use hash object - c.answer_query({ query: query }) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use named arguments - c.answer_query query: query do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use protobuf object - c.answer_query ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new(query: query) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use hash object with options - c.answer_query({ query: query }, call_options) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Use protobuf object with options - c.answer_query(::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new(query: query), call_options) do |_result, response| - assert_equal http_response, response.underlying_op - end - - # Verify method calls - assert_equal 5, answer_query_client_stub.call_count - end - end - end - - def test_configure - credentials_token = :dummy_value - - client = block_config = config = nil - dummy_stub = ClientStub.new nil - Gapic::Rest::ClientStub.stub :new, dummy_stub do - client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new do |config| - config.credentials = credentials_token - end - end - - config = client.configure do |c| - block_config = c - end - - assert_same block_config, config - assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client::Configuration, config - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_test.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_test.rb deleted file mode 100644 index a43b73fefb45..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/test/google/developers/developer_knowledge/v1/developer_knowledge_test.rb +++ /dev/null @@ -1,351 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -require "helper" - -require "gapic/grpc/service_stub" - -require "google/developers/knowledge/v1/developerknowledge_pb" -require "google/developers/developer_knowledge/v1/developer_knowledge" - -class ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::ClientTest < Minitest::Test - class ClientStub - attr_accessor :call_rpc_count, :requests - - def initialize response, operation, &block - @response = response - @operation = operation - @block = block - @call_rpc_count = 0 - @requests = [] - end - - def call_rpc *args, **kwargs - @call_rpc_count += 1 - - @requests << @block&.call(*args, **kwargs) - - catch :response do - yield @response, @operation if block_given? - @response - end - end - - def endpoint - "endpoint.example.com" - end - - def universe_domain - "example.com" - end - - def stub_logger - nil - end - - def logger - nil - end - end - - def test_search_document_chunks - # Create GRPC objects. - grpc_response = ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksResponse.new - grpc_operation = GRPC::ActiveCall::Operation.new nil - grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure - grpc_options = {} - - # Create request parameters for a unary method. - query = "hello world" - page_size = 42 - page_token = "hello world" - filter = "hello world" - - search_document_chunks_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:| - assert_equal :search_document_chunks, name - assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest, request - assert_equal "hello world", request["query"] - assert_equal 42, request["page_size"] - assert_equal "hello world", request["page_token"] - assert_equal "hello world", request["filter"] - refute_nil options - end - - Gapic::ServiceStub.stub :new, search_document_chunks_client_stub do - # Create client - c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.credentials = grpc_channel - end - - # Use hash object - c.search_document_chunks({ query: query, page_size: page_size, page_token: page_token, filter: filter }) do |response, operation| - assert_kind_of Gapic::PagedEnumerable, response - assert_equal grpc_response, response.response - assert_equal grpc_operation, operation - end - - # Use named arguments - c.search_document_chunks query: query, page_size: page_size, page_token: page_token, filter: filter do |response, operation| - assert_kind_of Gapic::PagedEnumerable, response - assert_equal grpc_response, response.response - assert_equal grpc_operation, operation - end - - # Use protobuf object - c.search_document_chunks ::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new(query: query, page_size: page_size, page_token: page_token, filter: filter) do |response, operation| - assert_kind_of Gapic::PagedEnumerable, response - assert_equal grpc_response, response.response - assert_equal grpc_operation, operation - end - - # Use hash object with options - c.search_document_chunks({ query: query, page_size: page_size, page_token: page_token, filter: filter }, grpc_options) do |response, operation| - assert_kind_of Gapic::PagedEnumerable, response - assert_equal grpc_response, response.response - assert_equal grpc_operation, operation - end - - # Use protobuf object with options - c.search_document_chunks(::Google::Developers::DeveloperKnowledge::V1::SearchDocumentChunksRequest.new(query: query, page_size: page_size, page_token: page_token, filter: filter), grpc_options) do |response, operation| - assert_kind_of Gapic::PagedEnumerable, response - assert_equal grpc_response, response.response - assert_equal grpc_operation, operation - end - - # Verify method calls - assert_equal 5, search_document_chunks_client_stub.call_rpc_count - end - end - - def test_get_document - # Create GRPC objects. - grpc_response = ::Google::Developers::DeveloperKnowledge::V1::Document.new - grpc_operation = GRPC::ActiveCall::Operation.new nil - grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure - grpc_options = {} - - # Create request parameters for a unary method. - name = "hello world" - view = :DOCUMENT_VIEW_UNSPECIFIED - - get_document_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:| - assert_equal :get_document, name - assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, request - assert_equal "hello world", request["name"] - assert_equal :DOCUMENT_VIEW_UNSPECIFIED, request["view"] - refute_nil options - end - - Gapic::ServiceStub.stub :new, get_document_client_stub do - # Create client - c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.credentials = grpc_channel - end - - # Use hash object - c.get_document({ name: name, view: view }) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use named arguments - c.get_document name: name, view: view do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use protobuf object - c.get_document ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new(name: name, view: view) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use hash object with options - c.get_document({ name: name, view: view }, grpc_options) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use protobuf object with options - c.get_document(::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest.new(name: name, view: view), grpc_options) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Verify method calls - assert_equal 5, get_document_client_stub.call_rpc_count - end - end - - def test_batch_get_documents - # Create GRPC objects. - grpc_response = ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse.new - grpc_operation = GRPC::ActiveCall::Operation.new nil - grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure - grpc_options = {} - - # Create request parameters for a unary method. - names = ["hello world"] - view = :DOCUMENT_VIEW_UNSPECIFIED - - batch_get_documents_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:| - assert_equal :batch_get_documents, name - assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, request - assert_equal ["hello world"], request["names"] - assert_equal :DOCUMENT_VIEW_UNSPECIFIED, request["view"] - refute_nil options - end - - Gapic::ServiceStub.stub :new, batch_get_documents_client_stub do - # Create client - c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.credentials = grpc_channel - end - - # Use hash object - c.batch_get_documents({ names: names, view: view }) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use named arguments - c.batch_get_documents names: names, view: view do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use protobuf object - c.batch_get_documents ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new(names: names, view: view) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use hash object with options - c.batch_get_documents({ names: names, view: view }, grpc_options) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use protobuf object with options - c.batch_get_documents(::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest.new(names: names, view: view), grpc_options) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Verify method calls - assert_equal 5, batch_get_documents_client_stub.call_rpc_count - end - end - - def test_answer_query - # Create GRPC objects. - grpc_response = ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.new - grpc_operation = GRPC::ActiveCall::Operation.new nil - grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure - grpc_options = {} - - # Create request parameters for a unary method. - query = "hello world" - - answer_query_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:| - assert_equal :answer_query, name - assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, request - assert_equal "hello world", request["query"] - refute_nil options - end - - Gapic::ServiceStub.stub :new, answer_query_client_stub do - # Create client - c = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.credentials = grpc_channel - end - - # Use hash object - c.answer_query({ query: query }) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use named arguments - c.answer_query query: query do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use protobuf object - c.answer_query ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new(query: query) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use hash object with options - c.answer_query({ query: query }, grpc_options) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Use protobuf object with options - c.answer_query(::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new(query: query), grpc_options) do |response, operation| - assert_equal grpc_response, response - assert_equal grpc_operation, operation - end - - # Verify method calls - assert_equal 5, answer_query_client_stub.call_rpc_count - end - end - - def test_configure - grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure - - client = block_config = config = nil - dummy_stub = ClientStub.new nil, nil - Gapic::ServiceStub.stub :new, dummy_stub do - client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.credentials = grpc_channel - end - end - - config = client.configure do |c| - block_config = c - end - - assert_same block_config, config - assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client::Configuration, config - end - - def test_credentials - key = OpenSSL::PKey::RSA.new 2048 - cred_json = { - "private_key" => key.to_pem, - "client_email" => "app@developer.gserviceaccount.com", - "type" => "service_account" - } - key_file = StringIO.new cred_json.to_json - creds = Google::Auth::ServiceAccountCredentials.make_creds({ json_key_io: key_file }) - - dummy_stub = ClientStub.new nil, nil - Gapic::ServiceStub.stub :new, dummy_stub do - client = ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new do |config| - config.credentials = creds - end - assert_kind_of ::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client, client - assert_equal creds, client.configure.credentials - end - end -end diff --git a/owl-bot-staging/google-developers-developer_knowledge-v1/test/helper.rb b/owl-bot-staging/google-developers-developer_knowledge-v1/test/helper.rb deleted file mode 100644 index 4fb6756ac7e2..000000000000 --- a/owl-bot-staging/google-developers-developer_knowledge-v1/test/helper.rb +++ /dev/null @@ -1,35 +0,0 @@ -# frozen_string_literal: true - -# Copyright 2026 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Auto-generated by gapic-generator-ruby. DO NOT EDIT! - -# Load JUnit XML formatter from googleapis/ruby-common-tools to write -# tmp/reports/sponge_log.xml for Kokoro/TestGrid build health tracking. -if ENV["CI"] || ENV["KOKORO_JOB_NAME"] - begin - require "gapic/minitest_junit_preloader" - rescue LoadError - end -end - -require "minitest/autorun" -require "minitest/focus" -require "minitest/mock" -require "minitest/rg" - -require "grpc" - -require "ostruct"