google-iam-v2 0.4.0 → 0.5.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.
Files changed (10) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/lib/google/iam/v2/policies/client.rb +32 -8
  4. data/lib/google/iam/v2/policies/operations.rb +28 -6
  5. data/lib/google/iam/v2/policies/rest/client.rb +34 -7
  6. data/lib/google/iam/v2/policies/rest/operations.rb +33 -8
  7. data/lib/google/iam/v2/policies/rest/service_stub.rb +14 -2
  8. data/lib/google/iam/v2/version.rb +1 -1
  9. data/proto_docs/google/api/client.rb +14 -0
  10. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 32c3d0e641659cbd636508643d2c7b19b6b422df11d09f00dd61cb9ef3bdb13f
4
- data.tar.gz: 7496444b2d982da0041f314c2e714d36c971be3a0fac47bed4a29a144381a98e
3
+ metadata.gz: 4b929a9ca6ea4e5f10bcc3b1b3f013e119ece7be43e83913ac67ef3258b31ff8
4
+ data.tar.gz: 8a68fc658236e7c0af0cb39410e22bb894fd017fcc47c71dcd555a157079fbef
5
5
  SHA512:
6
- metadata.gz: 84e84231b7395ce1dba409e64608fa7ea4918252777393ef8f6766a26eca9c862c11173f376ad96be8d732b4d8b23a5ab8e7c6d2c56e0a931a68495e45bdb247
7
- data.tar.gz: 79d6a2e027adcb49476af214e2cb405dc209a76e2a57341b8ac7c0a6685644b3e8f49d572fe17901f98be9a512146a54a728c8ef3e07cce73589f09bc28f030f
6
+ metadata.gz: 5e8cf4d349e65bcc8507cdbb720837d596e586d6f62008edbae997ca8f4ccf88381e66423c532a6cf8687973a736878aa1000717401b513d38b3cc0321e7af92
7
+ data.tar.gz: 2bc68e1b941e5e641ca5f44cc4210724970a8ad9c97ee9c13916cd319ba3ecb241c36abc2d79eafd43cad9597a150179a197542378bae81242fdef1b0fcf62ea
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-iam-v2 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-iam-v2 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/iam/v2"
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::Iam::V2::Policies::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-iam-v2 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-iam-v2 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-iam-v2
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Iam::V2::Policies::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/iam/v2"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Iam::V2::Policies::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/iam/v2"
88
58
 
89
59
  client = ::Google::Iam::V2::Policies::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/iam/v2"
98
68
 
99
69
  ::Google::Iam::V2::Policies::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::Iam::V2::Policies::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-iam-v2
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/iam/v2"
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-iam-v2.
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::Iam::V2::Policies::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).
data/lib/google/iam/v2/policies/client.rb CHANGED
@@ -29,6 +29,9 @@ module Google
29
29
  # An interface for managing Identity and Access Management (IAM) policies.
30
30
  #
31
31
  class Client
32
+ # @private
33
+ DEFAULT_ENDPOINT_TEMPLATE = "iam.$UNIVERSE_DOMAIN$"
34
+
32
35
  # @private
33
36
  attr_reader :policies_stub
34
37
 
@@ -112,6 +115,15 @@ module Google
112
115
  @config
113
116
  end
114
117
 
118
+ ##
119
+ # The effective universe domain
120
+ #
121
+ # @return [String]
122
+ #
123
+ def universe_domain
124
+ @policies_stub.universe_domain
125
+ end
126
+
115
127
  ##
116
128
  # Create a new Policies client object.
117
129
  #
@@ -145,8 +157,9 @@ module Google
145
157
  credentials = @config.credentials
146
158
  # Use self-signed JWT if the endpoint is unchanged from default,
147
159
  # but only if the default endpoint does not have a region prefix.
148
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
149
- !@config.endpoint.split(".").first.include?("-")
160
+ enable_self_signed_jwt = @config.endpoint.nil? ||
161
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
162
+ !@config.endpoint.split(".").first.include?("-"))
150
163
  credentials ||= Credentials.default scope: @config.scope,
151
164
  enable_self_signed_jwt: enable_self_signed_jwt
152
165
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -159,12 +172,15 @@ module Google
159
172
  config.credentials = credentials
160
173
  config.quota_project = @quota_project_id
161
174
  config.endpoint = @config.endpoint
175
+ config.universe_domain = @config.universe_domain
162
176
  end
163
177
 
164
178
  @policies_stub = ::Gapic::ServiceStub.new(
165
179
  ::Google::Iam::V2::Policies::Stub,
166
- credentials: credentials,
167
- endpoint: @config.endpoint,
180
+ credentials: credentials,
181
+ endpoint: @config.endpoint,
182
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
183
+ universe_domain: @config.universe_domain,
168
184
  channel_args: @config.channel_args,
169
185
  interceptors: @config.interceptors,
170
186
  channel_pool_config: @config.channel_pool
@@ -741,9 +757,9 @@ module Google
741
757
  # end
742
758
  #
743
759
  # @!attribute [rw] endpoint
744
- # The hostname or hostname:port of the service endpoint.
745
- # Defaults to `"iam.googleapis.com"`.
746
- # @return [::String]
760
+ # A custom service endpoint, as a hostname or hostname:port. The default is
761
+ # nil, indicating to use the default endpoint in the current universe domain.
762
+ # @return [::String,nil]
747
763
  # @!attribute [rw] credentials
748
764
  # Credentials to send with calls. You may provide any of the following types:
749
765
  # * (`String`) The path to a service account key file in JSON format
@@ -789,13 +805,20 @@ module Google
789
805
  # @!attribute [rw] quota_project
790
806
  # A separate project against which to charge quota.
791
807
  # @return [::String]
808
+ # @!attribute [rw] universe_domain
809
+ # The universe domain within which to make requests. This determines the
810
+ # default endpoint URL. The default value of nil uses the environment
811
+ # universe (usually the default "googleapis.com" universe).
812
+ # @return [::String,nil]
792
813
  #
793
814
  class Configuration
794
815
  extend ::Gapic::Config
795
816
 
817
+ # @private
818
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
796
819
  DEFAULT_ENDPOINT = "iam.googleapis.com"
797
820
 
798
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
821
+ config_attr :endpoint, nil, ::String, nil
799
822
  config_attr :credentials, nil do |value|
800
823
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
801
824
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -810,6 +833,7 @@ module Google
810
833
  config_attr :metadata, nil, ::Hash, nil
811
834
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
812
835
  config_attr :quota_project, nil, ::String, nil
836
+ config_attr :universe_domain, nil, ::String, nil
813
837
 
814
838
  # @private
815
839
  def initialize parent_config = nil
data/lib/google/iam/v2/policies/operations.rb CHANGED
@@ -25,6 +25,9 @@ module Google
25
25
  module Policies
26
26
  # Service that implements Longrunning Operations API.
27
27
  class Operations
28
+ # @private
29
+ DEFAULT_ENDPOINT_TEMPLATE = "iam.$UNIVERSE_DOMAIN$"
30
+
28
31
  # @private
29
32
  attr_reader :operations_stub
30
33
 
@@ -59,6 +62,15 @@ module Google
59
62
  @config
60
63
  end
61
64
 
65
+ ##
66
+ # The effective universe domain
67
+ #
68
+ # @return [String]
69
+ #
70
+ def universe_domain
71
+ @operations_stub.universe_domain
72
+ end
73
+
62
74
  ##
63
75
  # Create a new Operations client object.
64
76
  #
@@ -89,8 +101,10 @@ module Google
89
101
 
90
102
  @operations_stub = ::Gapic::ServiceStub.new(
91
103
  ::Google::Longrunning::Operations::Stub,
92
- credentials: credentials,
93
- endpoint: @config.endpoint,
104
+ credentials: credentials,
105
+ endpoint: @config.endpoint,
106
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
107
+ universe_domain: @config.universe_domain,
94
108
  channel_args: @config.channel_args,
95
109
  interceptors: @config.interceptors,
96
110
  channel_pool_config: @config.channel_pool
@@ -612,9 +626,9 @@ module Google
612
626
  # end
613
627
  #
614
628
  # @!attribute [rw] endpoint
615
- # The hostname or hostname:port of the service endpoint.
616
- # Defaults to `"iam.googleapis.com"`.
617
- # @return [::String]
629
+ # A custom service endpoint, as a hostname or hostname:port. The default is
630
+ # nil, indicating to use the default endpoint in the current universe domain.
631
+ # @return [::String,nil]
618
632
  # @!attribute [rw] credentials
619
633
  # Credentials to send with calls. You may provide any of the following types:
620
634
  # * (`String`) The path to a service account key file in JSON format
@@ -660,13 +674,20 @@ module Google
660
674
  # @!attribute [rw] quota_project
661
675
  # A separate project against which to charge quota.
662
676
  # @return [::String]
677
+ # @!attribute [rw] universe_domain
678
+ # The universe domain within which to make requests. This determines the
679
+ # default endpoint URL. The default value of nil uses the environment
680
+ # universe (usually the default "googleapis.com" universe).
681
+ # @return [::String,nil]
663
682
  #
664
683
  class Configuration
665
684
  extend ::Gapic::Config
666
685
 
686
+ # @private
687
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
667
688
  DEFAULT_ENDPOINT = "iam.googleapis.com"
668
689
 
669
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
690
+ config_attr :endpoint, nil, ::String, nil
670
691
  config_attr :credentials, nil do |value|
671
692
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
672
693
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -681,6 +702,7 @@ module Google
681
702
  config_attr :metadata, nil, ::Hash, nil
682
703
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
683
704
  config_attr :quota_project, nil, ::String, nil
705
+ config_attr :universe_domain, nil, ::String, nil
684
706
 
685
707
  # @private
686
708
  def initialize parent_config = nil
data/lib/google/iam/v2/policies/rest/client.rb CHANGED
@@ -31,6 +31,9 @@ module Google
31
31
  # An interface for managing Identity and Access Management (IAM) policies.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "iam.$UNIVERSE_DOMAIN$"
36
+
34
37
  # @private
35
38
  attr_reader :policies_stub
36
39
 
@@ -114,6 +117,15 @@ module Google
114
117
  @config
115
118
  end
116
119
 
120
+ ##
121
+ # The effective universe domain
122
+ #
123
+ # @return [String]
124
+ #
125
+ def universe_domain
126
+ @policies_stub.universe_domain
127
+ end
128
+
117
129
  ##
118
130
  # Create a new Policies REST client object.
119
131
  #
@@ -141,8 +153,9 @@ module Google
141
153
  credentials = @config.credentials
142
154
  # Use self-signed JWT if the endpoint is unchanged from default,
143
155
  # but only if the default endpoint does not have a region prefix.
144
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
145
- !@config.endpoint.split(".").first.include?("-")
156
+ enable_self_signed_jwt = @config.endpoint.nil? ||
157
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
158
+ !@config.endpoint.split(".").first.include?("-"))
146
159
  credentials ||= Credentials.default scope: @config.scope,
147
160
  enable_self_signed_jwt: enable_self_signed_jwt
148
161
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -156,9 +169,15 @@ module Google
156
169
  config.credentials = credentials
157
170
  config.quota_project = @quota_project_id
158
171
  config.endpoint = @config.endpoint
172
+ config.universe_domain = @config.universe_domain
159
173
  end
160
174
 
161
- @policies_stub = ::Google::Iam::V2::Policies::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
175
+ @policies_stub = ::Google::Iam::V2::Policies::Rest::ServiceStub.new(
176
+ endpoint: @config.endpoint,
177
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
+ universe_domain: @config.universe_domain,
179
+ credentials: credentials
180
+ )
162
181
  end
163
182
 
164
183
  ##
@@ -696,9 +715,9 @@ module Google
696
715
  # end
697
716
  #
698
717
  # @!attribute [rw] endpoint
699
- # The hostname or hostname:port of the service endpoint.
700
- # Defaults to `"iam.googleapis.com"`.
701
- # @return [::String]
718
+ # A custom service endpoint, as a hostname or hostname:port. The default is
719
+ # nil, indicating to use the default endpoint in the current universe domain.
720
+ # @return [::String,nil]
702
721
  # @!attribute [rw] credentials
703
722
  # Credentials to send with calls. You may provide any of the following types:
704
723
  # * (`String`) The path to a service account key file in JSON format
@@ -735,13 +754,20 @@ module Google
735
754
  # @!attribute [rw] quota_project
736
755
  # A separate project against which to charge quota.
737
756
  # @return [::String]
757
+ # @!attribute [rw] universe_domain
758
+ # The universe domain within which to make requests. This determines the
759
+ # default endpoint URL. The default value of nil uses the environment
760
+ # universe (usually the default "googleapis.com" universe).
761
+ # @return [::String,nil]
738
762
  #
739
763
  class Configuration
740
764
  extend ::Gapic::Config
741
765
 
766
+ # @private
767
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
742
768
  DEFAULT_ENDPOINT = "iam.googleapis.com"
743
769
 
744
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
770
+ config_attr :endpoint, nil, ::String, nil
745
771
  config_attr :credentials, nil do |value|
746
772
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
747
773
  allowed.any? { |klass| klass === value }
@@ -753,6 +779,7 @@ module Google
753
779
  config_attr :metadata, nil, ::Hash, nil
754
780
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
755
781
  config_attr :quota_project, nil, ::String, nil
782
+ config_attr :universe_domain, nil, ::String, nil
756
783
 
757
784
  # @private
758
785
  def initialize parent_config = nil
data/lib/google/iam/v2/policies/rest/operations.rb CHANGED
@@ -25,6 +25,9 @@ module Google
25
25
  module Rest
26
26
  # Service that implements Longrunning Operations API.
27
27
  class Operations
28
+ # @private
29
+ DEFAULT_ENDPOINT_TEMPLATE = "iam.$UNIVERSE_DOMAIN$"
30
+
28
31
  # @private
29
32
  attr_reader :operations_stub
30
33
 
@@ -59,6 +62,15 @@ module Google
59
62
  @config
60
63
  end
61
64
 
65
+ ##
66
+ # The effective universe domain
67
+ #
68
+ # @return [String]
69
+ #
70
+ def universe_domain
71
+ @operations_stub.universe_domain
72
+ end
73
+
62
74
  ##
63
75
  # Create a new Operations client object.
64
76
  #
@@ -83,8 +95,10 @@ module Google
83
95
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
84
96
 
85
97
  @operations_stub = OperationsServiceStub.new(
86
- endpoint: @config.endpoint,
87
- credentials: credentials
98
+ endpoint: @config.endpoint,
99
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
100
+ universe_domain: @config.universe_domain,
101
+ credentials: credentials
88
102
  )
89
103
 
90
104
  # Used by an LRO wrapper for some methods of this service
@@ -477,9 +491,9 @@ module Google
477
491
  # end
478
492
  #
479
493
  # @!attribute [rw] endpoint
480
- # The hostname or hostname:port of the service endpoint.
481
- # Defaults to `"iam.googleapis.com"`.
482
- # @return [::String]
494
+ # A custom service endpoint, as a hostname or hostname:port. The default is
495
+ # nil, indicating to use the default endpoint in the current universe domain.
496
+ # @return [::String,nil]
483
497
  # @!attribute [rw] credentials
484
498
  # Credentials to send with calls. You may provide any of the following types:
485
499
  # * (`String`) The path to a service account key file in JSON format
@@ -516,13 +530,20 @@ module Google
516
530
  # @!attribute [rw] quota_project
517
531
  # A separate project against which to charge quota.
518
532
  # @return [::String]
533
+ # @!attribute [rw] universe_domain
534
+ # The universe domain within which to make requests. This determines the
535
+ # default endpoint URL. The default value of nil uses the environment
536
+ # universe (usually the default "googleapis.com" universe).
537
+ # @return [::String,nil]
519
538
  #
520
539
  class Configuration
521
540
  extend ::Gapic::Config
522
541
 
542
+ # @private
543
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
523
544
  DEFAULT_ENDPOINT = "iam.googleapis.com"
524
545
 
525
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
546
+ config_attr :endpoint, nil, ::String, nil
526
547
  config_attr :credentials, nil do |value|
527
548
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
528
549
  allowed.any? { |klass| klass === value }
@@ -534,6 +555,7 @@ module Google
534
555
  config_attr :metadata, nil, ::Hash, nil
535
556
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
536
557
  config_attr :quota_project, nil, ::String, nil
558
+ config_attr :universe_domain, nil, ::String, nil
537
559
 
538
560
  # @private
539
561
  def initialize parent_config = nil
@@ -616,12 +638,15 @@ module Google
616
638
  # Service stub contains baseline method implementations
617
639
  # including transcoding, making the REST call, and deserialing the response.
618
640
  class OperationsServiceStub
619
- def initialize endpoint:, credentials:
641
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
620
642
  # These require statements are intentionally placed here to initialize
621
643
  # the REST modules only when it's required.
622
644
  require "gapic/rest"
623
645
 
624
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
646
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
647
+ endpoint_template: endpoint_template,
648
+ universe_domain: universe_domain,
649
+ credentials: credentials
625
650
  end
626
651
 
627
652
  ##
data/lib/google/iam/v2/policies/rest/service_stub.rb CHANGED
@@ -29,16 +29,28 @@ module Google
29
29
  # including transcoding, making the REST call, and deserialing the response.
30
30
  #
31
31
  class ServiceStub
32
- def initialize endpoint:, credentials:
32
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
33
33
  # These require statements are intentionally placed here to initialize
34
34
  # the REST modules only when it's required.
35
35
  require "gapic/rest"
36
36
 
37
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
37
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
38
+ endpoint_template: endpoint_template,
39
+ universe_domain: universe_domain,
40
+ credentials: credentials,
38
41
  numeric_enums: true,
39
42
  raise_faraday_errors: false
40
43
  end
41
44
 
45
+ ##
46
+ # The effective universe domain
47
+ #
48
+ # @return [String]
49
+ #
50
+ def universe_domain
51
+ @client_stub.universe_domain
52
+ end
53
+
42
54
  ##
43
55
  # Baseline implementation for the list_policies REST call
44
56
  #
data/lib/google/iam/v2/version.rb CHANGED
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Iam
22
22
  module V2
23
- VERSION = "0.4.0"
23
+ VERSION = "0.5.0"
24
24
  end
25
25
  end
26
26
  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
@@ -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-iam-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.5.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-09-12 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
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
217
217
  - !ruby/object:Gem::Version
218
218
  version: '0'
219
219
  requirements: []
220
- rubygems_version: 3.4.19
220
+ rubygems_version: 3.5.3
221
221
  signing_key:
222
222
  specification_version: 4
223
223
  summary: Manages identity and access control for Google Cloud Platform resources,