google-cloud-web_risk-v1beta1 0.7.1 → 0.9.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 +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/web_risk/v1beta1/version.rb +1 -1
- data/lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb +41 -9
- data/lib/google/cloud/web_risk/v1beta1/web_risk_service/rest/client.rb +81 -7
- data/lib/google/cloud/web_risk/v1beta1/web_risk_service/rest/service_stub.rb +14 -2
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: faea1a44f30862baf775fa648b2605d5c8508f88ed36b58f8f58789500506a75
|
|
4
|
+
data.tar.gz: 9ce5497cdce59fc3deb4f23ed80ae366252b136485edafd2429d013c7329651f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c61a134bcbc7fb98493cb1ae148dac4a6c02b43081c49f7af1885bd78bb1642c1856dd1cc59854bae3a6277192631cddeaddc48a8597526d575fd93b8a73fc7d
|
|
7
|
+
data.tar.gz: ff088fa751f2053e6bb61291d0dccf6f78b5163c7e4edfe124fe5878c9b0c22161557edf2ea04cc3486eea6543b13ad30b1cc701ce816c1a3e4059f22806252c
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
|
7
|
-
credentials will be discovered automatically. When running on other
|
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
|
9
|
-
path to the
|
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
|
11
|
-
for the account (or the JSON itself) in
|
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
|
14
|
-
during development.
|
|
3
|
+
The recommended way to authenticate to the google-cloud-web_risk-v1beta1 library is to use
|
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
|
15
6
|
|
|
16
7
|
## Quickstart
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
3. Initialize the client.
|
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
|
13
|
+
should be used only during development.
|
|
26
14
|
|
|
27
|
-
|
|
28
|
-
|
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
|
29
17
|
|
|
30
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-web_risk-v1beta1 library aims to make authentication
|
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
|
38
|
-
|
|
39
|
-
**Credentials** are discovered in the following order:
|
|
40
|
-
|
|
41
|
-
1. Specify credentials in method arguments
|
|
42
|
-
2. Specify credentials in configuration
|
|
43
|
-
3. Discover credentials path in environment variables
|
|
44
|
-
4. Discover credentials JSON in environment variables
|
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
-
6. Discover GCP credentials
|
|
47
|
-
|
|
48
|
-
### Google Cloud Platform environments
|
|
22
|
+
3. Write code as if already authenticated.
|
|
49
23
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
|
53
|
-
Code should be written as if already authenticated.
|
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
|
54
26
|
|
|
55
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
|
63
|
-
containers where writing files is difficult or not encouraged.
|
|
29
|
+
The google-cloud-web_risk-v1beta1 library provides several mechanisms to configure your system.
|
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
|
32
|
+
credentials, there are several methods available to you.
|
|
64
33
|
|
|
65
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::WebRisk::V1beta1::WebRiskService::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
36
|
+
1. Credentials specified in method arguments
|
|
37
|
+
2. Credentials specified in configuration
|
|
38
|
+
3. Credentials pointed to or included in environment variables
|
|
39
|
+
4. Credentials found in local ADC file
|
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/cloud/web_risk/v1beta1"
|
|
77
|
-
|
|
78
|
-
ENV["WEBRISK_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
82
49
|
|
|
83
|
-
|
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
52
|
+
whenever possible.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/cloud/web_risk/v1beta1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/web_risk/v1beta1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
|
81
|
+
you can include the credentials file itself.
|
|
113
82
|
|
|
114
|
-
|
|
83
|
+
The JSON file can contain credentials created for
|
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
90
|
+
whenever possible.
|
|
91
|
+
|
|
92
|
+
The environment variables that google-cloud-web_risk-v1beta1
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/web_risk/v1beta1"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-web_risk-v1beta1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
|
110
|
+
then the local ADC credentials are discovered.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -31,6 +31,9 @@ module Google
|
|
|
31
31
|
# website and in client applications.
|
|
32
32
|
#
|
|
33
33
|
class Client
|
|
34
|
+
# @private
|
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "webrisk.$UNIVERSE_DOMAIN$"
|
|
36
|
+
|
|
34
37
|
# @private
|
|
35
38
|
attr_reader :web_risk_service_stub
|
|
36
39
|
|
|
@@ -104,6 +107,15 @@ module Google
|
|
|
104
107
|
@config
|
|
105
108
|
end
|
|
106
109
|
|
|
110
|
+
##
|
|
111
|
+
# The effective universe domain
|
|
112
|
+
#
|
|
113
|
+
# @return [String]
|
|
114
|
+
#
|
|
115
|
+
def universe_domain
|
|
116
|
+
@web_risk_service_stub.universe_domain
|
|
117
|
+
end
|
|
118
|
+
|
|
107
119
|
##
|
|
108
120
|
# Create a new WebRiskService client object.
|
|
109
121
|
#
|
|
@@ -137,8 +149,9 @@ module Google
|
|
|
137
149
|
credentials = @config.credentials
|
|
138
150
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
139
151
|
# but only if the default endpoint does not have a region prefix.
|
|
140
|
-
enable_self_signed_jwt = @config.endpoint
|
|
141
|
-
|
|
152
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
153
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
154
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
142
155
|
credentials ||= Credentials.default scope: @config.scope,
|
|
143
156
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
144
157
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -149,10 +162,13 @@ module Google
|
|
|
149
162
|
|
|
150
163
|
@web_risk_service_stub = ::Gapic::ServiceStub.new(
|
|
151
164
|
::Google::Cloud::WebRisk::V1beta1::WebRiskServiceV1Beta1::Stub,
|
|
152
|
-
credentials:
|
|
153
|
-
endpoint:
|
|
165
|
+
credentials: credentials,
|
|
166
|
+
endpoint: @config.endpoint,
|
|
167
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
168
|
+
universe_domain: @config.universe_domain,
|
|
154
169
|
channel_args: @config.channel_args,
|
|
155
|
-
interceptors: @config.interceptors
|
|
170
|
+
interceptors: @config.interceptors,
|
|
171
|
+
channel_pool_config: @config.channel_pool
|
|
156
172
|
)
|
|
157
173
|
end
|
|
158
174
|
|
|
@@ -433,9 +449,9 @@ module Google
|
|
|
433
449
|
# end
|
|
434
450
|
#
|
|
435
451
|
# @!attribute [rw] endpoint
|
|
436
|
-
#
|
|
437
|
-
#
|
|
438
|
-
# @return [::String]
|
|
452
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
453
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
454
|
+
# @return [::String,nil]
|
|
439
455
|
# @!attribute [rw] credentials
|
|
440
456
|
# Credentials to send with calls. You may provide any of the following types:
|
|
441
457
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -481,13 +497,20 @@ module Google
|
|
|
481
497
|
# @!attribute [rw] quota_project
|
|
482
498
|
# A separate project against which to charge quota.
|
|
483
499
|
# @return [::String]
|
|
500
|
+
# @!attribute [rw] universe_domain
|
|
501
|
+
# The universe domain within which to make requests. This determines the
|
|
502
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
503
|
+
# universe (usually the default "googleapis.com" universe).
|
|
504
|
+
# @return [::String,nil]
|
|
484
505
|
#
|
|
485
506
|
class Configuration
|
|
486
507
|
extend ::Gapic::Config
|
|
487
508
|
|
|
509
|
+
# @private
|
|
510
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
488
511
|
DEFAULT_ENDPOINT = "webrisk.googleapis.com"
|
|
489
512
|
|
|
490
|
-
config_attr :endpoint,
|
|
513
|
+
config_attr :endpoint, nil, ::String, nil
|
|
491
514
|
config_attr :credentials, nil do |value|
|
|
492
515
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
493
516
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -502,6 +525,7 @@ module Google
|
|
|
502
525
|
config_attr :metadata, nil, ::Hash, nil
|
|
503
526
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
504
527
|
config_attr :quota_project, nil, ::String, nil
|
|
528
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
505
529
|
|
|
506
530
|
# @private
|
|
507
531
|
def initialize parent_config = nil
|
|
@@ -522,6 +546,14 @@ module Google
|
|
|
522
546
|
end
|
|
523
547
|
end
|
|
524
548
|
|
|
549
|
+
##
|
|
550
|
+
# Configuration for the channel pool
|
|
551
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
|
552
|
+
#
|
|
553
|
+
def channel_pool
|
|
554
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
|
555
|
+
end
|
|
556
|
+
|
|
525
557
|
##
|
|
526
558
|
# Configuration RPC class for the WebRiskService API.
|
|
527
559
|
#
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# website and in client applications.
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "webrisk.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
# @private
|
|
37
40
|
attr_reader :web_risk_service_stub
|
|
38
41
|
|
|
@@ -106,6 +109,15 @@ module Google
|
|
|
106
109
|
@config
|
|
107
110
|
end
|
|
108
111
|
|
|
112
|
+
##
|
|
113
|
+
# The effective universe domain
|
|
114
|
+
#
|
|
115
|
+
# @return [String]
|
|
116
|
+
#
|
|
117
|
+
def universe_domain
|
|
118
|
+
@web_risk_service_stub.universe_domain
|
|
119
|
+
end
|
|
120
|
+
|
|
109
121
|
##
|
|
110
122
|
# Create a new WebRiskService REST client object.
|
|
111
123
|
#
|
|
@@ -133,8 +145,9 @@ module Google
|
|
|
133
145
|
credentials = @config.credentials
|
|
134
146
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
135
147
|
# but only if the default endpoint does not have a region prefix.
|
|
136
|
-
enable_self_signed_jwt = @config.endpoint
|
|
137
|
-
|
|
148
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
149
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
150
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
138
151
|
credentials ||= Credentials.default scope: @config.scope,
|
|
139
152
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
140
153
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -144,7 +157,12 @@ module Google
|
|
|
144
157
|
@quota_project_id = @config.quota_project
|
|
145
158
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
146
159
|
|
|
147
|
-
@web_risk_service_stub = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Rest::ServiceStub.new
|
|
160
|
+
@web_risk_service_stub = ::Google::Cloud::WebRisk::V1beta1::WebRiskService::Rest::ServiceStub.new(
|
|
161
|
+
endpoint: @config.endpoint,
|
|
162
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
163
|
+
universe_domain: @config.universe_domain,
|
|
164
|
+
credentials: credentials
|
|
165
|
+
)
|
|
148
166
|
end
|
|
149
167
|
|
|
150
168
|
# Service calls
|
|
@@ -181,6 +199,22 @@ module Google
|
|
|
181
199
|
# @return [::Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse]
|
|
182
200
|
#
|
|
183
201
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
202
|
+
#
|
|
203
|
+
# @example Basic example
|
|
204
|
+
# require "google/cloud/web_risk/v1beta1"
|
|
205
|
+
#
|
|
206
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
207
|
+
# client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Rest::Client.new
|
|
208
|
+
#
|
|
209
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
210
|
+
# request = Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffRequest.new
|
|
211
|
+
#
|
|
212
|
+
# # Call the compute_threat_list_diff method.
|
|
213
|
+
# result = client.compute_threat_list_diff request
|
|
214
|
+
#
|
|
215
|
+
# # The returned object is of type Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse.
|
|
216
|
+
# p result
|
|
217
|
+
#
|
|
184
218
|
def compute_threat_list_diff request, options = nil
|
|
185
219
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
186
220
|
|
|
@@ -245,6 +279,22 @@ module Google
|
|
|
245
279
|
# @return [::Google::Cloud::WebRisk::V1beta1::SearchUrisResponse]
|
|
246
280
|
#
|
|
247
281
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
282
|
+
#
|
|
283
|
+
# @example Basic example
|
|
284
|
+
# require "google/cloud/web_risk/v1beta1"
|
|
285
|
+
#
|
|
286
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
287
|
+
# client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Rest::Client.new
|
|
288
|
+
#
|
|
289
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
290
|
+
# request = Google::Cloud::WebRisk::V1beta1::SearchUrisRequest.new
|
|
291
|
+
#
|
|
292
|
+
# # Call the search_uris method.
|
|
293
|
+
# result = client.search_uris request
|
|
294
|
+
#
|
|
295
|
+
# # The returned object is of type Google::Cloud::WebRisk::V1beta1::SearchUrisResponse.
|
|
296
|
+
# p result
|
|
297
|
+
#
|
|
248
298
|
def search_uris request, options = nil
|
|
249
299
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
250
300
|
|
|
@@ -314,6 +364,22 @@ module Google
|
|
|
314
364
|
# @return [::Google::Cloud::WebRisk::V1beta1::SearchHashesResponse]
|
|
315
365
|
#
|
|
316
366
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
367
|
+
#
|
|
368
|
+
# @example Basic example
|
|
369
|
+
# require "google/cloud/web_risk/v1beta1"
|
|
370
|
+
#
|
|
371
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
372
|
+
# client = Google::Cloud::WebRisk::V1beta1::WebRiskService::Rest::Client.new
|
|
373
|
+
#
|
|
374
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
375
|
+
# request = Google::Cloud::WebRisk::V1beta1::SearchHashesRequest.new
|
|
376
|
+
#
|
|
377
|
+
# # Call the search_hashes method.
|
|
378
|
+
# result = client.search_hashes request
|
|
379
|
+
#
|
|
380
|
+
# # The returned object is of type Google::Cloud::WebRisk::V1beta1::SearchHashesResponse.
|
|
381
|
+
# p result
|
|
382
|
+
#
|
|
317
383
|
def search_hashes request, options = nil
|
|
318
384
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
319
385
|
|
|
@@ -379,9 +445,9 @@ module Google
|
|
|
379
445
|
# end
|
|
380
446
|
#
|
|
381
447
|
# @!attribute [rw] endpoint
|
|
382
|
-
#
|
|
383
|
-
#
|
|
384
|
-
# @return [::String]
|
|
448
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
449
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
450
|
+
# @return [::String,nil]
|
|
385
451
|
# @!attribute [rw] credentials
|
|
386
452
|
# Credentials to send with calls. You may provide any of the following types:
|
|
387
453
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -418,13 +484,20 @@ module Google
|
|
|
418
484
|
# @!attribute [rw] quota_project
|
|
419
485
|
# A separate project against which to charge quota.
|
|
420
486
|
# @return [::String]
|
|
487
|
+
# @!attribute [rw] universe_domain
|
|
488
|
+
# The universe domain within which to make requests. This determines the
|
|
489
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
490
|
+
# universe (usually the default "googleapis.com" universe).
|
|
491
|
+
# @return [::String,nil]
|
|
421
492
|
#
|
|
422
493
|
class Configuration
|
|
423
494
|
extend ::Gapic::Config
|
|
424
495
|
|
|
496
|
+
# @private
|
|
497
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
425
498
|
DEFAULT_ENDPOINT = "webrisk.googleapis.com"
|
|
426
499
|
|
|
427
|
-
config_attr :endpoint,
|
|
500
|
+
config_attr :endpoint, nil, ::String, nil
|
|
428
501
|
config_attr :credentials, nil do |value|
|
|
429
502
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
430
503
|
allowed.any? { |klass| klass === value }
|
|
@@ -436,6 +509,7 @@ module Google
|
|
|
436
509
|
config_attr :metadata, nil, ::Hash, nil
|
|
437
510
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
438
511
|
config_attr :quota_project, nil, ::String, nil
|
|
512
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
439
513
|
|
|
440
514
|
# @private
|
|
441
515
|
def initialize parent_config = nil
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the compute_threat_list_diff REST call
|
|
45
57
|
#
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -66,6 +66,20 @@ module Google
|
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
|
67
67
|
# non-empty value to expect.
|
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
|
69
|
+
|
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
|
73
|
+
# `name` field on the resource.
|
|
74
|
+
#
|
|
75
|
+
# This behavior should not be applied to references to other resources within
|
|
76
|
+
# the message.
|
|
77
|
+
#
|
|
78
|
+
# The identifier field of resources often have different field behavior
|
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
|
82
|
+
IDENTIFIER = 8
|
|
69
83
|
end
|
|
70
84
|
end
|
|
71
85
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-web_risk-v1beta1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.9.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.21.1
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
209
209
|
- !ruby/object:Gem::Version
|
|
210
210
|
version: '0'
|
|
211
211
|
requirements: []
|
|
212
|
-
rubygems_version: 3.
|
|
212
|
+
rubygems_version: 3.5.3
|
|
213
213
|
signing_key:
|
|
214
214
|
specification_version: 4
|
|
215
215
|
summary: API Client library for the Web Risk V1beta1 API
|