google-cloud-certificate_manager-v1 0.6.0 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb +43 -9
- data/lib/google/cloud/certificate_manager/v1/certificate_manager/operations.rb +38 -7
- data/lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb +537 -7
- data/lib/google/cloud/certificate_manager/v1/certificate_manager/rest/operations.rb +108 -8
- data/lib/google/cloud/certificate_manager/v1/certificate_manager/rest/service_stub.rb +14 -2
- data/lib/google/cloud/certificate_manager/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +7 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3e65b53a11e46bac9809f924d8c01b013b77fcf32c152968e205412606195195
|
4
|
+
data.tar.gz: 814cbe19ff12ec3412d6ff01a4f5d2596a2ff8770f7526cf04c801ce38c3cec9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 36b0edb8dfd91099f8676becfa54ab30af3e65cd957b34119aac4578582bd0af4f7217538eb4cd56f4d57ecc610389dbef23deb5a6346b52cfa253dab920266c
|
7
|
+
data.tar.gz: 4280c0c0005aaeaf940ee2180f5287b4a80535401ca7b2d4f937fd509b3b170de7114bbdaa851d3eba66aca37cfe505f4db90169d40ed0f6fca78b3b6081e2b9
|
data/AUTHENTICATION.md
CHANGED
@@ -1,149 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
7
|
-
credentials will be discovered automatically. When running on other
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
9
|
-
path to the
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
11
|
-
for the account (or the JSON itself) in
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
14
|
-
during development.
|
3
|
+
The recommended way to authenticate to the google-cloud-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
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
26
14
|
|
27
|
-
|
28
|
-
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
29
17
|
|
30
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-cloud-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
|
-
|
51
|
-
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
54
26
|
|
55
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
63
|
-
containers where writing files is difficult or not encouraged.
|
29
|
+
The google-cloud-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
|
-
|
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
|
-
|
70
|
-
|
71
|
-
|
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
|
-
|
74
|
-
require "google/cloud/certificate_manager/v1"
|
75
|
-
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
77
43
|
|
78
|
-
client
|
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
|
-
|
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
|
-
|
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/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
91
61
|
end
|
92
62
|
```
|
93
63
|
|
94
|
-
|
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/
|
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
|
-
###
|
76
|
+
### Environment Variables
|
107
77
|
|
108
|
-
|
109
|
-
|
110
|
-
|
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
|
-
|
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
|
-
|
115
|
-
|
116
|
-
|
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
|
-
|
119
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
120
97
|
|
121
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/certificate_manager/v1"
|
122
100
|
|
123
|
-
|
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
|
-
|
128
|
-
|
129
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new
|
104
|
+
```
|
130
105
|
|
131
|
-
|
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
|
-
|
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
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
139
113
|
|
140
|
-
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
142
115
|
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
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
|
-
|
149
|
-
|
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
|
273
|
-
|
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,20 +296,25 @@ module Google
|
|
283
296
|
config.credentials = credentials
|
284
297
|
config.quota_project = @quota_project_id
|
285
298
|
config.endpoint = @config.endpoint
|
299
|
+
config.universe_domain = @config.universe_domain
|
286
300
|
end
|
287
301
|
|
288
302
|
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
289
303
|
config.credentials = credentials
|
290
304
|
config.quota_project = @quota_project_id
|
291
305
|
config.endpoint = @config.endpoint
|
306
|
+
config.universe_domain = @config.universe_domain
|
292
307
|
end
|
293
308
|
|
294
309
|
@certificate_manager_stub = ::Gapic::ServiceStub.new(
|
295
310
|
::Google::Cloud::CertificateManager::V1::CertificateManager::Stub,
|
296
|
-
credentials:
|
297
|
-
endpoint:
|
311
|
+
credentials: credentials,
|
312
|
+
endpoint: @config.endpoint,
|
313
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
314
|
+
universe_domain: @config.universe_domain,
|
298
315
|
channel_args: @config.channel_args,
|
299
|
-
interceptors: @config.interceptors
|
316
|
+
interceptors: @config.interceptors,
|
317
|
+
channel_pool_config: @config.channel_pool
|
300
318
|
)
|
301
319
|
end
|
302
320
|
|
@@ -2647,9 +2665,9 @@ module Google
|
|
2647
2665
|
# end
|
2648
2666
|
#
|
2649
2667
|
# @!attribute [rw] endpoint
|
2650
|
-
#
|
2651
|
-
#
|
2652
|
-
# @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]
|
2653
2671
|
# @!attribute [rw] credentials
|
2654
2672
|
# Credentials to send with calls. You may provide any of the following types:
|
2655
2673
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -2695,13 +2713,20 @@ module Google
|
|
2695
2713
|
# @!attribute [rw] quota_project
|
2696
2714
|
# A separate project against which to charge quota.
|
2697
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]
|
2698
2721
|
#
|
2699
2722
|
class Configuration
|
2700
2723
|
extend ::Gapic::Config
|
2701
2724
|
|
2725
|
+
# @private
|
2726
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
2702
2727
|
DEFAULT_ENDPOINT = "certificatemanager.googleapis.com"
|
2703
2728
|
|
2704
|
-
config_attr :endpoint,
|
2729
|
+
config_attr :endpoint, nil, ::String, nil
|
2705
2730
|
config_attr :credentials, nil do |value|
|
2706
2731
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
2707
2732
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -2716,6 +2741,7 @@ module Google
|
|
2716
2741
|
config_attr :metadata, nil, ::Hash, nil
|
2717
2742
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
2718
2743
|
config_attr :quota_project, nil, ::String, nil
|
2744
|
+
config_attr :universe_domain, nil, ::String, nil
|
2719
2745
|
|
2720
2746
|
# @private
|
2721
2747
|
def initialize parent_config = nil
|
@@ -2736,6 +2762,14 @@ module Google
|
|
2736
2762
|
end
|
2737
2763
|
end
|
2738
2764
|
|
2765
|
+
##
|
2766
|
+
# Configuration for the channel pool
|
2767
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
2768
|
+
#
|
2769
|
+
def channel_pool
|
2770
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
2771
|
+
end
|
2772
|
+
|
2739
2773
|
##
|
2740
2774
|
# Configuration RPC class for the CertificateManager API.
|
2741
2775
|
#
|
@@ -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,10 +102,13 @@ module Google
|
|
90
102
|
|
91
103
|
@operations_stub = ::Gapic::ServiceStub.new(
|
92
104
|
::Google::Longrunning::Operations::Stub,
|
93
|
-
credentials:
|
94
|
-
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
|
-
interceptors: @config.interceptors
|
110
|
+
interceptors: @config.interceptors,
|
111
|
+
channel_pool_config: @config.channel_pool
|
97
112
|
)
|
98
113
|
|
99
114
|
# Used by an LRO wrapper for some methods of this service
|
@@ -612,9 +627,9 @@ module Google
|
|
612
627
|
# end
|
613
628
|
#
|
614
629
|
# @!attribute [rw] endpoint
|
615
|
-
#
|
616
|
-
#
|
617
|
-
# @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]
|
618
633
|
# @!attribute [rw] credentials
|
619
634
|
# Credentials to send with calls. You may provide any of the following types:
|
620
635
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -660,13 +675,20 @@ module Google
|
|
660
675
|
# @!attribute [rw] quota_project
|
661
676
|
# A separate project against which to charge quota.
|
662
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]
|
663
683
|
#
|
664
684
|
class Configuration
|
665
685
|
extend ::Gapic::Config
|
666
686
|
|
687
|
+
# @private
|
688
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
667
689
|
DEFAULT_ENDPOINT = "certificatemanager.googleapis.com"
|
668
690
|
|
669
|
-
config_attr :endpoint,
|
691
|
+
config_attr :endpoint, nil, ::String, nil
|
670
692
|
config_attr :credentials, nil do |value|
|
671
693
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
672
694
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -681,6 +703,7 @@ module Google
|
|
681
703
|
config_attr :metadata, nil, ::Hash, nil
|
682
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
683
705
|
config_attr :quota_project, nil, ::String, nil
|
706
|
+
config_attr :universe_domain, nil, ::String, nil
|
684
707
|
|
685
708
|
# @private
|
686
709
|
def initialize parent_config = nil
|
@@ -701,6 +724,14 @@ module Google
|
|
701
724
|
end
|
702
725
|
end
|
703
726
|
|
727
|
+
##
|
728
|
+
# Configuration for the channel pool
|
729
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
730
|
+
#
|
731
|
+
def channel_pool
|
732
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
733
|
+
end
|
734
|
+
|
704
735
|
##
|
705
736
|
# Configuration RPC class for the Operations API.
|
706
737
|
#
|