google-cloud-web_security_scanner-v1beta 0.6.1 → 0.8.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 41608f1f678f7cc7e6beab96eb6a79ace97af4d2259326159282241346524207
4
- data.tar.gz: 58fd1388bc01f0775fd7b4990cc29d9b6c85188b0b24965ab5d8760236f25faa
3
+ metadata.gz: a9c3cec84fb4165ce0661876ff0d99fd9df677deca85a1482908c98126ed7c83
4
+ data.tar.gz: 7c686aa5102ff4359544cc090257814368ae756bd9fdf06cec7f376b0962af9b
5
5
  SHA512:
6
- metadata.gz: b662bcc2d8fccc7959dd1ccf85f7f07ee3f9d8de06cdce5c027172b48ce3557edd79ab93a898758ac48c2d68dfee248885f838995e6e7559af28751d9063f0e0
7
- data.tar.gz: d1c27b8b8c216767abed2101324f9c2b4f5dc9317754e536eea413e0053ced69aa99ae2f6e874253e82263f9d3a36410117c7b5d705548512da8532e8d49b7fd
6
+ metadata.gz: ca4028977d526ec7a7e7dba326191bc6674481eedd47410dbca8fe7feeab59dfede9b632341dce62055bba3a25d63acc3d7c1ab4f0483216dce4799a8357ec72
7
+ data.tar.gz: fd532e71877399c130198a177e1b2e378aa311323472b54cb246e85da65f88299138e6495a9edd00dbcacb72cf1bfae37b6284b921775f815e1e7ba7365c8127
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-web_security_scanner-v1beta library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
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_security_scanner-v1beta 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
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export WEB_SECURITY_SCANNER_CREDENTIALS=path/to/keyfile.json
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
- ```ruby
28
- require "google/cloud/web_security_scanner/v1beta"
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
- client = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-web_security_scanner-v1beta 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
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
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
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
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_security_scanner-v1beta 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
- The environment variables that google-cloud-web_security_scanner-v1beta
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `WEB_SECURITY_SCANNER_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `WEB_SECURITY_SCANNER_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
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
- ```ruby
76
- require "google/cloud/web_security_scanner/v1beta"
77
-
78
- ENV["WEB_SECURITY_SCANNER_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new
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
- ### Configuration
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
- The path to the **Credentials JSON** file can be configured instead of storing
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_security_scanner/v1beta"
90
58
 
91
59
  client = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/web_security_scanner/v1beta"
100
68
 
101
69
  ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
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
- To configure your system for this, simply:
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
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
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_security_scanner-v1beta
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/web_security_scanner/v1beta"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-web_security_scanner-v1beta.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
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
- *Note: You may need to enable billing in order to use these services.*
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
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
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
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module WebSecurityScanner
23
23
  module V1beta
24
- VERSION = "0.6.1"
24
+ VERSION = "0.8.0"
25
25
  end
26
26
  end
27
27
  end
@@ -32,6 +32,9 @@ module Google
32
32
  # attempts to exercise as many user inputs and event handlers as possible.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "websecurityscanner.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -145,6 +148,15 @@ module Google
145
148
  @config
146
149
  end
147
150
 
151
+ ##
152
+ # The effective universe domain
153
+ #
154
+ # @return [String]
155
+ #
156
+ def universe_domain
157
+ @web_security_scanner_stub.universe_domain
158
+ end
159
+
148
160
  ##
149
161
  # Create a new WebSecurityScanner client object.
150
162
  #
@@ -178,8 +190,9 @@ module Google
178
190
  credentials = @config.credentials
179
191
  # Use self-signed JWT if the endpoint is unchanged from default,
180
192
  # but only if the default endpoint does not have a region prefix.
181
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
182
- !@config.endpoint.split(".").first.include?("-")
193
+ enable_self_signed_jwt = @config.endpoint.nil? ||
194
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
195
+ !@config.endpoint.split(".").first.include?("-"))
183
196
  credentials ||= Credentials.default scope: @config.scope,
184
197
  enable_self_signed_jwt: enable_self_signed_jwt
185
198
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -190,10 +203,13 @@ module Google
190
203
 
191
204
  @web_security_scanner_stub = ::Gapic::ServiceStub.new(
192
205
  ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Stub,
193
- credentials: credentials,
194
- endpoint: @config.endpoint,
206
+ credentials: credentials,
207
+ endpoint: @config.endpoint,
208
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
209
+ universe_domain: @config.universe_domain,
195
210
  channel_args: @config.channel_args,
196
- interceptors: @config.interceptors
211
+ interceptors: @config.interceptors,
212
+ channel_pool_config: @config.channel_pool
197
213
  )
198
214
  end
199
215
 
@@ -1418,9 +1434,9 @@ module Google
1418
1434
  # end
1419
1435
  #
1420
1436
  # @!attribute [rw] endpoint
1421
- # The hostname or hostname:port of the service endpoint.
1422
- # Defaults to `"websecurityscanner.googleapis.com"`.
1423
- # @return [::String]
1437
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1438
+ # nil, indicating to use the default endpoint in the current universe domain.
1439
+ # @return [::String,nil]
1424
1440
  # @!attribute [rw] credentials
1425
1441
  # Credentials to send with calls. You may provide any of the following types:
1426
1442
  # * (`String`) The path to a service account key file in JSON format
@@ -1466,13 +1482,20 @@ module Google
1466
1482
  # @!attribute [rw] quota_project
1467
1483
  # A separate project against which to charge quota.
1468
1484
  # @return [::String]
1485
+ # @!attribute [rw] universe_domain
1486
+ # The universe domain within which to make requests. This determines the
1487
+ # default endpoint URL. The default value of nil uses the environment
1488
+ # universe (usually the default "googleapis.com" universe).
1489
+ # @return [::String,nil]
1469
1490
  #
1470
1491
  class Configuration
1471
1492
  extend ::Gapic::Config
1472
1493
 
1494
+ # @private
1495
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1473
1496
  DEFAULT_ENDPOINT = "websecurityscanner.googleapis.com"
1474
1497
 
1475
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1498
+ config_attr :endpoint, nil, ::String, nil
1476
1499
  config_attr :credentials, nil do |value|
1477
1500
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1478
1501
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1487,6 +1510,7 @@ module Google
1487
1510
  config_attr :metadata, nil, ::Hash, nil
1488
1511
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1489
1512
  config_attr :quota_project, nil, ::String, nil
1513
+ config_attr :universe_domain, nil, ::String, nil
1490
1514
 
1491
1515
  # @private
1492
1516
  def initialize parent_config = nil
@@ -1507,6 +1531,14 @@ module Google
1507
1531
  end
1508
1532
  end
1509
1533
 
1534
+ ##
1535
+ # Configuration for the channel pool
1536
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1537
+ #
1538
+ def channel_pool
1539
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1540
+ end
1541
+
1510
1542
  ##
1511
1543
  # Configuration RPC class for the WebSecurityScanner API.
1512
1544
  #
@@ -34,6 +34,9 @@ module Google
34
34
  # attempts to exercise as many user inputs and event handlers as possible.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "websecurityscanner.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -147,6 +150,15 @@ module Google
147
150
  @config
148
151
  end
149
152
 
153
+ ##
154
+ # The effective universe domain
155
+ #
156
+ # @return [String]
157
+ #
158
+ def universe_domain
159
+ @web_security_scanner_stub.universe_domain
160
+ end
161
+
150
162
  ##
151
163
  # Create a new WebSecurityScanner REST client object.
152
164
  #
@@ -174,8 +186,9 @@ module Google
174
186
  credentials = @config.credentials
175
187
  # Use self-signed JWT if the endpoint is unchanged from default,
176
188
  # but only if the default endpoint does not have a region prefix.
177
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
178
- !@config.endpoint.split(".").first.include?("-")
189
+ enable_self_signed_jwt = @config.endpoint.nil? ||
190
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
191
+ !@config.endpoint.split(".").first.include?("-"))
179
192
  credentials ||= Credentials.default scope: @config.scope,
180
193
  enable_self_signed_jwt: enable_self_signed_jwt
181
194
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -185,7 +198,12 @@ module Google
185
198
  @quota_project_id = @config.quota_project
186
199
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
187
200
 
188
- @web_security_scanner_stub = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
201
+ @web_security_scanner_stub = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::ServiceStub.new(
202
+ endpoint: @config.endpoint,
203
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
204
+ universe_domain: @config.universe_domain,
205
+ credentials: credentials
206
+ )
189
207
  end
190
208
 
191
209
  # Service calls
@@ -220,6 +238,22 @@ module Google
220
238
  # @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig]
221
239
  #
222
240
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
241
+ #
242
+ # @example Basic example
243
+ # require "google/cloud/web_security_scanner/v1beta"
244
+ #
245
+ # # Create a client object. The client can be reused for multiple calls.
246
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
247
+ #
248
+ # # Create a request. To set request fields, pass in keyword arguments.
249
+ # request = Google::Cloud::WebSecurityScanner::V1beta::CreateScanConfigRequest.new
250
+ #
251
+ # # Call the create_scan_config method.
252
+ # result = client.create_scan_config request
253
+ #
254
+ # # The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanConfig.
255
+ # p result
256
+ #
223
257
  def create_scan_config request, options = nil
224
258
  raise ::ArgumentError, "request must be provided" if request.nil?
225
259
 
@@ -283,6 +317,22 @@ module Google
283
317
  # @return [::Google::Protobuf::Empty]
284
318
  #
285
319
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
320
+ #
321
+ # @example Basic example
322
+ # require "google/cloud/web_security_scanner/v1beta"
323
+ #
324
+ # # Create a client object. The client can be reused for multiple calls.
325
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
326
+ #
327
+ # # Create a request. To set request fields, pass in keyword arguments.
328
+ # request = Google::Cloud::WebSecurityScanner::V1beta::DeleteScanConfigRequest.new
329
+ #
330
+ # # Call the delete_scan_config method.
331
+ # result = client.delete_scan_config request
332
+ #
333
+ # # The returned object is of type Google::Protobuf::Empty.
334
+ # p result
335
+ #
286
336
  def delete_scan_config request, options = nil
287
337
  raise ::ArgumentError, "request must be provided" if request.nil?
288
338
 
@@ -346,6 +396,22 @@ module Google
346
396
  # @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig]
347
397
  #
348
398
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
399
+ #
400
+ # @example Basic example
401
+ # require "google/cloud/web_security_scanner/v1beta"
402
+ #
403
+ # # Create a client object. The client can be reused for multiple calls.
404
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
405
+ #
406
+ # # Create a request. To set request fields, pass in keyword arguments.
407
+ # request = Google::Cloud::WebSecurityScanner::V1beta::GetScanConfigRequest.new
408
+ #
409
+ # # Call the get_scan_config method.
410
+ # result = client.get_scan_config request
411
+ #
412
+ # # The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanConfig.
413
+ # p result
414
+ #
349
415
  def get_scan_config request, options = nil
350
416
  raise ::ArgumentError, "request must be provided" if request.nil?
351
417
 
@@ -417,6 +483,26 @@ module Google
417
483
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig>]
418
484
  #
419
485
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
486
+ #
487
+ # @example Basic example
488
+ # require "google/cloud/web_security_scanner/v1beta"
489
+ #
490
+ # # Create a client object. The client can be reused for multiple calls.
491
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
492
+ #
493
+ # # Create a request. To set request fields, pass in keyword arguments.
494
+ # request = Google::Cloud::WebSecurityScanner::V1beta::ListScanConfigsRequest.new
495
+ #
496
+ # # Call the list_scan_configs method.
497
+ # result = client.list_scan_configs request
498
+ #
499
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
500
+ # # over elements, and API calls will be issued to fetch pages as needed.
501
+ # result.each do |item|
502
+ # # Each element is of type ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig.
503
+ # p item
504
+ # end
505
+ #
420
506
  def list_scan_configs request, options = nil
421
507
  raise ::ArgumentError, "request must be provided" if request.nil?
422
508
 
@@ -486,6 +572,22 @@ module Google
486
572
  # @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig]
487
573
  #
488
574
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
575
+ #
576
+ # @example Basic example
577
+ # require "google/cloud/web_security_scanner/v1beta"
578
+ #
579
+ # # Create a client object. The client can be reused for multiple calls.
580
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
581
+ #
582
+ # # Create a request. To set request fields, pass in keyword arguments.
583
+ # request = Google::Cloud::WebSecurityScanner::V1beta::UpdateScanConfigRequest.new
584
+ #
585
+ # # Call the update_scan_config method.
586
+ # result = client.update_scan_config request
587
+ #
588
+ # # The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanConfig.
589
+ # p result
590
+ #
489
591
  def update_scan_config request, options = nil
490
592
  raise ::ArgumentError, "request must be provided" if request.nil?
491
593
 
@@ -549,6 +651,22 @@ module Google
549
651
  # @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanRun]
550
652
  #
551
653
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
654
+ #
655
+ # @example Basic example
656
+ # require "google/cloud/web_security_scanner/v1beta"
657
+ #
658
+ # # Create a client object. The client can be reused for multiple calls.
659
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
660
+ #
661
+ # # Create a request. To set request fields, pass in keyword arguments.
662
+ # request = Google::Cloud::WebSecurityScanner::V1beta::StartScanRunRequest.new
663
+ #
664
+ # # Call the start_scan_run method.
665
+ # result = client.start_scan_run request
666
+ #
667
+ # # The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanRun.
668
+ # p result
669
+ #
552
670
  def start_scan_run request, options = nil
553
671
  raise ::ArgumentError, "request must be provided" if request.nil?
554
672
 
@@ -613,6 +731,22 @@ module Google
613
731
  # @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanRun]
614
732
  #
615
733
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
734
+ #
735
+ # @example Basic example
736
+ # require "google/cloud/web_security_scanner/v1beta"
737
+ #
738
+ # # Create a client object. The client can be reused for multiple calls.
739
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
740
+ #
741
+ # # Create a request. To set request fields, pass in keyword arguments.
742
+ # request = Google::Cloud::WebSecurityScanner::V1beta::GetScanRunRequest.new
743
+ #
744
+ # # Call the get_scan_run method.
745
+ # result = client.get_scan_run request
746
+ #
747
+ # # The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanRun.
748
+ # p result
749
+ #
616
750
  def get_scan_run request, options = nil
617
751
  raise ::ArgumentError, "request must be provided" if request.nil?
618
752
 
@@ -685,6 +819,26 @@ module Google
685
819
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanRun>]
686
820
  #
687
821
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
822
+ #
823
+ # @example Basic example
824
+ # require "google/cloud/web_security_scanner/v1beta"
825
+ #
826
+ # # Create a client object. The client can be reused for multiple calls.
827
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
828
+ #
829
+ # # Create a request. To set request fields, pass in keyword arguments.
830
+ # request = Google::Cloud::WebSecurityScanner::V1beta::ListScanRunsRequest.new
831
+ #
832
+ # # Call the list_scan_runs method.
833
+ # result = client.list_scan_runs request
834
+ #
835
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
836
+ # # over elements, and API calls will be issued to fetch pages as needed.
837
+ # result.each do |item|
838
+ # # Each element is of type ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun.
839
+ # p item
840
+ # end
841
+ #
688
842
  def list_scan_runs request, options = nil
689
843
  raise ::ArgumentError, "request must be provided" if request.nil?
690
844
 
@@ -750,6 +904,22 @@ module Google
750
904
  # @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanRun]
751
905
  #
752
906
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
907
+ #
908
+ # @example Basic example
909
+ # require "google/cloud/web_security_scanner/v1beta"
910
+ #
911
+ # # Create a client object. The client can be reused for multiple calls.
912
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
913
+ #
914
+ # # Create a request. To set request fields, pass in keyword arguments.
915
+ # request = Google::Cloud::WebSecurityScanner::V1beta::StopScanRunRequest.new
916
+ #
917
+ # # Call the stop_scan_run method.
918
+ # result = client.stop_scan_run request
919
+ #
920
+ # # The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanRun.
921
+ # p result
922
+ #
753
923
  def stop_scan_run request, options = nil
754
924
  raise ::ArgumentError, "request must be provided" if request.nil?
755
925
 
@@ -822,6 +992,26 @@ module Google
822
992
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::CrawledUrl>]
823
993
  #
824
994
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
995
+ #
996
+ # @example Basic example
997
+ # require "google/cloud/web_security_scanner/v1beta"
998
+ #
999
+ # # Create a client object. The client can be reused for multiple calls.
1000
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
1001
+ #
1002
+ # # Create a request. To set request fields, pass in keyword arguments.
1003
+ # request = Google::Cloud::WebSecurityScanner::V1beta::ListCrawledUrlsRequest.new
1004
+ #
1005
+ # # Call the list_crawled_urls method.
1006
+ # result = client.list_crawled_urls request
1007
+ #
1008
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1009
+ # # over elements, and API calls will be issued to fetch pages as needed.
1010
+ # result.each do |item|
1011
+ # # Each element is of type ::Google::Cloud::WebSecurityScanner::V1beta::CrawledUrl.
1012
+ # p item
1013
+ # end
1014
+ #
825
1015
  def list_crawled_urls request, options = nil
826
1016
  raise ::ArgumentError, "request must be provided" if request.nil?
827
1017
 
@@ -887,6 +1077,22 @@ module Google
887
1077
  # @return [::Google::Cloud::WebSecurityScanner::V1beta::Finding]
888
1078
  #
889
1079
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1080
+ #
1081
+ # @example Basic example
1082
+ # require "google/cloud/web_security_scanner/v1beta"
1083
+ #
1084
+ # # Create a client object. The client can be reused for multiple calls.
1085
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
1086
+ #
1087
+ # # Create a request. To set request fields, pass in keyword arguments.
1088
+ # request = Google::Cloud::WebSecurityScanner::V1beta::GetFindingRequest.new
1089
+ #
1090
+ # # Call the get_finding method.
1091
+ # result = client.get_finding request
1092
+ #
1093
+ # # The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::Finding.
1094
+ # p result
1095
+ #
890
1096
  def get_finding request, options = nil
891
1097
  raise ::ArgumentError, "request must be provided" if request.nil?
892
1098
 
@@ -964,6 +1170,26 @@ module Google
964
1170
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::Finding>]
965
1171
  #
966
1172
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1173
+ #
1174
+ # @example Basic example
1175
+ # require "google/cloud/web_security_scanner/v1beta"
1176
+ #
1177
+ # # Create a client object. The client can be reused for multiple calls.
1178
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
1179
+ #
1180
+ # # Create a request. To set request fields, pass in keyword arguments.
1181
+ # request = Google::Cloud::WebSecurityScanner::V1beta::ListFindingsRequest.new
1182
+ #
1183
+ # # Call the list_findings method.
1184
+ # result = client.list_findings request
1185
+ #
1186
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1187
+ # # over elements, and API calls will be issued to fetch pages as needed.
1188
+ # result.each do |item|
1189
+ # # Each element is of type ::Google::Cloud::WebSecurityScanner::V1beta::Finding.
1190
+ # p item
1191
+ # end
1192
+ #
967
1193
  def list_findings request, options = nil
968
1194
  raise ::ArgumentError, "request must be provided" if request.nil?
969
1195
 
@@ -1029,6 +1255,22 @@ module Google
1029
1255
  # @return [::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsResponse]
1030
1256
  #
1031
1257
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1258
+ #
1259
+ # @example Basic example
1260
+ # require "google/cloud/web_security_scanner/v1beta"
1261
+ #
1262
+ # # Create a client object. The client can be reused for multiple calls.
1263
+ # client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::Client.new
1264
+ #
1265
+ # # Create a request. To set request fields, pass in keyword arguments.
1266
+ # request = Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsRequest.new
1267
+ #
1268
+ # # Call the list_finding_type_stats method.
1269
+ # result = client.list_finding_type_stats request
1270
+ #
1271
+ # # The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsResponse.
1272
+ # p result
1273
+ #
1032
1274
  def list_finding_type_stats request, options = nil
1033
1275
  raise ::ArgumentError, "request must be provided" if request.nil?
1034
1276
 
@@ -1094,9 +1336,9 @@ module Google
1094
1336
  # end
1095
1337
  #
1096
1338
  # @!attribute [rw] endpoint
1097
- # The hostname or hostname:port of the service endpoint.
1098
- # Defaults to `"websecurityscanner.googleapis.com"`.
1099
- # @return [::String]
1339
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1340
+ # nil, indicating to use the default endpoint in the current universe domain.
1341
+ # @return [::String,nil]
1100
1342
  # @!attribute [rw] credentials
1101
1343
  # Credentials to send with calls. You may provide any of the following types:
1102
1344
  # * (`String`) The path to a service account key file in JSON format
@@ -1133,13 +1375,20 @@ module Google
1133
1375
  # @!attribute [rw] quota_project
1134
1376
  # A separate project against which to charge quota.
1135
1377
  # @return [::String]
1378
+ # @!attribute [rw] universe_domain
1379
+ # The universe domain within which to make requests. This determines the
1380
+ # default endpoint URL. The default value of nil uses the environment
1381
+ # universe (usually the default "googleapis.com" universe).
1382
+ # @return [::String,nil]
1136
1383
  #
1137
1384
  class Configuration
1138
1385
  extend ::Gapic::Config
1139
1386
 
1387
+ # @private
1388
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1140
1389
  DEFAULT_ENDPOINT = "websecurityscanner.googleapis.com"
1141
1390
 
1142
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1391
+ config_attr :endpoint, nil, ::String, nil
1143
1392
  config_attr :credentials, nil do |value|
1144
1393
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1145
1394
  allowed.any? { |klass| klass === value }
@@ -1151,6 +1400,7 @@ module Google
1151
1400
  config_attr :metadata, nil, ::Hash, nil
1152
1401
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1153
1402
  config_attr :quota_project, nil, ::String, nil
1403
+ config_attr :universe_domain, nil, ::String, nil
1154
1404
 
1155
1405
  # @private
1156
1406
  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, credentials: credentials,
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 create_scan_config 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_security_scanner-v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.1
4
+ version: 0.8.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: 2023-06-06 00:00:00.000000000 Z
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.1
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.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
229
229
  - !ruby/object:Gem::Version
230
230
  version: '0'
231
231
  requirements: []
232
- rubygems_version: 3.4.2
232
+ rubygems_version: 3.5.3
233
233
  signing_key:
234
234
  specification_version: 4
235
235
  summary: Scans your Compute and App Engine apps for common web vulnerabilities.