google-apis-developerknowledge_v1 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 05267ac75f55d1fc39d869623bc1b3c0c97ff9ea11652124503cd83477a9a13d
4
+ data.tar.gz: ce62c4f8d3cc814b21570ce4b67eb442f83ec48cba3ddbfc40674fd4b04ed9cf
5
+ SHA512:
6
+ metadata.gz: 5d9dc43b243d573e337e4338aee1b5bbfcd40fac2d36cf1f6b180c86875a203d6f356f8f3b2577b667602730d1731e6ebac4f9e92ff8567335b82902edb96d96
7
+ data.tar.gz: bbf2efc69f610ba4ebd3306ccbb6962b67a2f8dacac64ea13b030208c15ce2041c84441052219f52a86216d6c64ff5b17c183ed43c37279953042a8fdd90df2f
data/.yardopts ADDED
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-developerknowledge_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/developerknowledge_v1/*.rb
9
+ lib/google/apis/developerknowledge_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-developerknowledge_v1
2
+
3
+ ### v0.1.0 (2026-04-26)
4
+
5
+ * Regenerated from discovery document revision 20260413
6
+ * Regenerated using generator version 0.18.0
7
+
data/LICENSE.md ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/OVERVIEW.md ADDED
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1 of the Developer Knowledge API
2
+
3
+ This is a simple client library for version V1 of the Developer Knowledge API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/developerknowledge.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-developerknowledge_v1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-developerknowledge_v1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/developerknowledge_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::DeveloperknowledgeV1::DeveloperKnowledgeService.new
52
+
53
+ # Authenticate calls
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Developerknowledge service in particular.)
67
+
68
+ For reference information on specific calls in the Developer Knowledge API, see the {Google::Apis::DeveloperknowledgeV1::DeveloperKnowledgeService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-developerknowledge_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://developers.google.com/knowledge) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 3.1+.
87
+
88
+ 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.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,184 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module DeveloperknowledgeV1
24
+
25
+ # Response message for DeveloperKnowledge.BatchGetDocuments.
26
+ class BatchGetDocumentsResponse
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Contains the documents requested.
30
+ # Corresponds to the JSON property `documents`
31
+ # @return [Array<Google::Apis::DeveloperknowledgeV1::Document>]
32
+ attr_accessor :documents
33
+
34
+ def initialize(**args)
35
+ update!(**args)
36
+ end
37
+
38
+ # Update properties of this object
39
+ def update!(**args)
40
+ @documents = args[:documents] if args.key?(:documents)
41
+ end
42
+ end
43
+
44
+ # A Document represents a piece of content from the Developer Knowledge corpus.
45
+ class Document
46
+ include Google::Apis::Core::Hashable
47
+
48
+ # Output only. Contains the full content of the document in Markdown format.
49
+ # Corresponds to the JSON property `content`
50
+ # @return [String]
51
+ attr_accessor :content
52
+
53
+ # Output only. Specifies the data source of the document. Example data source: `
54
+ # firebase.google.com`
55
+ # Corresponds to the JSON property `dataSource`
56
+ # @return [String]
57
+ attr_accessor :data_source
58
+
59
+ # Output only. Provides a description of the document.
60
+ # Corresponds to the JSON property `description`
61
+ # @return [String]
62
+ attr_accessor :description
63
+
64
+ # Identifier. Contains the resource name of the document. Format: `documents/`
65
+ # uri_without_scheme`` Example: `documents/docs.cloud.google.com/storage/docs/
66
+ # creating-buckets`
67
+ # Corresponds to the JSON property `name`
68
+ # @return [String]
69
+ attr_accessor :name
70
+
71
+ # Output only. Provides the title of the document.
72
+ # Corresponds to the JSON property `title`
73
+ # @return [String]
74
+ attr_accessor :title
75
+
76
+ # Output only. Represents the timestamp when the content or metadata of the
77
+ # document was last updated.
78
+ # Corresponds to the JSON property `updateTime`
79
+ # @return [String]
80
+ attr_accessor :update_time
81
+
82
+ # Output only. Provides the URI of the content, such as `docs.cloud.google.com/
83
+ # storage/docs/creating-buckets`.
84
+ # Corresponds to the JSON property `uri`
85
+ # @return [String]
86
+ attr_accessor :uri
87
+
88
+ # Output only. Specifies the DocumentView of the document.
89
+ # Corresponds to the JSON property `view`
90
+ # @return [String]
91
+ attr_accessor :view
92
+
93
+ def initialize(**args)
94
+ update!(**args)
95
+ end
96
+
97
+ # Update properties of this object
98
+ def update!(**args)
99
+ @content = args[:content] if args.key?(:content)
100
+ @data_source = args[:data_source] if args.key?(:data_source)
101
+ @description = args[:description] if args.key?(:description)
102
+ @name = args[:name] if args.key?(:name)
103
+ @title = args[:title] if args.key?(:title)
104
+ @update_time = args[:update_time] if args.key?(:update_time)
105
+ @uri = args[:uri] if args.key?(:uri)
106
+ @view = args[:view] if args.key?(:view)
107
+ end
108
+ end
109
+
110
+ # A DocumentChunk represents a piece of content from a Document in the
111
+ # DeveloperKnowledge corpus. To fetch the entire document content, pass the `
112
+ # parent` to DeveloperKnowledge.GetDocument or DeveloperKnowledge.
113
+ # BatchGetDocuments.
114
+ class DocumentChunk
115
+ include Google::Apis::Core::Hashable
116
+
117
+ # Output only. Contains the content of the document chunk.
118
+ # Corresponds to the JSON property `content`
119
+ # @return [String]
120
+ attr_accessor :content
121
+
122
+ # A Document represents a piece of content from the Developer Knowledge corpus.
123
+ # Corresponds to the JSON property `document`
124
+ # @return [Google::Apis::DeveloperknowledgeV1::Document]
125
+ attr_accessor :document
126
+
127
+ # Output only. Specifies the ID of this chunk within the document. The chunk ID
128
+ # is unique within a document, but not globally unique across documents. The
129
+ # chunk ID is not stable and may change over time.
130
+ # Corresponds to the JSON property `id`
131
+ # @return [String]
132
+ attr_accessor :id
133
+
134
+ # Output only. Contains the resource name of the document this chunk is from.
135
+ # Format: `documents/`uri_without_scheme`` Example: `documents/docs.cloud.google.
136
+ # com/storage/docs/creating-buckets`
137
+ # Corresponds to the JSON property `parent`
138
+ # @return [String]
139
+ attr_accessor :parent
140
+
141
+ def initialize(**args)
142
+ update!(**args)
143
+ end
144
+
145
+ # Update properties of this object
146
+ def update!(**args)
147
+ @content = args[:content] if args.key?(:content)
148
+ @document = args[:document] if args.key?(:document)
149
+ @id = args[:id] if args.key?(:id)
150
+ @parent = args[:parent] if args.key?(:parent)
151
+ end
152
+ end
153
+
154
+ # Response message for DeveloperKnowledge.SearchDocumentChunks.
155
+ class SearchDocumentChunksResponse
156
+ include Google::Apis::Core::Hashable
157
+
158
+ # Optional. Provides a token that can be sent as `page_token` to retrieve the
159
+ # next page. If this field is omitted, there are no subsequent pages.
160
+ # Corresponds to the JSON property `nextPageToken`
161
+ # @return [String]
162
+ attr_accessor :next_page_token
163
+
164
+ # Contains the search results for the given query. Each DocumentChunk in this
165
+ # list contains a snippet of content relevant to the search query. Use the
166
+ # DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument
167
+ # or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.
168
+ # Corresponds to the JSON property `results`
169
+ # @return [Array<Google::Apis::DeveloperknowledgeV1::DocumentChunk>]
170
+ attr_accessor :results
171
+
172
+ def initialize(**args)
173
+ update!(**args)
174
+ end
175
+
176
+ # Update properties of this object
177
+ def update!(**args)
178
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
179
+ @results = args[:results] if args.key?(:results)
180
+ end
181
+ end
182
+ end
183
+ end
184
+ end
@@ -0,0 +1,28 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ module Google
16
+ module Apis
17
+ module DeveloperknowledgeV1
18
+ # Version of the google-apis-developerknowledge_v1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.18.0"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20260413"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,92 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module DeveloperknowledgeV1
24
+
25
+ class BatchGetDocumentsResponse
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class Document
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class DocumentChunk
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class SearchDocumentChunksResponse
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class BatchGetDocumentsResponse
50
+ # @private
51
+ class Representation < Google::Apis::Core::JsonRepresentation
52
+ collection :documents, as: 'documents', class: Google::Apis::DeveloperknowledgeV1::Document, decorator: Google::Apis::DeveloperknowledgeV1::Document::Representation
53
+
54
+ end
55
+ end
56
+
57
+ class Document
58
+ # @private
59
+ class Representation < Google::Apis::Core::JsonRepresentation
60
+ property :content, as: 'content'
61
+ property :data_source, as: 'dataSource'
62
+ property :description, as: 'description'
63
+ property :name, as: 'name'
64
+ property :title, as: 'title'
65
+ property :update_time, as: 'updateTime'
66
+ property :uri, as: 'uri'
67
+ property :view, as: 'view'
68
+ end
69
+ end
70
+
71
+ class DocumentChunk
72
+ # @private
73
+ class Representation < Google::Apis::Core::JsonRepresentation
74
+ property :content, as: 'content'
75
+ property :document, as: 'document', class: Google::Apis::DeveloperknowledgeV1::Document, decorator: Google::Apis::DeveloperknowledgeV1::Document::Representation
76
+
77
+ property :id, as: 'id'
78
+ property :parent, as: 'parent'
79
+ end
80
+ end
81
+
82
+ class SearchDocumentChunksResponse
83
+ # @private
84
+ class Representation < Google::Apis::Core::JsonRepresentation
85
+ property :next_page_token, as: 'nextPageToken'
86
+ collection :results, as: 'results', class: Google::Apis::DeveloperknowledgeV1::DocumentChunk, decorator: Google::Apis::DeveloperknowledgeV1::DocumentChunk::Representation
87
+
88
+ end
89
+ end
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,206 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module DeveloperknowledgeV1
23
+ # Developer Knowledge API
24
+ #
25
+ # The Developer Knowledge API provides access to Google's developer knowledge.
26
+ #
27
+ # @example
28
+ # require 'google/apis/developerknowledge_v1'
29
+ #
30
+ # Developerknowledge = Google::Apis::DeveloperknowledgeV1 # Alias the module
31
+ # service = Developerknowledge::DeveloperKnowledgeService.new
32
+ #
33
+ # @see https://developers.google.com/knowledge
34
+ class DeveloperKnowledgeService < Google::Apis::Core::BaseService
35
+ DEFAULT_ENDPOINT_TEMPLATE = "https://developerknowledge.$UNIVERSE_DOMAIN$/"
36
+
37
+ # @return [String]
38
+ # API key. Your API key identifies your project and provides you with API access,
39
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
40
+ attr_accessor :key
41
+
42
+ # @return [String]
43
+ # Available to use for quota purposes for server-side applications. Can be any
44
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
45
+ attr_accessor :quota_user
46
+
47
+ def initialize
48
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
49
+ client_name: 'google-apis-developerknowledge_v1',
50
+ client_version: Google::Apis::DeveloperknowledgeV1::GEM_VERSION)
51
+ @batch_path = 'batch'
52
+ end
53
+
54
+ # Retrieves multiple documents, each with its full Markdown content.
55
+ # @param [Array<String>, String] names
56
+ # Required. Specifies the names of the documents to retrieve. A maximum of 20
57
+ # documents can be retrieved in a batch. The documents are returned in the same
58
+ # order as the `names` in the request. Format: `documents/`uri_without_scheme``
59
+ # Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
60
+ # @param [String] view
61
+ # Optional. Specifies the DocumentView of the document. If unspecified,
62
+ # DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`.
63
+ # @param [String] fields
64
+ # Selector specifying which fields to include in a partial response.
65
+ # @param [String] quota_user
66
+ # Available to use for quota purposes for server-side applications. Can be any
67
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
68
+ # @param [Google::Apis::RequestOptions] options
69
+ # Request-specific options
70
+ #
71
+ # @yield [result, err] Result & error if block supplied
72
+ # @yieldparam result [Google::Apis::DeveloperknowledgeV1::BatchGetDocumentsResponse] parsed result object
73
+ # @yieldparam err [StandardError] error object if request failed
74
+ #
75
+ # @return [Google::Apis::DeveloperknowledgeV1::BatchGetDocumentsResponse]
76
+ #
77
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
78
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
79
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
80
+ def batch_document_get(names: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
81
+ command = make_simple_command(:get, 'v1/documents:batchGet', options)
82
+ command.response_representation = Google::Apis::DeveloperknowledgeV1::BatchGetDocumentsResponse::Representation
83
+ command.response_class = Google::Apis::DeveloperknowledgeV1::BatchGetDocumentsResponse
84
+ command.query['names'] = names unless names.nil?
85
+ command.query['view'] = view unless view.nil?
86
+ command.query['fields'] = fields unless fields.nil?
87
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
88
+ execute_or_queue_command(command, &block)
89
+ end
90
+
91
+ # Retrieves a single document with its full Markdown content.
92
+ # @param [String] name
93
+ # Required. Specifies the name of the document to retrieve. Format: `documents/`
94
+ # uri_without_scheme`` Example: `documents/docs.cloud.google.com/storage/docs/
95
+ # creating-buckets`
96
+ # @param [String] view
97
+ # Optional. Specifies the DocumentView of the document. If unspecified,
98
+ # DeveloperKnowledge.GetDocument defaults to `DOCUMENT_VIEW_CONTENT`.
99
+ # @param [String] fields
100
+ # Selector specifying which fields to include in a partial response.
101
+ # @param [String] quota_user
102
+ # Available to use for quota purposes for server-side applications. Can be any
103
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
104
+ # @param [Google::Apis::RequestOptions] options
105
+ # Request-specific options
106
+ #
107
+ # @yield [result, err] Result & error if block supplied
108
+ # @yieldparam result [Google::Apis::DeveloperknowledgeV1::Document] parsed result object
109
+ # @yieldparam err [StandardError] error object if request failed
110
+ #
111
+ # @return [Google::Apis::DeveloperknowledgeV1::Document]
112
+ #
113
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
114
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
115
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
116
+ def get_document(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
117
+ command = make_simple_command(:get, 'v1/{+name}', options)
118
+ command.response_representation = Google::Apis::DeveloperknowledgeV1::Document::Representation
119
+ command.response_class = Google::Apis::DeveloperknowledgeV1::Document
120
+ command.params['name'] = name unless name.nil?
121
+ command.query['view'] = view unless view.nil?
122
+ command.query['fields'] = fields unless fields.nil?
123
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
124
+ execute_or_queue_command(command, &block)
125
+ end
126
+
127
+ # Searches for developer knowledge across Google's developer documentation.
128
+ # Returns DocumentChunks based on the user's query. There may be many chunks
129
+ # from the same Document. To retrieve full documents, use DeveloperKnowledge.
130
+ # GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.
131
+ # parent returned in the SearchDocumentChunksResponse.results.
132
+ # @param [String] filter
133
+ # Optional. Applies a strict filter to the search results. The expression
134
+ # supports a subset of the syntax described at https://google.aip.dev/160. While
135
+ # `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `
136
+ # DocumentChunk.document` fields. Supported fields for filtering: * `data_source`
137
+ # (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https:
138
+ # //developers.google.com/knowledge/reference/corpus-reference for the complete
139
+ # list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp
140
+ # of when the document was last meaningfully updated. A meaningful update is one
141
+ # that changes document's markdown content or metadata. * `uri` (STRING): The
142
+ # document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`.
143
+ # STRING fields support `=` (equals) and `!=` (not equals) operators for **exact
144
+ # match** on the whole string. Partial match, prefix match, and regexp match are
145
+ # not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=`
146
+ # operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"
147
+ # `. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical
148
+ # operators. `OR` has higher precedence than `AND`. Use parentheses for explicit
149
+ # precedence grouping. Examples: * `data_source = "docs.cloud.google.com" OR
150
+ # data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` *
151
+ # `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:
152
+ # 00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `
153
+ # uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must
154
+ # not exceed 500 characters; values longer than 500 characters will result in an
155
+ # `INVALID_ARGUMENT` error.
156
+ # @param [Fixnum] page_size
157
+ # Optional. Specifies the maximum number of results to return. The service may
158
+ # return fewer than this value. If unspecified, at most 5 results will be
159
+ # returned. The maximum value is 20; values above 20 will result in an
160
+ # INVALID_ARGUMENT error.
161
+ # @param [String] page_token
162
+ # Optional. Contains a page token, received from a previous `
163
+ # SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
164
+ # @param [String] query
165
+ # Required. Provides the raw query string provided by the user, such as "How to
166
+ # create a Cloud Storage bucket?".
167
+ # @param [String] fields
168
+ # Selector specifying which fields to include in a partial response.
169
+ # @param [String] quota_user
170
+ # Available to use for quota purposes for server-side applications. Can be any
171
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
172
+ # @param [Google::Apis::RequestOptions] options
173
+ # Request-specific options
174
+ #
175
+ # @yield [result, err] Result & error if block supplied
176
+ # @yieldparam result [Google::Apis::DeveloperknowledgeV1::SearchDocumentChunksResponse] parsed result object
177
+ # @yieldparam err [StandardError] error object if request failed
178
+ #
179
+ # @return [Google::Apis::DeveloperknowledgeV1::SearchDocumentChunksResponse]
180
+ #
181
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
182
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
183
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
184
+ def search_document_document_chunks(filter: nil, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
185
+ command = make_simple_command(:get, 'v1/documents:searchDocumentChunks', options)
186
+ command.response_representation = Google::Apis::DeveloperknowledgeV1::SearchDocumentChunksResponse::Representation
187
+ command.response_class = Google::Apis::DeveloperknowledgeV1::SearchDocumentChunksResponse
188
+ command.query['filter'] = filter unless filter.nil?
189
+ command.query['pageSize'] = page_size unless page_size.nil?
190
+ command.query['pageToken'] = page_token unless page_token.nil?
191
+ command.query['query'] = query unless query.nil?
192
+ command.query['fields'] = fields unless fields.nil?
193
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
194
+ execute_or_queue_command(command, &block)
195
+ end
196
+
197
+ protected
198
+
199
+ def apply_command_defaults(command)
200
+ command.query['key'] = key unless key.nil?
201
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
202
+ end
203
+ end
204
+ end
205
+ end
206
+ end
@@ -0,0 +1,36 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/developerknowledge_v1/service.rb'
16
+ require 'google/apis/developerknowledge_v1/classes.rb'
17
+ require 'google/apis/developerknowledge_v1/representations.rb'
18
+ require 'google/apis/developerknowledge_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Developer Knowledge API
23
+ #
24
+ # The Developer Knowledge API provides access to Google's developer knowledge.
25
+ #
26
+ # @see https://developers.google.com/knowledge
27
+ module DeveloperknowledgeV1
28
+ # Version of the Developer Knowledge API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+
32
+ # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
33
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/developerknowledge_v1"
metadata ADDED
@@ -0,0 +1,79 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-developerknowledge_v1
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: google-apis-core
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: 0.15.0
19
+ - - "<"
20
+ - !ruby/object:Gem::Version
21
+ version: 2.a
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: 0.15.0
29
+ - - "<"
30
+ - !ruby/object:Gem::Version
31
+ version: 2.a
32
+ description: This is the simple REST client for Developer Knowledge API V1. Simple
33
+ REST clients are Ruby client libraries that provide access to Google services via
34
+ their HTTP REST API endpoints. These libraries are generated and updated automatically
35
+ based on the discovery documents published by the service, and they handle most
36
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
37
+ use this client to access the Developer Knowledge API, but note that some services
38
+ may provide a separate modern client that is easier to use.
39
+ email: googleapis-packages@google.com
40
+ executables: []
41
+ extensions: []
42
+ extra_rdoc_files: []
43
+ files:
44
+ - ".yardopts"
45
+ - CHANGELOG.md
46
+ - LICENSE.md
47
+ - OVERVIEW.md
48
+ - lib/google-apis-developerknowledge_v1.rb
49
+ - lib/google/apis/developerknowledge_v1.rb
50
+ - lib/google/apis/developerknowledge_v1/classes.rb
51
+ - lib/google/apis/developerknowledge_v1/gem_version.rb
52
+ - lib/google/apis/developerknowledge_v1/representations.rb
53
+ - lib/google/apis/developerknowledge_v1/service.rb
54
+ homepage: https://github.com/google/google-api-ruby-client
55
+ licenses:
56
+ - Apache-2.0
57
+ metadata:
58
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-developerknowledge_v1/CHANGELOG.md
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-developerknowledge_v1/v0.1.0
61
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-developerknowledge_v1
62
+ rdoc_options: []
63
+ require_paths:
64
+ - lib
65
+ required_ruby_version: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ version: '3.1'
70
+ required_rubygems_version: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
75
+ requirements: []
76
+ rubygems_version: 3.6.9
77
+ specification_version: 4
78
+ summary: Simple REST client for Developer Knowledge API V1
79
+ test_files: []