google-cloud-asset-v1 0.28.1 → 0.29.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/asset/v1/asset_service/client.rb +32 -8
  4. data/lib/google/cloud/asset/v1/asset_service/operations.rb +28 -6
  5. data/lib/google/cloud/asset/v1/asset_service/rest/client.rb +34 -7
  6. data/lib/google/cloud/asset/v1/asset_service/rest/operations.rb +33 -8
  7. data/lib/google/cloud/asset/v1/asset_service/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/asset/v1/version.rb +1 -1
  9. data/proto_docs/google/api/client.rb +1 -0
  10. data/proto_docs/google/cloud/asset/v1/assets.rb +7 -0
  11. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c67b73d598930bfc47dd2e882d34d13cec911b3ea0ce52056759e85ef3a44208
4
- data.tar.gz: fab0851234a71440509abaf9d2aa972adc1f8cc44c9224a57e93a27d185aeff6
3
+ metadata.gz: 463db4503e7e2b31ffcd0fe5e78c4d4e81f8518320e94c7be8cc634e97220319
4
+ data.tar.gz: 3ed4f4d5714cf470e7e345ed19f6a47208fbdb8bc178dc469dbb44a4ce9db366
5
5
  SHA512:
6
- metadata.gz: 1aa714630a9020b57a30a5d2079ec5eb6cf75a7620d6dcc6e2219f677d0e724c027ce4bdca0ecd529ca621e75d4b80a1d49ef967fd5a4584d9b6cbeab30afdb0
7
- data.tar.gz: d94d925daefa019d4e2a64f1f59f73c106662c258f6b0c0b03d585ac5e4dbb6380141602898cbdad407cf446e5b573ca24d3c5b19121aecb0e73a8310005354e
6
+ metadata.gz: a1eba4d4f2e0572a55c41b70174987407de2e02e09d544460b0812b28688b83a90487509e100145403a8e6613e3a80cd84731986bf80067804dad49f14926718
7
+ data.tar.gz: 250bf54f136348a2e12cff19d1ad4c7ae30a97ccfd621607943bed22e869f973bdcff68dbd310d74908f66d0f21282c7cfcabbe0127021abe8ea7ab9a498e3f7
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-asset-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-asset-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 ASSET_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/asset/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::Asset::V1::AssetService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-asset-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-asset-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-asset-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Asset::V1::AssetService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `ASSET_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `ASSET_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/asset/v1"
77
-
78
- ENV["ASSET_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Asset::V1::AssetService::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/asset/v1"
90
58
 
91
59
  client = ::Google::Cloud::Asset::V1::AssetService::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/asset/v1"
100
68
 
101
69
  ::Google::Cloud::Asset::V1::AssetService::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::Asset::V1::AssetService::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-asset-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/asset/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-asset-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::Asset::V1::AssetService::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).
data/lib/google/cloud/asset/v1/asset_service/client.rb CHANGED
@@ -30,6 +30,9 @@ module Google
30
30
  # Asset service definition.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudasset.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -182,6 +185,15 @@ module Google
182
185
  @config
183
186
  end
184
187
 
188
+ ##
189
+ # The effective universe domain
190
+ #
191
+ # @return [String]
192
+ #
193
+ def universe_domain
194
+ @asset_service_stub.universe_domain
195
+ end
196
+
185
197
  ##
186
198
  # Create a new AssetService client object.
187
199
  #
@@ -215,8 +227,9 @@ module Google
215
227
  credentials = @config.credentials
216
228
  # Use self-signed JWT if the endpoint is unchanged from default,
217
229
  # but only if the default endpoint does not have a region prefix.
218
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
219
- !@config.endpoint.split(".").first.include?("-")
230
+ enable_self_signed_jwt = @config.endpoint.nil? ||
231
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
232
+ !@config.endpoint.split(".").first.include?("-"))
220
233
  credentials ||= Credentials.default scope: @config.scope,
221
234
  enable_self_signed_jwt: enable_self_signed_jwt
222
235
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -229,12 +242,15 @@ module Google
229
242
  config.credentials = credentials
230
243
  config.quota_project = @quota_project_id
231
244
  config.endpoint = @config.endpoint
245
+ config.universe_domain = @config.universe_domain
232
246
  end
233
247
 
234
248
  @asset_service_stub = ::Gapic::ServiceStub.new(
235
249
  ::Google::Cloud::Asset::V1::AssetService::Stub,
236
- credentials: credentials,
237
- endpoint: @config.endpoint,
250
+ credentials: credentials,
251
+ endpoint: @config.endpoint,
252
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
253
+ universe_domain: @config.universe_domain,
238
254
  channel_args: @config.channel_args,
239
255
  interceptors: @config.interceptors,
240
256
  channel_pool_config: @config.channel_pool
@@ -3068,9 +3084,9 @@ module Google
3068
3084
  # end
3069
3085
  #
3070
3086
  # @!attribute [rw] endpoint
3071
- # The hostname or hostname:port of the service endpoint.
3072
- # Defaults to `"cloudasset.googleapis.com"`.
3073
- # @return [::String]
3087
+ # A custom service endpoint, as a hostname or hostname:port. The default is
3088
+ # nil, indicating to use the default endpoint in the current universe domain.
3089
+ # @return [::String,nil]
3074
3090
  # @!attribute [rw] credentials
3075
3091
  # Credentials to send with calls. You may provide any of the following types:
3076
3092
  # * (`String`) The path to a service account key file in JSON format
@@ -3116,13 +3132,20 @@ module Google
3116
3132
  # @!attribute [rw] quota_project
3117
3133
  # A separate project against which to charge quota.
3118
3134
  # @return [::String]
3135
+ # @!attribute [rw] universe_domain
3136
+ # The universe domain within which to make requests. This determines the
3137
+ # default endpoint URL. The default value of nil uses the environment
3138
+ # universe (usually the default "googleapis.com" universe).
3139
+ # @return [::String,nil]
3119
3140
  #
3120
3141
  class Configuration
3121
3142
  extend ::Gapic::Config
3122
3143
 
3144
+ # @private
3145
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3123
3146
  DEFAULT_ENDPOINT = "cloudasset.googleapis.com"
3124
3147
 
3125
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3148
+ config_attr :endpoint, nil, ::String, nil
3126
3149
  config_attr :credentials, nil do |value|
3127
3150
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3128
3151
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -3137,6 +3160,7 @@ module Google
3137
3160
  config_attr :metadata, nil, ::Hash, nil
3138
3161
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3139
3162
  config_attr :quota_project, nil, ::String, nil
3163
+ config_attr :universe_domain, nil, ::String, nil
3140
3164
 
3141
3165
  # @private
3142
3166
  def initialize parent_config = nil
data/lib/google/cloud/asset/v1/asset_service/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module AssetService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudasset.$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 `"cloudasset.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 = "cloudasset.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
data/lib/google/cloud/asset/v1/asset_service/rest/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # Asset service definition.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "cloudasset.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -184,6 +187,15 @@ module Google
184
187
  @config
185
188
  end
186
189
 
190
+ ##
191
+ # The effective universe domain
192
+ #
193
+ # @return [String]
194
+ #
195
+ def universe_domain
196
+ @asset_service_stub.universe_domain
197
+ end
198
+
187
199
  ##
188
200
  # Create a new AssetService REST client object.
189
201
  #
@@ -211,8 +223,9 @@ module Google
211
223
  credentials = @config.credentials
212
224
  # Use self-signed JWT if the endpoint is unchanged from default,
213
225
  # but only if the default endpoint does not have a region prefix.
214
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
215
- !@config.endpoint.split(".").first.include?("-")
226
+ enable_self_signed_jwt = @config.endpoint.nil? ||
227
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
228
+ !@config.endpoint.split(".").first.include?("-"))
216
229
  credentials ||= Credentials.default scope: @config.scope,
217
230
  enable_self_signed_jwt: enable_self_signed_jwt
218
231
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -226,9 +239,15 @@ module Google
226
239
  config.credentials = credentials
227
240
  config.quota_project = @quota_project_id
228
241
  config.endpoint = @config.endpoint
242
+ config.universe_domain = @config.universe_domain
229
243
  end
230
244
 
231
- @asset_service_stub = ::Google::Cloud::Asset::V1::AssetService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
245
+ @asset_service_stub = ::Google::Cloud::Asset::V1::AssetService::Rest::ServiceStub.new(
246
+ endpoint: @config.endpoint,
247
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
248
+ universe_domain: @config.universe_domain,
249
+ credentials: credentials
250
+ )
232
251
  end
233
252
 
234
253
  ##
@@ -2897,9 +2916,9 @@ module Google
2897
2916
  # end
2898
2917
  #
2899
2918
  # @!attribute [rw] endpoint
2900
- # The hostname or hostname:port of the service endpoint.
2901
- # Defaults to `"cloudasset.googleapis.com"`.
2902
- # @return [::String]
2919
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2920
+ # nil, indicating to use the default endpoint in the current universe domain.
2921
+ # @return [::String,nil]
2903
2922
  # @!attribute [rw] credentials
2904
2923
  # Credentials to send with calls. You may provide any of the following types:
2905
2924
  # * (`String`) The path to a service account key file in JSON format
@@ -2936,13 +2955,20 @@ module Google
2936
2955
  # @!attribute [rw] quota_project
2937
2956
  # A separate project against which to charge quota.
2938
2957
  # @return [::String]
2958
+ # @!attribute [rw] universe_domain
2959
+ # The universe domain within which to make requests. This determines the
2960
+ # default endpoint URL. The default value of nil uses the environment
2961
+ # universe (usually the default "googleapis.com" universe).
2962
+ # @return [::String,nil]
2939
2963
  #
2940
2964
  class Configuration
2941
2965
  extend ::Gapic::Config
2942
2966
 
2967
+ # @private
2968
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2943
2969
  DEFAULT_ENDPOINT = "cloudasset.googleapis.com"
2944
2970
 
2945
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2971
+ config_attr :endpoint, nil, ::String, nil
2946
2972
  config_attr :credentials, nil do |value|
2947
2973
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2948
2974
  allowed.any? { |klass| klass === value }
@@ -2954,6 +2980,7 @@ module Google
2954
2980
  config_attr :metadata, nil, ::Hash, nil
2955
2981
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2956
2982
  config_attr :quota_project, nil, ::String, nil
2983
+ config_attr :universe_domain, nil, ::String, nil
2957
2984
 
2958
2985
  # @private
2959
2986
  def initialize parent_config = nil
data/lib/google/cloud/asset/v1/asset_service/rest/operations.rb CHANGED
@@ -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 = "cloudasset.$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 `"cloudasset.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 = "cloudasset.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
  ##
data/lib/google/cloud/asset/v1/asset_service/rest/service_stub.rb CHANGED
@@ -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 export_assets REST call
45
57
  #
data/lib/google/cloud/asset/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Asset
23
23
  module V1
24
- VERSION = "0.28.1"
24
+ VERSION = "0.29.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -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
data/proto_docs/google/cloud/asset/v1/assets.rb CHANGED
@@ -141,6 +141,7 @@ module Google
141
141
  # topic](https://cloud.google.com/compute/docs/instances/os-inventory-management)
142
142
  # for more information.
143
143
  # @!attribute [rw] related_assets
144
+ # @deprecated This field is deprecated and may be removed in the next major version update.
144
145
  # @return [::Google::Cloud::Asset::V1::RelatedAssets]
145
146
  # DEPRECATED. This field only presents for the purpose of
146
147
  # backward-compatibility. The server will never generate responses with this
@@ -220,6 +221,7 @@ module Google
220
221
  # backward-compatibility. The server will never populate this message in
221
222
  # responses.
222
223
  # The detailed related assets with the `relationship_type`.
224
+ # @deprecated This message is deprecated and may be removed in the next major version update.
223
225
  # @!attribute [rw] relationship_attributes
224
226
  # @return [::Google::Cloud::Asset::V1::RelationshipAttributes]
225
227
  # The detailed relationship attributes.
@@ -236,6 +238,7 @@ module Google
236
238
  # responses.
237
239
  # The relationship attributes which include `type`, `source_resource_type`,
238
240
  # `target_resource_type` and `action`.
241
+ # @deprecated This message is deprecated and may be removed in the next major version update.
239
242
  # @!attribute [rw] type
240
243
  # @return [::String]
241
244
  # The unique identifier of the relationship type. Example:
@@ -446,6 +449,7 @@ module Google
446
449
  # * Use a field query. Example: `networkTags:internal`
447
450
  # * Use a free text query. Example: `internal`
448
451
  # @!attribute [rw] kms_key
452
+ # @deprecated This field is deprecated and may be removed in the next major version update.
449
453
  # @return [::String]
450
454
  # The Cloud KMS
451
455
  # [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys)
@@ -583,6 +587,7 @@ module Google
583
587
  # See [supported relationship
584
588
  # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#supported_relationship_types).
585
589
  # @!attribute [rw] tag_keys
590
+ # @deprecated This field is deprecated and may be removed in the next major version update.
586
591
  # @return [::Array<::String>]
587
592
  # This field is only present for the purpose of backward compatibility.
588
593
  # Use the `tags` field instead.
@@ -598,6 +603,7 @@ module Google
598
603
  # * Use a free text query. Example:
599
604
  # - `env`
600
605
  # @!attribute [rw] tag_values
606
+ # @deprecated This field is deprecated and may be removed in the next major version update.
601
607
  # @return [::Array<::String>]
602
608
  # This field is only present for the purpose of backward compatibility.
603
609
  # Use the `tags` field instead.
@@ -615,6 +621,7 @@ module Google
615
621
  # * Use a free text query. Example:
616
622
  # - `prod`
617
623
  # @!attribute [rw] tag_value_ids
624
+ # @deprecated This field is deprecated and may be removed in the next major version update.
618
625
  # @return [::Array<::String>]
619
626
  # This field is only present for the purpose of backward compatibility.
620
627
  # Use the `tags` field instead.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-asset-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.28.1
4
+ version: 0.29.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: 2024-01-09 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