google-cloud-iap-v1 0.10.1 → 0.11.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/iap/v1/identity_aware_proxy_admin_service/client.rb +31 -8
  4. data/lib/google/cloud/iap/v1/identity_aware_proxy_admin_service/rest/client.rb +33 -7
  5. data/lib/google/cloud/iap/v1/identity_aware_proxy_admin_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/iap/v1/identity_aware_proxy_o_auth_service/client.rb +31 -8
  7. data/lib/google/cloud/iap/v1/identity_aware_proxy_o_auth_service/rest/client.rb +33 -7
  8. data/lib/google/cloud/iap/v1/identity_aware_proxy_o_auth_service/rest/service_stub.rb +14 -2
  9. data/lib/google/cloud/iap/v1/version.rb +1 -1
  10. data/proto_docs/google/api/client.rb +14 -0
  11. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 66d33dca234d5c6d6bfbba283bc3f8be830a172bb8991f20afa6fa98042300c5
4
- data.tar.gz: 909e45c5075068ebe01ed9e935917b6dac956cf81df16af89feafef5b7fa5b02
3
+ metadata.gz: e299fb75c46a92a71962fca9bfacfc35ada7a126fc85f21389387c921608acd8
4
+ data.tar.gz: cf6cc842d6ef423a300c518b9015ab07079f5448f387c30689efaedc2c92b806
5
5
  SHA512:
6
- metadata.gz: 3367afa6581b6b0d1887f8bd80f584a92bce03aa2e60ec04a99eda2674810b6217d7f1b8de480b87b539211173428fcbf60b1245f2074f1ea3873a5fbc243c45
7
- data.tar.gz: 52866353c2f2426ad806f0ff879b1c4ba2d71195a8cb4af84ebef630c62cedfc30b9c3ad16c56d8d6e26947ee1fdf79c970fb9a40b63e70256a3412bf59f36a0
6
+ metadata.gz: 0a177aa561c6eb2aa3a9f33d221d32d56295236f436c91aeb71cd9757bbeefc78c48c4fe0a36c68b62b50a6dcad2f6fa5d8a8848895662f52dce85115fc7e777
7
+ data.tar.gz: bd865477404dd8b315ea02a300a8f3a0feed460401425bf8a3929ffab331e5eef60b95b9c97fc5ae521697a05970f9d113d61c23f8ff82193ee9ec7b73dc4584
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-iap-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-iap-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 IAP_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/iap/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::Iap::V1::IdentityAwareProxyAdminService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-iap-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-iap-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-iap-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `IAP_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `IAP_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/iap/v1"
77
-
78
- ENV["IAP_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::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/iap/v1"
90
58
 
91
59
  client = ::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::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/iap/v1"
100
68
 
101
69
  ::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::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::Iap::V1::IdentityAwareProxyAdminService::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-iap-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/iap/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-iap-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::Iap::V1::IdentityAwareProxyAdminService::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/iap/v1/identity_aware_proxy_admin_service/client.rb CHANGED
@@ -30,6 +30,9 @@ module Google
30
30
  # APIs for Identity-Aware Proxy Admin configurations.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "iap.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -92,6 +95,15 @@ module Google
92
95
  @config
93
96
  end
94
97
 
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @identity_aware_proxy_admin_service_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new IdentityAwareProxyAdminService client object.
97
109
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -137,8 +150,10 @@ module Google
137
150
 
138
151
  @identity_aware_proxy_admin_service_stub = ::Gapic::ServiceStub.new(
139
152
  ::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Stub,
140
- credentials: credentials,
141
- endpoint: @config.endpoint,
153
+ credentials: credentials,
154
+ endpoint: @config.endpoint,
155
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
156
+ universe_domain: @config.universe_domain,
142
157
  channel_args: @config.channel_args,
143
158
  interceptors: @config.interceptors,
144
159
  channel_pool_config: @config.channel_pool
@@ -1110,9 +1125,9 @@ module Google
1110
1125
  # end
1111
1126
  #
1112
1127
  # @!attribute [rw] endpoint
1113
- # The hostname or hostname:port of the service endpoint.
1114
- # Defaults to `"iap.googleapis.com"`.
1115
- # @return [::String]
1128
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1129
+ # nil, indicating to use the default endpoint in the current universe domain.
1130
+ # @return [::String,nil]
1116
1131
  # @!attribute [rw] credentials
1117
1132
  # Credentials to send with calls. You may provide any of the following types:
1118
1133
  # * (`String`) The path to a service account key file in JSON format
@@ -1158,13 +1173,20 @@ module Google
1158
1173
  # @!attribute [rw] quota_project
1159
1174
  # A separate project against which to charge quota.
1160
1175
  # @return [::String]
1176
+ # @!attribute [rw] universe_domain
1177
+ # The universe domain within which to make requests. This determines the
1178
+ # default endpoint URL. The default value of nil uses the environment
1179
+ # universe (usually the default "googleapis.com" universe).
1180
+ # @return [::String,nil]
1161
1181
  #
1162
1182
  class Configuration
1163
1183
  extend ::Gapic::Config
1164
1184
 
1185
+ # @private
1186
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1165
1187
  DEFAULT_ENDPOINT = "iap.googleapis.com"
1166
1188
 
1167
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1189
+ config_attr :endpoint, nil, ::String, nil
1168
1190
  config_attr :credentials, nil do |value|
1169
1191
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1170
1192
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1179,6 +1201,7 @@ module Google
1179
1201
  config_attr :metadata, nil, ::Hash, nil
1180
1202
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1181
1203
  config_attr :quota_project, nil, ::String, nil
1204
+ config_attr :universe_domain, nil, ::String, nil
1182
1205
 
1183
1206
  # @private
1184
1207
  def initialize parent_config = nil
data/lib/google/cloud/iap/v1/identity_aware_proxy_admin_service/rest/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # APIs for Identity-Aware Proxy Admin configurations.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "iap.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -94,6 +97,15 @@ module Google
94
97
  @config
95
98
  end
96
99
 
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @identity_aware_proxy_admin_service_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new IdentityAwareProxyAdminService REST client object.
99
111
  #
@@ -121,8 +133,9 @@ module Google
121
133
  credentials = @config.credentials
122
134
  # Use self-signed JWT if the endpoint is unchanged from default,
123
135
  # but only if the default endpoint does not have a region prefix.
124
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
125
- !@config.endpoint.split(".").first.include?("-")
136
+ enable_self_signed_jwt = @config.endpoint.nil? ||
137
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
138
+ !@config.endpoint.split(".").first.include?("-"))
126
139
  credentials ||= Credentials.default scope: @config.scope,
127
140
  enable_self_signed_jwt: enable_self_signed_jwt
128
141
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -132,7 +145,12 @@ module Google
132
145
  @quota_project_id = @config.quota_project
133
146
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
134
147
 
135
- @identity_aware_proxy_admin_service_stub = ::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
148
+ @identity_aware_proxy_admin_service_stub = ::Google::Cloud::Iap::V1::IdentityAwareProxyAdminService::Rest::ServiceStub.new(
149
+ endpoint: @config.endpoint,
150
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
151
+ universe_domain: @config.universe_domain,
152
+ credentials: credentials
153
+ )
136
154
  end
137
155
 
138
156
  # Service calls
@@ -1030,9 +1048,9 @@ module Google
1030
1048
  # end
1031
1049
  #
1032
1050
  # @!attribute [rw] endpoint
1033
- # The hostname or hostname:port of the service endpoint.
1034
- # Defaults to `"iap.googleapis.com"`.
1035
- # @return [::String]
1051
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1052
+ # nil, indicating to use the default endpoint in the current universe domain.
1053
+ # @return [::String,nil]
1036
1054
  # @!attribute [rw] credentials
1037
1055
  # Credentials to send with calls. You may provide any of the following types:
1038
1056
  # * (`String`) The path to a service account key file in JSON format
@@ -1069,13 +1087,20 @@ module Google
1069
1087
  # @!attribute [rw] quota_project
1070
1088
  # A separate project against which to charge quota.
1071
1089
  # @return [::String]
1090
+ # @!attribute [rw] universe_domain
1091
+ # The universe domain within which to make requests. This determines the
1092
+ # default endpoint URL. The default value of nil uses the environment
1093
+ # universe (usually the default "googleapis.com" universe).
1094
+ # @return [::String,nil]
1072
1095
  #
1073
1096
  class Configuration
1074
1097
  extend ::Gapic::Config
1075
1098
 
1099
+ # @private
1100
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1076
1101
  DEFAULT_ENDPOINT = "iap.googleapis.com"
1077
1102
 
1078
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1103
+ config_attr :endpoint, nil, ::String, nil
1079
1104
  config_attr :credentials, nil do |value|
1080
1105
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1081
1106
  allowed.any? { |klass| klass === value }
@@ -1087,6 +1112,7 @@ module Google
1087
1112
  config_attr :metadata, nil, ::Hash, nil
1088
1113
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1089
1114
  config_attr :quota_project, nil, ::String, nil
1115
+ config_attr :universe_domain, nil, ::String, nil
1090
1116
 
1091
1117
  # @private
1092
1118
  def initialize parent_config = nil
data/lib/google/cloud/iap/v1/identity_aware_proxy_admin_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 set_iam_policy REST call
45
57
  #
data/lib/google/cloud/iap/v1/identity_aware_proxy_o_auth_service/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # clients.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "iap.$UNIVERSE_DOMAIN$"
37
+
35
38
  # @private
36
39
  attr_reader :identity_aware_proxy_o_auth_service_stub
37
40
 
@@ -92,6 +95,15 @@ module Google
92
95
  @config
93
96
  end
94
97
 
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @identity_aware_proxy_o_auth_service_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new IdentityAwareProxyOAuthService client object.
97
109
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -137,8 +150,10 @@ module Google
137
150
 
138
151
  @identity_aware_proxy_o_auth_service_stub = ::Gapic::ServiceStub.new(
139
152
  ::Google::Cloud::Iap::V1::IdentityAwareProxyOAuthService::Stub,
140
- credentials: credentials,
141
- endpoint: @config.endpoint,
153
+ credentials: credentials,
154
+ endpoint: @config.endpoint,
155
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
156
+ universe_domain: @config.universe_domain,
142
157
  channel_args: @config.channel_args,
143
158
  interceptors: @config.interceptors,
144
159
  channel_pool_config: @config.channel_pool
@@ -904,9 +919,9 @@ module Google
904
919
  # end
905
920
  #
906
921
  # @!attribute [rw] endpoint
907
- # The hostname or hostname:port of the service endpoint.
908
- # Defaults to `"iap.googleapis.com"`.
909
- # @return [::String]
922
+ # A custom service endpoint, as a hostname or hostname:port. The default is
923
+ # nil, indicating to use the default endpoint in the current universe domain.
924
+ # @return [::String,nil]
910
925
  # @!attribute [rw] credentials
911
926
  # Credentials to send with calls. You may provide any of the following types:
912
927
  # * (`String`) The path to a service account key file in JSON format
@@ -952,13 +967,20 @@ module Google
952
967
  # @!attribute [rw] quota_project
953
968
  # A separate project against which to charge quota.
954
969
  # @return [::String]
970
+ # @!attribute [rw] universe_domain
971
+ # The universe domain within which to make requests. This determines the
972
+ # default endpoint URL. The default value of nil uses the environment
973
+ # universe (usually the default "googleapis.com" universe).
974
+ # @return [::String,nil]
955
975
  #
956
976
  class Configuration
957
977
  extend ::Gapic::Config
958
978
 
979
+ # @private
980
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
959
981
  DEFAULT_ENDPOINT = "iap.googleapis.com"
960
982
 
961
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
983
+ config_attr :endpoint, nil, ::String, nil
962
984
  config_attr :credentials, nil do |value|
963
985
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
964
986
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -973,6 +995,7 @@ module Google
973
995
  config_attr :metadata, nil, ::Hash, nil
974
996
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
975
997
  config_attr :quota_project, nil, ::String, nil
998
+ config_attr :universe_domain, nil, ::String, nil
976
999
 
977
1000
  # @private
978
1001
  def initialize parent_config = nil
data/lib/google/cloud/iap/v1/identity_aware_proxy_o_auth_service/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # clients.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "iap.$UNIVERSE_DOMAIN$"
39
+
37
40
  # @private
38
41
  attr_reader :identity_aware_proxy_o_auth_service_stub
39
42
 
@@ -94,6 +97,15 @@ module Google
94
97
  @config
95
98
  end
96
99
 
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @identity_aware_proxy_o_auth_service_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new IdentityAwareProxyOAuthService REST client object.
99
111
  #
@@ -121,8 +133,9 @@ module Google
121
133
  credentials = @config.credentials
122
134
  # Use self-signed JWT if the endpoint is unchanged from default,
123
135
  # but only if the default endpoint does not have a region prefix.
124
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
125
- !@config.endpoint.split(".").first.include?("-")
136
+ enable_self_signed_jwt = @config.endpoint.nil? ||
137
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
138
+ !@config.endpoint.split(".").first.include?("-"))
126
139
  credentials ||= Credentials.default scope: @config.scope,
127
140
  enable_self_signed_jwt: enable_self_signed_jwt
128
141
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -132,7 +145,12 @@ module Google
132
145
  @quota_project_id = @config.quota_project
133
146
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
134
147
 
135
- @identity_aware_proxy_o_auth_service_stub = ::Google::Cloud::Iap::V1::IdentityAwareProxyOAuthService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
148
+ @identity_aware_proxy_o_auth_service_stub = ::Google::Cloud::Iap::V1::IdentityAwareProxyOAuthService::Rest::ServiceStub.new(
149
+ endpoint: @config.endpoint,
150
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
151
+ universe_domain: @config.universe_domain,
152
+ credentials: credentials
153
+ )
136
154
  end
137
155
 
138
156
  # Service calls
@@ -838,9 +856,9 @@ module Google
838
856
  # end
839
857
  #
840
858
  # @!attribute [rw] endpoint
841
- # The hostname or hostname:port of the service endpoint.
842
- # Defaults to `"iap.googleapis.com"`.
843
- # @return [::String]
859
+ # A custom service endpoint, as a hostname or hostname:port. The default is
860
+ # nil, indicating to use the default endpoint in the current universe domain.
861
+ # @return [::String,nil]
844
862
  # @!attribute [rw] credentials
845
863
  # Credentials to send with calls. You may provide any of the following types:
846
864
  # * (`String`) The path to a service account key file in JSON format
@@ -877,13 +895,20 @@ module Google
877
895
  # @!attribute [rw] quota_project
878
896
  # A separate project against which to charge quota.
879
897
  # @return [::String]
898
+ # @!attribute [rw] universe_domain
899
+ # The universe domain within which to make requests. This determines the
900
+ # default endpoint URL. The default value of nil uses the environment
901
+ # universe (usually the default "googleapis.com" universe).
902
+ # @return [::String,nil]
880
903
  #
881
904
  class Configuration
882
905
  extend ::Gapic::Config
883
906
 
907
+ # @private
908
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
884
909
  DEFAULT_ENDPOINT = "iap.googleapis.com"
885
910
 
886
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
911
+ config_attr :endpoint, nil, ::String, nil
887
912
  config_attr :credentials, nil do |value|
888
913
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
889
914
  allowed.any? { |klass| klass === value }
@@ -895,6 +920,7 @@ module Google
895
920
  config_attr :metadata, nil, ::Hash, nil
896
921
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
897
922
  config_attr :quota_project, nil, ::String, nil
923
+ config_attr :universe_domain, nil, ::String, nil
898
924
 
899
925
  # @private
900
926
  def initialize parent_config = nil
data/lib/google/cloud/iap/v1/identity_aware_proxy_o_auth_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 list_brands REST call
45
57
  #
data/lib/google/cloud/iap/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Iap
23
23
  module V1
24
- VERSION = "0.10.1"
24
+ VERSION = "0.11.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
@@ -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-iap-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.1
4
+ version: 0.11.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-25 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.20.0
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -236,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
236
236
  - !ruby/object:Gem::Version
237
237
  version: '0'
238
238
  requirements: []
239
- rubygems_version: 3.4.19
239
+ rubygems_version: 3.5.3
240
240
  signing_key:
241
241
  specification_version: 4
242
242
  summary: Controls access to cloud applications running on Google Cloud Platform.