google-cloud-certificate_manager-v1 0.7.0 → 0.8.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 564e745aac6fad9d0064900b26293c7d8aa8787fc2c67ba97a15d2ec9783c51a
4
- data.tar.gz: 6f8be05ef208345b6d5dbf03f60b568b9f95314278d34efc44126ead0a4054f6
3
+ metadata.gz: d91aa91252e6f8bca28cf806fffcf242cbac6eeee0b95fb81c1254e15ee815f2
4
+ data.tar.gz: 44ed29e7f2a93ee3725a6cb9e6639bc60fb1faa1b4f5e79a734eaf62e01ec1ea
5
5
  SHA512:
6
- metadata.gz: c1c98d0a2681b980930b6ee0d5abe5cf76d31fab5f80f94a120bc49b847ff40af85deb7f7801c55059a3aea5a64838eec42b64bf58cb9a83e71bfd16978238fe
7
- data.tar.gz: db36c0563c41fb147e024f8af5972230723ad16b9ebd795c28c170549a9a3e60bc45cdf1b5fdf32b83ab1d67c4f67f39db775a3b1d4fbb17ca5ce9ffcd36e59d
6
+ metadata.gz: 25f5c18d8246f8ee1a9d4c60e100db4980618b26421c5c82319424b425ad6deb44dce69bad76a6a639e6059c313ca42d0d283bcfce43c477c4801b5c3768929b
7
+ data.tar.gz: de8465f252fbb5ddaf05bbccfa481bb3310d9c47ccbaf334730c9e06f0270e3daf38cce3c687afba42cb6e808d1c3f615fc4a680e67f03924ea7b08e74401caa
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-certificate_manager-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-certificate_manager-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 GOOGLE_CLOUD_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/certificate_manager/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::CertificateManager::V1::CertificateManager::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-certificate_manager-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-certificate_manager-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-certificate_manager-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::CertificateManager::V1::CertificateManager::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `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)
72
41
 
73
- ```ruby
74
- require "google/cloud/certificate_manager/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new
79
- ```
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).
80
49
 
81
- ### 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.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/certificate_manager/v1"
88
58
 
89
59
  client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/certificate_manager/v1"
98
68
 
99
69
  ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- 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.
111
82
 
112
- 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).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 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-certificate_manager-v1
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *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
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/certificate_manager/v1"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-certificate_manager-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *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.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- 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.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- 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).
@@ -56,6 +56,9 @@ module Google
56
56
  # Provides methods to manage Cloud Certificate Manager entities.
57
57
  #
58
58
  class Client
59
+ # @private
60
+ DEFAULT_ENDPOINT_TEMPLATE = "certificatemanager.$UNIVERSE_DOMAIN$"
61
+
59
62
  include Paths
60
63
 
61
64
  # @private
@@ -236,6 +239,15 @@ module Google
236
239
  @config
237
240
  end
238
241
 
242
+ ##
243
+ # The effective universe domain
244
+ #
245
+ # @return [String]
246
+ #
247
+ def universe_domain
248
+ @certificate_manager_stub.universe_domain
249
+ end
250
+
239
251
  ##
240
252
  # Create a new CertificateManager client object.
241
253
  #
@@ -269,8 +281,9 @@ module Google
269
281
  credentials = @config.credentials
270
282
  # Use self-signed JWT if the endpoint is unchanged from default,
271
283
  # but only if the default endpoint does not have a region prefix.
272
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
273
- !@config.endpoint.split(".").first.include?("-")
284
+ enable_self_signed_jwt = @config.endpoint.nil? ||
285
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
286
+ !@config.endpoint.split(".").first.include?("-"))
274
287
  credentials ||= Credentials.default scope: @config.scope,
275
288
  enable_self_signed_jwt: enable_self_signed_jwt
276
289
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -283,22 +296,26 @@ module Google
283
296
  config.credentials = credentials
284
297
  config.quota_project = @quota_project_id
285
298
  config.endpoint = @config.endpoint
286
- end
287
-
288
- @location_client = Google::Cloud::Location::Locations::Client.new do |config|
289
- config.credentials = credentials
290
- config.quota_project = @quota_project_id
291
- config.endpoint = @config.endpoint
299
+ config.universe_domain = @config.universe_domain
292
300
  end
293
301
 
294
302
  @certificate_manager_stub = ::Gapic::ServiceStub.new(
295
303
  ::Google::Cloud::CertificateManager::V1::CertificateManager::Stub,
296
- credentials: credentials,
297
- endpoint: @config.endpoint,
304
+ credentials: credentials,
305
+ endpoint: @config.endpoint,
306
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
307
+ universe_domain: @config.universe_domain,
298
308
  channel_args: @config.channel_args,
299
309
  interceptors: @config.interceptors,
300
310
  channel_pool_config: @config.channel_pool
301
311
  )
312
+
313
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
314
+ config.credentials = credentials
315
+ config.quota_project = @quota_project_id
316
+ config.endpoint = @certificate_manager_stub.endpoint
317
+ config.universe_domain = @certificate_manager_stub.universe_domain
318
+ end
302
319
  end
303
320
 
304
321
  ##
@@ -2648,9 +2665,9 @@ module Google
2648
2665
  # end
2649
2666
  #
2650
2667
  # @!attribute [rw] endpoint
2651
- # The hostname or hostname:port of the service endpoint.
2652
- # Defaults to `"certificatemanager.googleapis.com"`.
2653
- # @return [::String]
2668
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2669
+ # nil, indicating to use the default endpoint in the current universe domain.
2670
+ # @return [::String,nil]
2654
2671
  # @!attribute [rw] credentials
2655
2672
  # Credentials to send with calls. You may provide any of the following types:
2656
2673
  # * (`String`) The path to a service account key file in JSON format
@@ -2696,13 +2713,20 @@ module Google
2696
2713
  # @!attribute [rw] quota_project
2697
2714
  # A separate project against which to charge quota.
2698
2715
  # @return [::String]
2716
+ # @!attribute [rw] universe_domain
2717
+ # The universe domain within which to make requests. This determines the
2718
+ # default endpoint URL. The default value of nil uses the environment
2719
+ # universe (usually the default "googleapis.com" universe).
2720
+ # @return [::String,nil]
2699
2721
  #
2700
2722
  class Configuration
2701
2723
  extend ::Gapic::Config
2702
2724
 
2725
+ # @private
2726
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2703
2727
  DEFAULT_ENDPOINT = "certificatemanager.googleapis.com"
2704
2728
 
2705
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2729
+ config_attr :endpoint, nil, ::String, nil
2706
2730
  config_attr :credentials, nil do |value|
2707
2731
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2708
2732
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2717,6 +2741,7 @@ module Google
2717
2741
  config_attr :metadata, nil, ::Hash, nil
2718
2742
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2719
2743
  config_attr :quota_project, nil, ::String, nil
2744
+ config_attr :universe_domain, nil, ::String, nil
2720
2745
 
2721
2746
  # @private
2722
2747
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module CertificateManager
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "certificatemanager.$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 `"certificatemanager.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 = "certificatemanager.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
@@ -58,6 +58,9 @@ module Google
58
58
  # Provides methods to manage Cloud Certificate Manager entities.
59
59
  #
60
60
  class Client
61
+ # @private
62
+ DEFAULT_ENDPOINT_TEMPLATE = "certificatemanager.$UNIVERSE_DOMAIN$"
63
+
61
64
  include Paths
62
65
 
63
66
  # @private
@@ -238,6 +241,15 @@ module Google
238
241
  @config
239
242
  end
240
243
 
244
+ ##
245
+ # The effective universe domain
246
+ #
247
+ # @return [String]
248
+ #
249
+ def universe_domain
250
+ @certificate_manager_stub.universe_domain
251
+ end
252
+
241
253
  ##
242
254
  # Create a new CertificateManager REST client object.
243
255
  #
@@ -265,8 +277,9 @@ module Google
265
277
  credentials = @config.credentials
266
278
  # Use self-signed JWT if the endpoint is unchanged from default,
267
279
  # but only if the default endpoint does not have a region prefix.
268
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
269
- !@config.endpoint.split(".").first.include?("-")
280
+ enable_self_signed_jwt = @config.endpoint.nil? ||
281
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
282
+ !@config.endpoint.split(".").first.include?("-"))
270
283
  credentials ||= Credentials.default scope: @config.scope,
271
284
  enable_self_signed_jwt: enable_self_signed_jwt
272
285
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -280,16 +293,23 @@ module Google
280
293
  config.credentials = credentials
281
294
  config.quota_project = @quota_project_id
282
295
  config.endpoint = @config.endpoint
296
+ config.universe_domain = @config.universe_domain
283
297
  end
284
298
 
299
+ @certificate_manager_stub = ::Google::Cloud::CertificateManager::V1::CertificateManager::Rest::ServiceStub.new(
300
+ endpoint: @config.endpoint,
301
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
302
+ universe_domain: @config.universe_domain,
303
+ credentials: credentials
304
+ )
305
+
285
306
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
286
307
  config.credentials = credentials
287
308
  config.quota_project = @quota_project_id
288
- config.endpoint = @config.endpoint
309
+ config.endpoint = @certificate_manager_stub.endpoint
310
+ config.universe_domain = @certificate_manager_stub.universe_domain
289
311
  config.bindings_override = @config.bindings_override
290
312
  end
291
-
292
- @certificate_manager_stub = ::Google::Cloud::CertificateManager::V1::CertificateManager::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
293
313
  end
294
314
 
295
315
  ##
@@ -2466,9 +2486,9 @@ module Google
2466
2486
  # end
2467
2487
  #
2468
2488
  # @!attribute [rw] endpoint
2469
- # The hostname or hostname:port of the service endpoint.
2470
- # Defaults to `"certificatemanager.googleapis.com"`.
2471
- # @return [::String]
2489
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2490
+ # nil, indicating to use the default endpoint in the current universe domain.
2491
+ # @return [::String,nil]
2472
2492
  # @!attribute [rw] credentials
2473
2493
  # Credentials to send with calls. You may provide any of the following types:
2474
2494
  # * (`String`) The path to a service account key file in JSON format
@@ -2505,13 +2525,20 @@ module Google
2505
2525
  # @!attribute [rw] quota_project
2506
2526
  # A separate project against which to charge quota.
2507
2527
  # @return [::String]
2528
+ # @!attribute [rw] universe_domain
2529
+ # The universe domain within which to make requests. This determines the
2530
+ # default endpoint URL. The default value of nil uses the environment
2531
+ # universe (usually the default "googleapis.com" universe).
2532
+ # @return [::String,nil]
2508
2533
  #
2509
2534
  class Configuration
2510
2535
  extend ::Gapic::Config
2511
2536
 
2537
+ # @private
2538
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2512
2539
  DEFAULT_ENDPOINT = "certificatemanager.googleapis.com"
2513
2540
 
2514
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2541
+ config_attr :endpoint, nil, ::String, nil
2515
2542
  config_attr :credentials, nil do |value|
2516
2543
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2517
2544
  allowed.any? { |klass| klass === value }
@@ -2523,6 +2550,7 @@ module Google
2523
2550
  config_attr :metadata, nil, ::Hash, nil
2524
2551
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2525
2552
  config_attr :quota_project, nil, ::String, nil
2553
+ config_attr :universe_domain, nil, ::String, nil
2526
2554
 
2527
2555
  # @private
2528
2556
  # Overrides for http bindings for the RPCs of this service
@@ -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 = "certificatemanager.$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 `"certificatemanager.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 = "certificatemanager.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,37 @@ 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
+
55
+ ##
56
+ # The effective endpoint
57
+ #
58
+ # @return [String]
59
+ #
60
+ def endpoint
61
+ @client_stub.endpoint
62
+ end
63
+
43
64
  ##
44
65
  # Baseline implementation for the list_certificates REST call
45
66
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module CertificateManager
23
23
  module V1
24
- VERSION = "0.7.0"
24
+ VERSION = "0.8.1"
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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-certificate_manager-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.0
4
+ version: 0.8.1
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-09-12 00:00:00.000000000 Z
11
+ date: 2024-01-12 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
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.4'
53
+ version: '0.7'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -240,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
240
240
  - !ruby/object:Gem::Version
241
241
  version: '0'
242
242
  requirements: []
243
- rubygems_version: 3.4.19
243
+ rubygems_version: 3.5.3
244
244
  signing_key:
245
245
  specification_version: 4
246
246
  summary: API Client library for the Certificate Manager V1 API