google-cloud-security_center-v1 0.33.0 → 0.34.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: d47daa8705e1a38fc97a8baf6a4a7c709a02dc0cc805cedb4df2791e29f06c32
4
- data.tar.gz: 8542cc30a72555ac9ee961d143f5643dba0342b5ca09f144a3b1c31f7480e77e
3
+ metadata.gz: 22f9163d8d996218045d1259f59294ef11c067d515fa4022ae6406c2dfa9fd20
4
+ data.tar.gz: ef75ff4357283b582bd46b4abae02beb6b2bbd5edf3e4b5495a8d8fdc2a7f2cd
5
5
  SHA512:
6
- metadata.gz: a3439ccf2010ffd13e942af170c259112e4387e61b5252845fa041dbe7f987a145aa4ccb7325b457f1dca340016eeff2e39caf2b4db607a7608a2e81938567f0
7
- data.tar.gz: f75c54c8eaeff55e7ac365a60b9589fa190d68ff0eefb00b6e3eff5e7d4a546bffb55023505ec07ca3a126f6a48751170595f6f1076d81d4feda61067e98a4ea
6
+ metadata.gz: eea920cc4f7af66074e701d865c63ab756dabd1147fa62ae2d3063cdace2e53f6737ea6f3ace54da5736e7a708eec35985fea62de29dc996bda18d1d05da764e
7
+ data.tar.gz: b31f8cb3df40543f1d8096204241a7f42f1034f5884aff05b9883c310e08bc43b3dd3a2aa18b572a3ca35885f6245fc989feb9315aab6308c886f1c45d883563
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-security_center-v1 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-security_center-v1 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 SECURITY_CENTER_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/security_center/v1"
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::SecurityCenter::V1::SecurityCenter::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-security_center-v1 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-security_center-v1 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-security_center-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::SecurityCenter::V1::SecurityCenter::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `SECURITY_CENTER_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `SECURITY_CENTER_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/security_center/v1"
77
-
78
- ENV["SECURITY_CENTER_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::SecurityCenter::V1::SecurityCenter::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/security_center/v1"
90
58
 
91
59
  client = ::Google::Cloud::SecurityCenter::V1::SecurityCenter::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/security_center/v1"
100
68
 
101
69
  ::Google::Cloud::SecurityCenter::V1::SecurityCenter::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::SecurityCenter::V1::SecurityCenter::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-security_center-v1
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/security_center/v1"
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-security_center-v1.
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::SecurityCenter::V1::SecurityCenter::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).
@@ -30,6 +30,9 @@ module Google
30
30
  # V1 APIs for Security Center service.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "securitycenter.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -200,6 +203,15 @@ module Google
200
203
  @config
201
204
  end
202
205
 
206
+ ##
207
+ # The effective universe domain
208
+ #
209
+ # @return [String]
210
+ #
211
+ def universe_domain
212
+ @security_center_stub.universe_domain
213
+ end
214
+
203
215
  ##
204
216
  # Create a new SecurityCenter client object.
205
217
  #
@@ -233,8 +245,9 @@ module Google
233
245
  credentials = @config.credentials
234
246
  # Use self-signed JWT if the endpoint is unchanged from default,
235
247
  # but only if the default endpoint does not have a region prefix.
236
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
237
- !@config.endpoint.split(".").first.include?("-")
248
+ enable_self_signed_jwt = @config.endpoint.nil? ||
249
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
250
+ !@config.endpoint.split(".").first.include?("-"))
238
251
  credentials ||= Credentials.default scope: @config.scope,
239
252
  enable_self_signed_jwt: enable_self_signed_jwt
240
253
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -247,12 +260,15 @@ module Google
247
260
  config.credentials = credentials
248
261
  config.quota_project = @quota_project_id
249
262
  config.endpoint = @config.endpoint
263
+ config.universe_domain = @config.universe_domain
250
264
  end
251
265
 
252
266
  @security_center_stub = ::Gapic::ServiceStub.new(
253
267
  ::Google::Cloud::SecurityCenter::V1::SecurityCenter::Stub,
254
- credentials: credentials,
255
- endpoint: @config.endpoint,
268
+ credentials: credentials,
269
+ endpoint: @config.endpoint,
270
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
271
+ universe_domain: @config.universe_domain,
256
272
  channel_args: @config.channel_args,
257
273
  interceptors: @config.interceptors,
258
274
  channel_pool_config: @config.channel_pool
@@ -3810,12 +3826,12 @@ module Google
3810
3826
  #
3811
3827
  # @param parent [::String]
3812
3828
  # Required. The relative resource name of the organization, project, or
3813
- # folder. See:
3814
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
3815
- # An example is:
3816
- # "organizations/\\{organization_id}".
3829
+ # folder. For more information about relative resource names, see [Relative
3830
+ # Resource
3831
+ # Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name)
3832
+ # Example: `organizations/{organization_id}`
3817
3833
  # @param custom_config [::Google::Cloud::SecurityCenter::V1::CustomConfig, ::Hash]
3818
- # Required. The user specified custom configuration to test.
3834
+ # Required. The custom configuration that you need to test.
3819
3835
  # @param resource [::Google::Cloud::SecurityCenter::V1::SimulateSecurityHealthAnalyticsCustomModuleRequest::SimulatedResource, ::Hash]
3820
3836
  # Required. Resource data to simulate custom module against.
3821
3837
  #
@@ -5020,9 +5036,9 @@ module Google
5020
5036
  # end
5021
5037
  #
5022
5038
  # @!attribute [rw] endpoint
5023
- # The hostname or hostname:port of the service endpoint.
5024
- # Defaults to `"securitycenter.googleapis.com"`.
5025
- # @return [::String]
5039
+ # A custom service endpoint, as a hostname or hostname:port. The default is
5040
+ # nil, indicating to use the default endpoint in the current universe domain.
5041
+ # @return [::String,nil]
5026
5042
  # @!attribute [rw] credentials
5027
5043
  # Credentials to send with calls. You may provide any of the following types:
5028
5044
  # * (`String`) The path to a service account key file in JSON format
@@ -5068,13 +5084,20 @@ module Google
5068
5084
  # @!attribute [rw] quota_project
5069
5085
  # A separate project against which to charge quota.
5070
5086
  # @return [::String]
5087
+ # @!attribute [rw] universe_domain
5088
+ # The universe domain within which to make requests. This determines the
5089
+ # default endpoint URL. The default value of nil uses the environment
5090
+ # universe (usually the default "googleapis.com" universe).
5091
+ # @return [::String,nil]
5071
5092
  #
5072
5093
  class Configuration
5073
5094
  extend ::Gapic::Config
5074
5095
 
5096
+ # @private
5097
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
5075
5098
  DEFAULT_ENDPOINT = "securitycenter.googleapis.com"
5076
5099
 
5077
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
5100
+ config_attr :endpoint, nil, ::String, nil
5078
5101
  config_attr :credentials, nil do |value|
5079
5102
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
5080
5103
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -5089,6 +5112,7 @@ module Google
5089
5112
  config_attr :metadata, nil, ::Hash, nil
5090
5113
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
5091
5114
  config_attr :quota_project, nil, ::String, nil
5115
+ config_attr :universe_domain, nil, ::String, nil
5092
5116
 
5093
5117
  # @private
5094
5118
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module SecurityCenter
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "securitycenter.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,8 +102,10 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
110
  interceptors: @config.interceptors,
97
111
  channel_pool_config: @config.channel_pool
@@ -613,9 +627,9 @@ module Google
613
627
  # end
614
628
  #
615
629
  # @!attribute [rw] endpoint
616
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"securitycenter.googleapis.com"`.
618
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
619
633
  # @!attribute [rw] credentials
620
634
  # Credentials to send with calls. You may provide any of the following types:
621
635
  # * (`String`) The path to a service account key file in JSON format
@@ -661,13 +675,20 @@ module Google
661
675
  # @!attribute [rw] quota_project
662
676
  # A separate project against which to charge quota.
663
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
664
683
  #
665
684
  class Configuration
666
685
  extend ::Gapic::Config
667
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
668
689
  DEFAULT_ENDPOINT = "securitycenter.googleapis.com"
669
690
 
670
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
671
692
  config_attr :credentials, nil do |value|
672
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
673
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -682,6 +703,7 @@ module Google
682
703
  config_attr :metadata, nil, ::Hash, nil
683
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
684
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
685
707
 
686
708
  # @private
687
709
  def initialize parent_config = nil
@@ -32,6 +32,9 @@ module Google
32
32
  # V1 APIs for Security Center service.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "securitycenter.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -202,6 +205,15 @@ module Google
202
205
  @config
203
206
  end
204
207
 
208
+ ##
209
+ # The effective universe domain
210
+ #
211
+ # @return [String]
212
+ #
213
+ def universe_domain
214
+ @security_center_stub.universe_domain
215
+ end
216
+
205
217
  ##
206
218
  # Create a new SecurityCenter REST client object.
207
219
  #
@@ -229,8 +241,9 @@ module Google
229
241
  credentials = @config.credentials
230
242
  # Use self-signed JWT if the endpoint is unchanged from default,
231
243
  # but only if the default endpoint does not have a region prefix.
232
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
233
- !@config.endpoint.split(".").first.include?("-")
244
+ enable_self_signed_jwt = @config.endpoint.nil? ||
245
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
246
+ !@config.endpoint.split(".").first.include?("-"))
234
247
  credentials ||= Credentials.default scope: @config.scope,
235
248
  enable_self_signed_jwt: enable_self_signed_jwt
236
249
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -244,9 +257,15 @@ module Google
244
257
  config.credentials = credentials
245
258
  config.quota_project = @quota_project_id
246
259
  config.endpoint = @config.endpoint
260
+ config.universe_domain = @config.universe_domain
247
261
  end
248
262
 
249
- @security_center_stub = ::Google::Cloud::SecurityCenter::V1::SecurityCenter::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
263
+ @security_center_stub = ::Google::Cloud::SecurityCenter::V1::SecurityCenter::Rest::ServiceStub.new(
264
+ endpoint: @config.endpoint,
265
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
266
+ universe_domain: @config.universe_domain,
267
+ credentials: credentials
268
+ )
250
269
  end
251
270
 
252
271
  ##
@@ -3570,12 +3589,12 @@ module Google
3570
3589
  #
3571
3590
  # @param parent [::String]
3572
3591
  # Required. The relative resource name of the organization, project, or
3573
- # folder. See:
3574
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
3575
- # An example is:
3576
- # "organizations/\\{organization_id}".
3592
+ # folder. For more information about relative resource names, see [Relative
3593
+ # Resource
3594
+ # Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name)
3595
+ # Example: `organizations/{organization_id}`
3577
3596
  # @param custom_config [::Google::Cloud::SecurityCenter::V1::CustomConfig, ::Hash]
3578
- # Required. The user specified custom configuration to test.
3597
+ # Required. The custom configuration that you need to test.
3579
3598
  # @param resource [::Google::Cloud::SecurityCenter::V1::SimulateSecurityHealthAnalyticsCustomModuleRequest::SimulatedResource, ::Hash]
3580
3599
  # Required. Resource data to simulate custom module against.
3581
3600
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -4689,9 +4708,9 @@ module Google
4689
4708
  # end
4690
4709
  #
4691
4710
  # @!attribute [rw] endpoint
4692
- # The hostname or hostname:port of the service endpoint.
4693
- # Defaults to `"securitycenter.googleapis.com"`.
4694
- # @return [::String]
4711
+ # A custom service endpoint, as a hostname or hostname:port. The default is
4712
+ # nil, indicating to use the default endpoint in the current universe domain.
4713
+ # @return [::String,nil]
4695
4714
  # @!attribute [rw] credentials
4696
4715
  # Credentials to send with calls. You may provide any of the following types:
4697
4716
  # * (`String`) The path to a service account key file in JSON format
@@ -4728,13 +4747,20 @@ module Google
4728
4747
  # @!attribute [rw] quota_project
4729
4748
  # A separate project against which to charge quota.
4730
4749
  # @return [::String]
4750
+ # @!attribute [rw] universe_domain
4751
+ # The universe domain within which to make requests. This determines the
4752
+ # default endpoint URL. The default value of nil uses the environment
4753
+ # universe (usually the default "googleapis.com" universe).
4754
+ # @return [::String,nil]
4731
4755
  #
4732
4756
  class Configuration
4733
4757
  extend ::Gapic::Config
4734
4758
 
4759
+ # @private
4760
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
4735
4761
  DEFAULT_ENDPOINT = "securitycenter.googleapis.com"
4736
4762
 
4737
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
4763
+ config_attr :endpoint, nil, ::String, nil
4738
4764
  config_attr :credentials, nil do |value|
4739
4765
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
4740
4766
  allowed.any? { |klass| klass === value }
@@ -4746,6 +4772,7 @@ module Google
4746
4772
  config_attr :metadata, nil, ::Hash, nil
4747
4773
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
4748
4774
  config_attr :quota_project, nil, ::String, nil
4775
+ config_attr :universe_domain, nil, ::String, nil
4749
4776
 
4750
4777
  # @private
4751
4778
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "securitycenter.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"securitycenter.googleapis.com"`.
483
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "securitycenter.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
626
651
  end
627
652
 
628
653
  ##
@@ -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 bulk_mute_findings REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module SecurityCenter
23
23
  module V1
24
- VERSION = "0.33.0"
24
+ VERSION = "0.34.0"
25
25
  end
26
26
  end
27
27
  end
@@ -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
@@ -30,6 +30,7 @@ module Google
30
30
  # "folders/\\{folder}/muteConfigs/\\{mute_config}"
31
31
  # "projects/\\{project}/muteConfigs/\\{mute_config}"
32
32
  # @!attribute [rw] display_name
33
+ # @deprecated This field is deprecated and may be removed in the next major version update.
33
34
  # @return [::String]
34
35
  # The human readable name to be displayed for the mute config.
35
36
  # @!attribute [rw] description
@@ -55,6 +55,7 @@ module Google
55
55
  # * integer literals without quotes.
56
56
  # * boolean literals `true` and `false` without quotes.
57
57
  # @!attribute [rw] mute_annotation
58
+ # @deprecated This field is deprecated and may be removed in the next major version update.
58
59
  # @return [::String]
59
60
  # This can be a mute configuration name or any identifier for mute/unmute
60
61
  # of findings based on the filter.
@@ -1323,13 +1324,13 @@ module Google
1323
1324
  # @!attribute [rw] parent
1324
1325
  # @return [::String]
1325
1326
  # Required. The relative resource name of the organization, project, or
1326
- # folder. See:
1327
- # https://cloud.google.com/apis/design/resource_names#relative_resource_name
1328
- # An example is:
1329
- # "organizations/\\{organization_id}".
1327
+ # folder. For more information about relative resource names, see [Relative
1328
+ # Resource
1329
+ # Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name)
1330
+ # Example: `organizations/{organization_id}`
1330
1331
  # @!attribute [rw] custom_config
1331
1332
  # @return [::Google::Cloud::SecurityCenter::V1::CustomConfig]
1332
- # Required. The user specified custom configuration to test.
1333
+ # Required. The custom configuration that you need to test.
1333
1334
  # @!attribute [rw] resource
1334
1335
  # @return [::Google::Cloud::SecurityCenter::V1::SimulateSecurityHealthAnalyticsCustomModuleRequest::SimulatedResource]
1335
1336
  # Required. Resource data to simulate custom module against.
@@ -1337,16 +1338,17 @@ module Google
1337
1338
  include ::Google::Protobuf::MessageExts
1338
1339
  extend ::Google::Protobuf::MessageExts::ClassMethods
1339
1340
 
1340
- # Manually constructed resource. If the custom module only evaluates against
1341
- # the resource data, the iam_policy_data field can be omitted, and vice
1342
- # versa.
1341
+ # Manually constructed resource name. If the custom module evaluates against
1342
+ # only the resource data, you can omit the `iam_policy_data` field. If it
1343
+ # evaluates only the `iam_policy_data` field, you can omit the resource data.
1343
1344
  # @!attribute [rw] resource_type
1344
1345
  # @return [::String]
1345
- # Required. The type of the resource, e.g. `compute.googleapis.com/Disk`.
1346
+ # Required. The type of the resource, for example,
1347
+ # `compute.googleapis.com/Disk`.
1346
1348
  # @!attribute [rw] resource_data
1347
1349
  # @return [::Google::Protobuf::Struct]
1348
- # Optional. A representation of the GCP resource. Should match the GCP
1349
- # resource JSON format.
1350
+ # Optional. A representation of the Google Cloud resource. Should match the
1351
+ # Google Cloud resource JSON format.
1350
1352
  # @!attribute [rw] iam_policy_data
1351
1353
  # @return [::Google::Iam::V1::Policy]
1352
1354
  # Optional. A representation of the IAM policy.
@@ -1356,8 +1358,8 @@ module Google
1356
1358
  end
1357
1359
  end
1358
1360
 
1359
- # Response message for simulating a SecurityHealthAnalyticsCustomModule against
1360
- # a given resource.
1361
+ # Response message for simulating a `SecurityHealthAnalyticsCustomModule`
1362
+ # against a given resource.
1361
1363
  # @!attribute [rw] result
1362
1364
  # @return [::Google::Cloud::SecurityCenter::V1::SimulateSecurityHealthAnalyticsCustomModuleResponse::SimulatedResult]
1363
1365
  # Result for test case in the corresponding request.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-security_center-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.33.0
4
+ version: 0.34.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-10-25 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.20.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.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -303,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
303
303
  - !ruby/object:Gem::Version
304
304
  version: '0'
305
305
  requirements: []
306
- rubygems_version: 3.4.19
306
+ rubygems_version: 3.5.3
307
307
  signing_key:
308
308
  specification_version: 4
309
309
  summary: Security Command Center API provides access to temporal views of assets and