google-apis-webrisk_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 4ab9851c3925b8444a49b03a961865443005bf68ddaaffba458df5de728eab65
4
+ data.tar.gz: 5be2a5e3f857c9b69862cee6a830ac7fab435e806c65455401126751ecc9c2ce
5
+ SHA512:
6
+ metadata.gz: a210dd039c314909e44cde0724ff76dd3c483676021d0760584dc07aae5cbe7a122cbf6d7b7c1ee53997e27fa8144158b34f66f4449a03106073802f3ae019dc
7
+ data.tar.gz: 2872b0b29dd0ec1d11b21a329a5c0bebcdaf86e0e81cb4768b6bc2614f79844ed7008d14b810cee87e30605105a1b42406b05d8ea24a69bc9fb20dc700f7dff0
data/.yardopts ADDED
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-webrisk_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/webrisk_v1/*.rb
9
+ lib/google/apis/webrisk_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-webrisk_v1
2
+
3
+ ### v0.1.0 (2021-02-24)
4
+
5
+ * Regenerated from discovery document revision 20210220
6
+ * Regenerated using generator version 0.1.2
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 Web Risk API
2
+
3
+ This is a simple client library for version V1 of the Web Risk 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/webrisk.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-webrisk_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-webrisk_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/webrisk_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::WebriskV1::WebRiskService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... 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/master/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/master/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 Webrisk service in particular.)
67
+
68
+ For reference information on specific calls in the Web Risk API, see the {Google::Apis::WebriskV1::WebRiskService 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-webrisk_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://cloud.google.com/web-risk/) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
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. Currently, this means Ruby 2.5 and later. 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,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/webrisk_v1"
@@ -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/webrisk_v1/service.rb'
16
+ require 'google/apis/webrisk_v1/classes.rb'
17
+ require 'google/apis/webrisk_v1/representations.rb'
18
+ require 'google/apis/webrisk_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Web Risk API
23
+ #
24
+ #
25
+ #
26
+ # @see https://cloud.google.com/web-risk/
27
+ module WebriskV1
28
+ # Version of the Web Risk API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+
32
+ # View and manage your data across Google Cloud Platform services
33
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,561 @@
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 WebriskV1
24
+
25
+ #
26
+ class GoogleCloudWebriskV1ComputeThreatListDiffResponse
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Contains the set of entries to add to a local database. May contain a
30
+ # combination of compressed and raw data in a single response.
31
+ # Corresponds to the JSON property `additions`
32
+ # @return [Google::Apis::WebriskV1::GoogleCloudWebriskV1ThreatEntryAdditions]
33
+ attr_accessor :additions
34
+
35
+ # The expected state of a client's local database.
36
+ # Corresponds to the JSON property `checksum`
37
+ # @return [Google::Apis::WebriskV1::GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum]
38
+ attr_accessor :checksum
39
+
40
+ # The new opaque client version token. This should be retained by the client and
41
+ # passed into the next call of ComputeThreatListDiff as 'version_token'. A
42
+ # separate version token should be stored and used for each threatList.
43
+ # Corresponds to the JSON property `newVersionToken`
44
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
45
+ # @return [String]
46
+ attr_accessor :new_version_token
47
+
48
+ # The soonest the client should wait before issuing any diff request. Querying
49
+ # sooner is unlikely to produce a meaningful diff. Waiting longer is acceptable
50
+ # considering the use case. If this field is not set clients may update as soon
51
+ # as they want.
52
+ # Corresponds to the JSON property `recommendedNextDiff`
53
+ # @return [String]
54
+ attr_accessor :recommended_next_diff
55
+
56
+ # Contains the set of entries to remove from a local database.
57
+ # Corresponds to the JSON property `removals`
58
+ # @return [Google::Apis::WebriskV1::GoogleCloudWebriskV1ThreatEntryRemovals]
59
+ attr_accessor :removals
60
+
61
+ # The type of response. This may indicate that an action must be taken by the
62
+ # client when the response is received.
63
+ # Corresponds to the JSON property `responseType`
64
+ # @return [String]
65
+ attr_accessor :response_type
66
+
67
+ def initialize(**args)
68
+ update!(**args)
69
+ end
70
+
71
+ # Update properties of this object
72
+ def update!(**args)
73
+ @additions = args[:additions] if args.key?(:additions)
74
+ @checksum = args[:checksum] if args.key?(:checksum)
75
+ @new_version_token = args[:new_version_token] if args.key?(:new_version_token)
76
+ @recommended_next_diff = args[:recommended_next_diff] if args.key?(:recommended_next_diff)
77
+ @removals = args[:removals] if args.key?(:removals)
78
+ @response_type = args[:response_type] if args.key?(:response_type)
79
+ end
80
+ end
81
+
82
+ # The expected state of a client's local database.
83
+ class GoogleCloudWebriskV1ComputeThreatListDiffResponseChecksum
84
+ include Google::Apis::Core::Hashable
85
+
86
+ # The SHA256 hash of the client state; that is, of the sorted list of all hashes
87
+ # present in the database.
88
+ # Corresponds to the JSON property `sha256`
89
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
90
+ # @return [String]
91
+ attr_accessor :sha256
92
+
93
+ def initialize(**args)
94
+ update!(**args)
95
+ end
96
+
97
+ # Update properties of this object
98
+ def update!(**args)
99
+ @sha256 = args[:sha256] if args.key?(:sha256)
100
+ end
101
+ end
102
+
103
+ # The uncompressed threat entries in hash format. Hashes can be anywhere from 4
104
+ # to 32 bytes in size. A large majority are 4 bytes, but some hashes are
105
+ # lengthened if they collide with the hash of a popular URI. Used for sending
106
+ # ThreatEntryAdditons to clients that do not support compression, or when
107
+ # sending non-4-byte hashes to clients that do support compression.
108
+ class GoogleCloudWebriskV1RawHashes
109
+ include Google::Apis::Core::Hashable
110
+
111
+ # The number of bytes for each prefix encoded below. This field can be anywhere
112
+ # from 4 (shortest prefix) to 32 (full SHA256 hash). In practice this is almost
113
+ # always 4, except in exceptional circumstances.
114
+ # Corresponds to the JSON property `prefixSize`
115
+ # @return [Fixnum]
116
+ attr_accessor :prefix_size
117
+
118
+ # The hashes, in binary format, concatenated into one long string. Hashes are
119
+ # sorted in lexicographic order. For JSON API users, hashes are base64-encoded.
120
+ # Corresponds to the JSON property `rawHashes`
121
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
122
+ # @return [String]
123
+ attr_accessor :raw_hashes
124
+
125
+ def initialize(**args)
126
+ update!(**args)
127
+ end
128
+
129
+ # Update properties of this object
130
+ def update!(**args)
131
+ @prefix_size = args[:prefix_size] if args.key?(:prefix_size)
132
+ @raw_hashes = args[:raw_hashes] if args.key?(:raw_hashes)
133
+ end
134
+ end
135
+
136
+ # A set of raw indices to remove from a local list.
137
+ class GoogleCloudWebriskV1RawIndices
138
+ include Google::Apis::Core::Hashable
139
+
140
+ # The indices to remove from a lexicographically-sorted local list.
141
+ # Corresponds to the JSON property `indices`
142
+ # @return [Array<Fixnum>]
143
+ attr_accessor :indices
144
+
145
+ def initialize(**args)
146
+ update!(**args)
147
+ end
148
+
149
+ # Update properties of this object
150
+ def update!(**args)
151
+ @indices = args[:indices] if args.key?(:indices)
152
+ end
153
+ end
154
+
155
+ # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or
156
+ # compressed removal indices.
157
+ class GoogleCloudWebriskV1RiceDeltaEncoding
158
+ include Google::Apis::Core::Hashable
159
+
160
+ # The encoded deltas that are encoded using the Golomb-Rice coder.
161
+ # Corresponds to the JSON property `encodedData`
162
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
163
+ # @return [String]
164
+ attr_accessor :encoded_data
165
+
166
+ # The number of entries that are delta encoded in the encoded data. If only a
167
+ # single integer was encoded, this will be zero and the single value will be
168
+ # stored in `first_value`.
169
+ # Corresponds to the JSON property `entryCount`
170
+ # @return [Fixnum]
171
+ attr_accessor :entry_count
172
+
173
+ # The offset of the first entry in the encoded data, or, if only a single
174
+ # integer was encoded, that single integer's value. If the field is empty or
175
+ # missing, assume zero.
176
+ # Corresponds to the JSON property `firstValue`
177
+ # @return [Fixnum]
178
+ attr_accessor :first_value
179
+
180
+ # The Golomb-Rice parameter, which is a number between 2 and 28. This field is
181
+ # missing (that is, zero) if `num_entries` is zero.
182
+ # Corresponds to the JSON property `riceParameter`
183
+ # @return [Fixnum]
184
+ attr_accessor :rice_parameter
185
+
186
+ def initialize(**args)
187
+ update!(**args)
188
+ end
189
+
190
+ # Update properties of this object
191
+ def update!(**args)
192
+ @encoded_data = args[:encoded_data] if args.key?(:encoded_data)
193
+ @entry_count = args[:entry_count] if args.key?(:entry_count)
194
+ @first_value = args[:first_value] if args.key?(:first_value)
195
+ @rice_parameter = args[:rice_parameter] if args.key?(:rice_parameter)
196
+ end
197
+ end
198
+
199
+ #
200
+ class GoogleCloudWebriskV1SearchHashesResponse
201
+ include Google::Apis::Core::Hashable
202
+
203
+ # For requested entities that did not match the threat list, how long to cache
204
+ # the response until.
205
+ # Corresponds to the JSON property `negativeExpireTime`
206
+ # @return [String]
207
+ attr_accessor :negative_expire_time
208
+
209
+ # The full hashes that matched the requested prefixes. The hash will be
210
+ # populated in the key.
211
+ # Corresponds to the JSON property `threats`
212
+ # @return [Array<Google::Apis::WebriskV1::GoogleCloudWebriskV1SearchHashesResponseThreatHash>]
213
+ attr_accessor :threats
214
+
215
+ def initialize(**args)
216
+ update!(**args)
217
+ end
218
+
219
+ # Update properties of this object
220
+ def update!(**args)
221
+ @negative_expire_time = args[:negative_expire_time] if args.key?(:negative_expire_time)
222
+ @threats = args[:threats] if args.key?(:threats)
223
+ end
224
+ end
225
+
226
+ # Contains threat information on a matching hash.
227
+ class GoogleCloudWebriskV1SearchHashesResponseThreatHash
228
+ include Google::Apis::Core::Hashable
229
+
230
+ # The cache lifetime for the returned match. Clients must not cache this
231
+ # response past this timestamp to avoid false positives.
232
+ # Corresponds to the JSON property `expireTime`
233
+ # @return [String]
234
+ attr_accessor :expire_time
235
+
236
+ # A 32 byte SHA256 hash. This field is in binary format. For JSON requests,
237
+ # hashes are base64-encoded.
238
+ # Corresponds to the JSON property `hash`
239
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
240
+ # @return [String]
241
+ attr_accessor :hash_prop
242
+
243
+ # The ThreatList this threat belongs to. This must contain at least one entry.
244
+ # Corresponds to the JSON property `threatTypes`
245
+ # @return [Array<String>]
246
+ attr_accessor :threat_types
247
+
248
+ def initialize(**args)
249
+ update!(**args)
250
+ end
251
+
252
+ # Update properties of this object
253
+ def update!(**args)
254
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
255
+ @hash_prop = args[:hash_prop] if args.key?(:hash_prop)
256
+ @threat_types = args[:threat_types] if args.key?(:threat_types)
257
+ end
258
+ end
259
+
260
+ #
261
+ class GoogleCloudWebriskV1SearchUrisResponse
262
+ include Google::Apis::Core::Hashable
263
+
264
+ # Contains threat information on a matching uri.
265
+ # Corresponds to the JSON property `threat`
266
+ # @return [Google::Apis::WebriskV1::GoogleCloudWebriskV1SearchUrisResponseThreatUri]
267
+ attr_accessor :threat
268
+
269
+ def initialize(**args)
270
+ update!(**args)
271
+ end
272
+
273
+ # Update properties of this object
274
+ def update!(**args)
275
+ @threat = args[:threat] if args.key?(:threat)
276
+ end
277
+ end
278
+
279
+ # Contains threat information on a matching uri.
280
+ class GoogleCloudWebriskV1SearchUrisResponseThreatUri
281
+ include Google::Apis::Core::Hashable
282
+
283
+ # The cache lifetime for the returned match. Clients must not cache this
284
+ # response past this timestamp to avoid false positives.
285
+ # Corresponds to the JSON property `expireTime`
286
+ # @return [String]
287
+ attr_accessor :expire_time
288
+
289
+ # The ThreatList this threat belongs to.
290
+ # Corresponds to the JSON property `threatTypes`
291
+ # @return [Array<String>]
292
+ attr_accessor :threat_types
293
+
294
+ def initialize(**args)
295
+ update!(**args)
296
+ end
297
+
298
+ # Update properties of this object
299
+ def update!(**args)
300
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
301
+ @threat_types = args[:threat_types] if args.key?(:threat_types)
302
+ end
303
+ end
304
+
305
+ # Wraps a URI that might be displaying malicious content.
306
+ class GoogleCloudWebriskV1Submission
307
+ include Google::Apis::Core::Hashable
308
+
309
+ # ThreatTypes found to be associated with the submitted URI after reviewing it.
310
+ # This may be empty if the URI was not added to any list.
311
+ # Corresponds to the JSON property `threatTypes`
312
+ # @return [Array<String>]
313
+ attr_accessor :threat_types
314
+
315
+ # Required. The URI that is being reported for malicious content to be analyzed.
316
+ # Corresponds to the JSON property `uri`
317
+ # @return [String]
318
+ attr_accessor :uri
319
+
320
+ def initialize(**args)
321
+ update!(**args)
322
+ end
323
+
324
+ # Update properties of this object
325
+ def update!(**args)
326
+ @threat_types = args[:threat_types] if args.key?(:threat_types)
327
+ @uri = args[:uri] if args.key?(:uri)
328
+ end
329
+ end
330
+
331
+ # Request to send a potentially malicious URI to WebRisk.
332
+ class GoogleCloudWebriskV1SubmitUriRequest
333
+ include Google::Apis::Core::Hashable
334
+
335
+ # Wraps a URI that might be displaying malicious content.
336
+ # Corresponds to the JSON property `submission`
337
+ # @return [Google::Apis::WebriskV1::GoogleCloudWebriskV1Submission]
338
+ attr_accessor :submission
339
+
340
+ def initialize(**args)
341
+ update!(**args)
342
+ end
343
+
344
+ # Update properties of this object
345
+ def update!(**args)
346
+ @submission = args[:submission] if args.key?(:submission)
347
+ end
348
+ end
349
+
350
+ # Contains the set of entries to add to a local database. May contain a
351
+ # combination of compressed and raw data in a single response.
352
+ class GoogleCloudWebriskV1ThreatEntryAdditions
353
+ include Google::Apis::Core::Hashable
354
+
355
+ # The raw SHA256-formatted entries. Repeated to allow returning sets of hashes
356
+ # with different prefix sizes.
357
+ # Corresponds to the JSON property `rawHashes`
358
+ # @return [Array<Google::Apis::WebriskV1::GoogleCloudWebriskV1RawHashes>]
359
+ attr_accessor :raw_hashes
360
+
361
+ # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or
362
+ # compressed removal indices.
363
+ # Corresponds to the JSON property `riceHashes`
364
+ # @return [Google::Apis::WebriskV1::GoogleCloudWebriskV1RiceDeltaEncoding]
365
+ attr_accessor :rice_hashes
366
+
367
+ def initialize(**args)
368
+ update!(**args)
369
+ end
370
+
371
+ # Update properties of this object
372
+ def update!(**args)
373
+ @raw_hashes = args[:raw_hashes] if args.key?(:raw_hashes)
374
+ @rice_hashes = args[:rice_hashes] if args.key?(:rice_hashes)
375
+ end
376
+ end
377
+
378
+ # Contains the set of entries to remove from a local database.
379
+ class GoogleCloudWebriskV1ThreatEntryRemovals
380
+ include Google::Apis::Core::Hashable
381
+
382
+ # A set of raw indices to remove from a local list.
383
+ # Corresponds to the JSON property `rawIndices`
384
+ # @return [Google::Apis::WebriskV1::GoogleCloudWebriskV1RawIndices]
385
+ attr_accessor :raw_indices
386
+
387
+ # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or
388
+ # compressed removal indices.
389
+ # Corresponds to the JSON property `riceIndices`
390
+ # @return [Google::Apis::WebriskV1::GoogleCloudWebriskV1RiceDeltaEncoding]
391
+ attr_accessor :rice_indices
392
+
393
+ def initialize(**args)
394
+ update!(**args)
395
+ end
396
+
397
+ # Update properties of this object
398
+ def update!(**args)
399
+ @raw_indices = args[:raw_indices] if args.key?(:raw_indices)
400
+ @rice_indices = args[:rice_indices] if args.key?(:rice_indices)
401
+ end
402
+ end
403
+
404
+ # The request message for Operations.CancelOperation.
405
+ class GoogleLongrunningCancelOperationRequest
406
+ include Google::Apis::Core::Hashable
407
+
408
+ def initialize(**args)
409
+ update!(**args)
410
+ end
411
+
412
+ # Update properties of this object
413
+ def update!(**args)
414
+ end
415
+ end
416
+
417
+ # The response message for Operations.ListOperations.
418
+ class GoogleLongrunningListOperationsResponse
419
+ include Google::Apis::Core::Hashable
420
+
421
+ # The standard List next-page token.
422
+ # Corresponds to the JSON property `nextPageToken`
423
+ # @return [String]
424
+ attr_accessor :next_page_token
425
+
426
+ # A list of operations that matches the specified filter in the request.
427
+ # Corresponds to the JSON property `operations`
428
+ # @return [Array<Google::Apis::WebriskV1::GoogleLongrunningOperation>]
429
+ attr_accessor :operations
430
+
431
+ def initialize(**args)
432
+ update!(**args)
433
+ end
434
+
435
+ # Update properties of this object
436
+ def update!(**args)
437
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
438
+ @operations = args[:operations] if args.key?(:operations)
439
+ end
440
+ end
441
+
442
+ # This resource represents a long-running operation that is the result of a
443
+ # network API call.
444
+ class GoogleLongrunningOperation
445
+ include Google::Apis::Core::Hashable
446
+
447
+ # If the value is `false`, it means the operation is still in progress. If `true`
448
+ # , the operation is completed, and either `error` or `response` is available.
449
+ # Corresponds to the JSON property `done`
450
+ # @return [Boolean]
451
+ attr_accessor :done
452
+ alias_method :done?, :done
453
+
454
+ # The `Status` type defines a logical error model that is suitable for different
455
+ # programming environments, including REST APIs and RPC APIs. It is used by [
456
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
457
+ # data: error code, error message, and error details. You can find out more
458
+ # about this error model and how to work with it in the [API Design Guide](https:
459
+ # //cloud.google.com/apis/design/errors).
460
+ # Corresponds to the JSON property `error`
461
+ # @return [Google::Apis::WebriskV1::GoogleRpcStatus]
462
+ attr_accessor :error
463
+
464
+ # Service-specific metadata associated with the operation. It typically contains
465
+ # progress information and common metadata such as create time. Some services
466
+ # might not provide such metadata. Any method that returns a long-running
467
+ # operation should document the metadata type, if any.
468
+ # Corresponds to the JSON property `metadata`
469
+ # @return [Hash<String,Object>]
470
+ attr_accessor :metadata
471
+
472
+ # The server-assigned name, which is only unique within the same service that
473
+ # originally returns it. If you use the default HTTP mapping, the `name` should
474
+ # be a resource name ending with `operations/`unique_id``.
475
+ # Corresponds to the JSON property `name`
476
+ # @return [String]
477
+ attr_accessor :name
478
+
479
+ # The normal response of the operation in case of success. If the original
480
+ # method returns no data on success, such as `Delete`, the response is `google.
481
+ # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
482
+ # the response should be the resource. For other methods, the response should
483
+ # have the type `XxxResponse`, where `Xxx` is the original method name. For
484
+ # example, if the original method name is `TakeSnapshot()`, the inferred
485
+ # response type is `TakeSnapshotResponse`.
486
+ # Corresponds to the JSON property `response`
487
+ # @return [Hash<String,Object>]
488
+ attr_accessor :response
489
+
490
+ def initialize(**args)
491
+ update!(**args)
492
+ end
493
+
494
+ # Update properties of this object
495
+ def update!(**args)
496
+ @done = args[:done] if args.key?(:done)
497
+ @error = args[:error] if args.key?(:error)
498
+ @metadata = args[:metadata] if args.key?(:metadata)
499
+ @name = args[:name] if args.key?(:name)
500
+ @response = args[:response] if args.key?(:response)
501
+ end
502
+ end
503
+
504
+ # A generic empty message that you can re-use to avoid defining duplicated empty
505
+ # messages in your APIs. A typical example is to use it as the request or the
506
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
507
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
508
+ # `Empty` is empty JSON object ````.
509
+ class GoogleProtobufEmpty
510
+ include Google::Apis::Core::Hashable
511
+
512
+ def initialize(**args)
513
+ update!(**args)
514
+ end
515
+
516
+ # Update properties of this object
517
+ def update!(**args)
518
+ end
519
+ end
520
+
521
+ # The `Status` type defines a logical error model that is suitable for different
522
+ # programming environments, including REST APIs and RPC APIs. It is used by [
523
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
524
+ # data: error code, error message, and error details. You can find out more
525
+ # about this error model and how to work with it in the [API Design Guide](https:
526
+ # //cloud.google.com/apis/design/errors).
527
+ class GoogleRpcStatus
528
+ include Google::Apis::Core::Hashable
529
+
530
+ # The status code, which should be an enum value of google.rpc.Code.
531
+ # Corresponds to the JSON property `code`
532
+ # @return [Fixnum]
533
+ attr_accessor :code
534
+
535
+ # A list of messages that carry the error details. There is a common set of
536
+ # message types for APIs to use.
537
+ # Corresponds to the JSON property `details`
538
+ # @return [Array<Hash<String,Object>>]
539
+ attr_accessor :details
540
+
541
+ # A developer-facing error message, which should be in English. Any user-facing
542
+ # error message should be localized and sent in the google.rpc.Status.details
543
+ # field, or localized by the client.
544
+ # Corresponds to the JSON property `message`
545
+ # @return [String]
546
+ attr_accessor :message
547
+
548
+ def initialize(**args)
549
+ update!(**args)
550
+ end
551
+
552
+ # Update properties of this object
553
+ def update!(**args)
554
+ @code = args[:code] if args.key?(:code)
555
+ @details = args[:details] if args.key?(:details)
556
+ @message = args[:message] if args.key?(:message)
557
+ end
558
+ end
559
+ end
560
+ end
561
+ end