google-cloud-web_risk-v1 0.6.0 → 0.7.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.
@@ -0,0 +1,279 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/webrisk/v1/webrisk_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module WebRisk
24
+ module V1
25
+ module WebRiskService
26
+ module Rest
27
+ ##
28
+ # REST service stub for the WebRiskService service.
29
+ # Service stub contains baseline method implementations
30
+ # including transcoding, making the REST call, and deserialing the response.
31
+ #
32
+ class ServiceStub
33
+ def initialize endpoint:, credentials:
34
+ # These require statements are intentionally placed here to initialize
35
+ # the REST modules only when it's required.
36
+ require "gapic/rest"
37
+
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ numeric_enums: true,
40
+ raise_faraday_errors: false
41
+ end
42
+
43
+ ##
44
+ # Baseline implementation for the compute_threat_list_diff REST call
45
+ #
46
+ # @param request_pb [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest]
47
+ # A request object representing the call parameters. Required.
48
+ # @param options [::Gapic::CallOptions]
49
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
50
+ #
51
+ # @yield [result, operation] Access the result along with the TransportOperation object
52
+ # @yieldparam result [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse]
53
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
54
+ #
55
+ # @return [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse]
56
+ # A result object deserialized from the server's reply
57
+ def compute_threat_list_diff request_pb, options = nil
58
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
59
+
60
+ verb, uri, query_string_params, body = ServiceStub.transcode_compute_threat_list_diff_request request_pb
61
+ query_string_params = if query_string_params.any?
62
+ query_string_params.to_h { |p| p.split("=", 2) }
63
+ else
64
+ {}
65
+ end
66
+
67
+ response = @client_stub.make_http_request(
68
+ verb,
69
+ uri: uri,
70
+ body: body || "",
71
+ params: query_string_params,
72
+ options: options
73
+ )
74
+ operation = ::Gapic::Rest::TransportOperation.new response
75
+ result = ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse.decode_json response.body, ignore_unknown_fields: true
76
+
77
+ yield result, operation if block_given?
78
+ result
79
+ end
80
+
81
+ ##
82
+ # Baseline implementation for the search_uris REST call
83
+ #
84
+ # @param request_pb [::Google::Cloud::WebRisk::V1::SearchUrisRequest]
85
+ # A request object representing the call parameters. Required.
86
+ # @param options [::Gapic::CallOptions]
87
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
88
+ #
89
+ # @yield [result, operation] Access the result along with the TransportOperation object
90
+ # @yieldparam result [::Google::Cloud::WebRisk::V1::SearchUrisResponse]
91
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
92
+ #
93
+ # @return [::Google::Cloud::WebRisk::V1::SearchUrisResponse]
94
+ # A result object deserialized from the server's reply
95
+ def search_uris request_pb, options = nil
96
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
97
+
98
+ verb, uri, query_string_params, body = ServiceStub.transcode_search_uris_request request_pb
99
+ query_string_params = if query_string_params.any?
100
+ query_string_params.to_h { |p| p.split("=", 2) }
101
+ else
102
+ {}
103
+ end
104
+
105
+ response = @client_stub.make_http_request(
106
+ verb,
107
+ uri: uri,
108
+ body: body || "",
109
+ params: query_string_params,
110
+ options: options
111
+ )
112
+ operation = ::Gapic::Rest::TransportOperation.new response
113
+ result = ::Google::Cloud::WebRisk::V1::SearchUrisResponse.decode_json response.body, ignore_unknown_fields: true
114
+
115
+ yield result, operation if block_given?
116
+ result
117
+ end
118
+
119
+ ##
120
+ # Baseline implementation for the search_hashes REST call
121
+ #
122
+ # @param request_pb [::Google::Cloud::WebRisk::V1::SearchHashesRequest]
123
+ # A request object representing the call parameters. Required.
124
+ # @param options [::Gapic::CallOptions]
125
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
126
+ #
127
+ # @yield [result, operation] Access the result along with the TransportOperation object
128
+ # @yieldparam result [::Google::Cloud::WebRisk::V1::SearchHashesResponse]
129
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
130
+ #
131
+ # @return [::Google::Cloud::WebRisk::V1::SearchHashesResponse]
132
+ # A result object deserialized from the server's reply
133
+ def search_hashes request_pb, options = nil
134
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
135
+
136
+ verb, uri, query_string_params, body = ServiceStub.transcode_search_hashes_request request_pb
137
+ query_string_params = if query_string_params.any?
138
+ query_string_params.to_h { |p| p.split("=", 2) }
139
+ else
140
+ {}
141
+ end
142
+
143
+ response = @client_stub.make_http_request(
144
+ verb,
145
+ uri: uri,
146
+ body: body || "",
147
+ params: query_string_params,
148
+ options: options
149
+ )
150
+ operation = ::Gapic::Rest::TransportOperation.new response
151
+ result = ::Google::Cloud::WebRisk::V1::SearchHashesResponse.decode_json response.body, ignore_unknown_fields: true
152
+
153
+ yield result, operation if block_given?
154
+ result
155
+ end
156
+
157
+ ##
158
+ # Baseline implementation for the create_submission REST call
159
+ #
160
+ # @param request_pb [::Google::Cloud::WebRisk::V1::CreateSubmissionRequest]
161
+ # A request object representing the call parameters. Required.
162
+ # @param options [::Gapic::CallOptions]
163
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
164
+ #
165
+ # @yield [result, operation] Access the result along with the TransportOperation object
166
+ # @yieldparam result [::Google::Cloud::WebRisk::V1::Submission]
167
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
168
+ #
169
+ # @return [::Google::Cloud::WebRisk::V1::Submission]
170
+ # A result object deserialized from the server's reply
171
+ def create_submission request_pb, options = nil
172
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
173
+
174
+ verb, uri, query_string_params, body = ServiceStub.transcode_create_submission_request request_pb
175
+ query_string_params = if query_string_params.any?
176
+ query_string_params.to_h { |p| p.split("=", 2) }
177
+ else
178
+ {}
179
+ end
180
+
181
+ response = @client_stub.make_http_request(
182
+ verb,
183
+ uri: uri,
184
+ body: body || "",
185
+ params: query_string_params,
186
+ options: options
187
+ )
188
+ operation = ::Gapic::Rest::TransportOperation.new response
189
+ result = ::Google::Cloud::WebRisk::V1::Submission.decode_json response.body, ignore_unknown_fields: true
190
+
191
+ yield result, operation if block_given?
192
+ result
193
+ end
194
+
195
+ ##
196
+ # @private
197
+ #
198
+ # GRPC transcoding helper method for the compute_threat_list_diff REST call
199
+ #
200
+ # @param request_pb [::Google::Cloud::WebRisk::V1::ComputeThreatListDiffRequest]
201
+ # A request object representing the call parameters. Required.
202
+ # @return [Array(String, [String, nil], Hash{String => String})]
203
+ # Uri, Body, Query string parameters
204
+ def self.transcode_compute_threat_list_diff_request request_pb
205
+ transcoder = Gapic::Rest::GrpcTranscoder.new
206
+ .with_bindings(
207
+ uri_method: :get,
208
+ uri_template: "/v1/threatLists:computeDiff",
209
+ matches: []
210
+ )
211
+ transcoder.transcode request_pb
212
+ end
213
+
214
+ ##
215
+ # @private
216
+ #
217
+ # GRPC transcoding helper method for the search_uris REST call
218
+ #
219
+ # @param request_pb [::Google::Cloud::WebRisk::V1::SearchUrisRequest]
220
+ # A request object representing the call parameters. Required.
221
+ # @return [Array(String, [String, nil], Hash{String => String})]
222
+ # Uri, Body, Query string parameters
223
+ def self.transcode_search_uris_request request_pb
224
+ transcoder = Gapic::Rest::GrpcTranscoder.new
225
+ .with_bindings(
226
+ uri_method: :get,
227
+ uri_template: "/v1/uris:search",
228
+ matches: []
229
+ )
230
+ transcoder.transcode request_pb
231
+ end
232
+
233
+ ##
234
+ # @private
235
+ #
236
+ # GRPC transcoding helper method for the search_hashes REST call
237
+ #
238
+ # @param request_pb [::Google::Cloud::WebRisk::V1::SearchHashesRequest]
239
+ # A request object representing the call parameters. Required.
240
+ # @return [Array(String, [String, nil], Hash{String => String})]
241
+ # Uri, Body, Query string parameters
242
+ def self.transcode_search_hashes_request request_pb
243
+ transcoder = Gapic::Rest::GrpcTranscoder.new
244
+ .with_bindings(
245
+ uri_method: :get,
246
+ uri_template: "/v1/hashes:search",
247
+ matches: []
248
+ )
249
+ transcoder.transcode request_pb
250
+ end
251
+
252
+ ##
253
+ # @private
254
+ #
255
+ # GRPC transcoding helper method for the create_submission REST call
256
+ #
257
+ # @param request_pb [::Google::Cloud::WebRisk::V1::CreateSubmissionRequest]
258
+ # A request object representing the call parameters. Required.
259
+ # @return [Array(String, [String, nil], Hash{String => String})]
260
+ # Uri, Body, Query string parameters
261
+ def self.transcode_create_submission_request request_pb
262
+ transcoder = Gapic::Rest::GrpcTranscoder.new
263
+ .with_bindings(
264
+ uri_method: :post,
265
+ uri_template: "/v1/{parent}/submissions",
266
+ body: "submission",
267
+ matches: [
268
+ ["parent", %r{^projects/[^/]+/?$}, false]
269
+ ]
270
+ )
271
+ transcoder.transcode request_pb
272
+ end
273
+ end
274
+ end
275
+ end
276
+ end
277
+ end
278
+ end
279
+ end
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "gapic/rest"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/web_risk/v1/version"
24
+
25
+ require "google/cloud/web_risk/v1/web_risk_service/credentials"
26
+ require "google/cloud/web_risk/v1/web_risk_service/paths"
27
+ require "google/cloud/web_risk/v1/web_risk_service/rest/client"
28
+
29
+ module Google
30
+ module Cloud
31
+ module WebRisk
32
+ module V1
33
+ ##
34
+ # Web Risk API defines an interface to detect malicious URLs on your
35
+ # website and in client applications.
36
+ #
37
+ # To load this service and instantiate a REST client:
38
+ #
39
+ # require "google/cloud/web_risk/v1/web_risk_service/rest"
40
+ # client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new
41
+ #
42
+ module WebRiskService
43
+ # Client for the REST transport
44
+ module Rest
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+ end
51
+
52
+ helper_path = ::File.join __dir__, "rest", "helpers.rb"
53
+ require "google/cloud/web_risk/v1/web_risk_service/rest/helpers" if ::File.file? helper_path
@@ -25,6 +25,7 @@ require "google/cloud/web_risk/v1/version"
25
25
  require "google/cloud/web_risk/v1/web_risk_service/credentials"
26
26
  require "google/cloud/web_risk/v1/web_risk_service/paths"
27
27
  require "google/cloud/web_risk/v1/web_risk_service/client"
28
+ require "google/cloud/web_risk/v1/web_risk_service/rest"
28
29
 
29
30
  module Google
30
31
  module Cloud
@@ -34,11 +35,16 @@ module Google
34
35
  # Web Risk API defines an interface to detect malicious URLs on your
35
36
  # website and in client applications.
36
37
  #
37
- # To load this service and instantiate a client:
38
+ # @example Load this service and instantiate a gRPC client
38
39
  #
39
40
  # require "google/cloud/web_risk/v1/web_risk_service"
40
41
  # client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new
41
42
  #
43
+ # @example Load this service and instantiate a REST client
44
+ #
45
+ # require "google/cloud/web_risk/v1/web_risk_service/rest"
46
+ # client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new
47
+ #
42
48
  module WebRiskService
43
49
  end
44
50
  end
@@ -23,13 +23,18 @@ module Google
23
23
  module Cloud
24
24
  module WebRisk
25
25
  ##
26
- # To load this package, including all its services, and instantiate a client:
26
+ # API client module.
27
27
  #
28
- # @example
28
+ # @example Load this package, including all its services, and instantiate a gRPC client
29
29
  #
30
30
  # require "google/cloud/web_risk/v1"
31
31
  # client = ::Google::Cloud::WebRisk::V1::WebRiskService::Client.new
32
32
  #
33
+ # @example Load this package, including all its services, and instantiate a REST client
34
+ #
35
+ # require "google/cloud/web_risk/v1"
36
+ # client = ::Google::Cloud::WebRisk::V1::WebRiskService::Rest::Client.new
37
+ #
33
38
  module V1
34
39
  end
35
40
  end