google-cloud-access_approval-v1 0.9.0 → 0.11.0

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: 7b21f1c38cdcae3bffe301c7f72ccfb4df27edd894a530c33133558f1b783c6f
4
- data.tar.gz: 6dd8378f40967a20bf9a2267c8e238060579d856c7ee96eb64e43cb6e267cea2
3
+ metadata.gz: 5e8cbf4e75b58265d634dbafc85b2f12fddd0c961427e6d2721df87e3661c64e
4
+ data.tar.gz: 3bbbc6ad8a076fc5aca587ac5bad6aab9706cddc094dc98c4a8048fcbe2373fc
5
5
  SHA512:
6
- metadata.gz: b9b7d888e59f9f2c812033d1ebd13d13c534741ff0b982b5991f129616ad32dab9b6a14b62f6cfcaf4aa8d08fe508f119138394e291f83fa84b2318d8f13681f
7
- data.tar.gz: f84b87a8b4732f097509f3736956f5da622a7c99a66d861e9898328ed7262b517658bfcc571d7b946d6f6fa7c91fb2c535ae1661c862068233831a9a18b5841e
6
+ metadata.gz: 721fb65730b3b44b060397c97edec5af38bc0df5411998e9a37306b2ed253472f49073d550cfaf33a6dd394d6bed4ceed4a4e32ff7cf43b3db21b1d75cfbe198
7
+ data.tar.gz: ab92c733bcd35993f5a2c940840e400f35be1f6f5ce78574b042fb81de372a7290195a9884965f3c86a3b6eb73b07479e32a5f0d246884017f952898471b2bcc
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-access_approval-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-access_approval-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 ACCESS_APPROVAL_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/access_approval/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::AccessApproval::V1::AccessApproval::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-access_approval-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-access_approval-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-access_approval-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::AccessApproval::V1::AccessApproval::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `ACCESS_APPROVAL_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `ACCESS_APPROVAL_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/access_approval/v1"
77
-
78
- ENV["ACCESS_APPROVAL_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::AccessApproval::V1::AccessApproval::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/access_approval/v1"
90
58
 
91
59
  client = ::Google::Cloud::AccessApproval::V1::AccessApproval::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/access_approval/v1"
100
68
 
101
69
  ::Google::Cloud::AccessApproval::V1::AccessApproval::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::AccessApproval::V1::AccessApproval::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-access_approval-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/access_approval/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-access_approval-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::AccessApproval::V1::AccessApproval::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).
@@ -62,6 +62,9 @@ module Google
62
62
  # If a request is not approved or dismissed, we call it pending.
63
63
  #
64
64
  class Client
65
+ # @private
66
+ DEFAULT_ENDPOINT_TEMPLATE = "accessapproval.$UNIVERSE_DOMAIN$"
67
+
65
68
  include Paths
66
69
 
67
70
  # @private
@@ -147,6 +150,15 @@ module Google
147
150
  @config
148
151
  end
149
152
 
153
+ ##
154
+ # The effective universe domain
155
+ #
156
+ # @return [String]
157
+ #
158
+ def universe_domain
159
+ @access_approval_stub.universe_domain
160
+ end
161
+
150
162
  ##
151
163
  # Create a new AccessApproval client object.
152
164
  #
@@ -180,8 +192,9 @@ module Google
180
192
  credentials = @config.credentials
181
193
  # Use self-signed JWT if the endpoint is unchanged from default,
182
194
  # but only if the default endpoint does not have a region prefix.
183
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
184
- !@config.endpoint.split(".").first.include?("-")
195
+ enable_self_signed_jwt = @config.endpoint.nil? ||
196
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
197
+ !@config.endpoint.split(".").first.include?("-"))
185
198
  credentials ||= Credentials.default scope: @config.scope,
186
199
  enable_self_signed_jwt: enable_self_signed_jwt
187
200
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -192,10 +205,13 @@ module Google
192
205
 
193
206
  @access_approval_stub = ::Gapic::ServiceStub.new(
194
207
  ::Google::Cloud::AccessApproval::V1::AccessApproval::Stub,
195
- credentials: credentials,
196
- endpoint: @config.endpoint,
208
+ credentials: credentials,
209
+ endpoint: @config.endpoint,
210
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
211
+ universe_domain: @config.universe_domain,
197
212
  channel_args: @config.channel_args,
198
- interceptors: @config.interceptors
213
+ interceptors: @config.interceptors,
214
+ channel_pool_config: @config.channel_pool
199
215
  )
200
216
  end
201
217
 
@@ -1063,9 +1079,9 @@ module Google
1063
1079
  # end
1064
1080
  #
1065
1081
  # @!attribute [rw] endpoint
1066
- # The hostname or hostname:port of the service endpoint.
1067
- # Defaults to `"accessapproval.googleapis.com"`.
1068
- # @return [::String]
1082
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1083
+ # nil, indicating to use the default endpoint in the current universe domain.
1084
+ # @return [::String,nil]
1069
1085
  # @!attribute [rw] credentials
1070
1086
  # Credentials to send with calls. You may provide any of the following types:
1071
1087
  # * (`String`) The path to a service account key file in JSON format
@@ -1111,13 +1127,20 @@ module Google
1111
1127
  # @!attribute [rw] quota_project
1112
1128
  # A separate project against which to charge quota.
1113
1129
  # @return [::String]
1130
+ # @!attribute [rw] universe_domain
1131
+ # The universe domain within which to make requests. This determines the
1132
+ # default endpoint URL. The default value of nil uses the environment
1133
+ # universe (usually the default "googleapis.com" universe).
1134
+ # @return [::String,nil]
1114
1135
  #
1115
1136
  class Configuration
1116
1137
  extend ::Gapic::Config
1117
1138
 
1139
+ # @private
1140
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1118
1141
  DEFAULT_ENDPOINT = "accessapproval.googleapis.com"
1119
1142
 
1120
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1143
+ config_attr :endpoint, nil, ::String, nil
1121
1144
  config_attr :credentials, nil do |value|
1122
1145
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1123
1146
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1132,6 +1155,7 @@ module Google
1132
1155
  config_attr :metadata, nil, ::Hash, nil
1133
1156
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1134
1157
  config_attr :quota_project, nil, ::String, nil
1158
+ config_attr :universe_domain, nil, ::String, nil
1135
1159
 
1136
1160
  # @private
1137
1161
  def initialize parent_config = nil
@@ -1152,6 +1176,14 @@ module Google
1152
1176
  end
1153
1177
  end
1154
1178
 
1179
+ ##
1180
+ # Configuration for the channel pool
1181
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1182
+ #
1183
+ def channel_pool
1184
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1185
+ end
1186
+
1155
1187
  ##
1156
1188
  # Configuration RPC class for the AccessApproval API.
1157
1189
  #
@@ -64,6 +64,9 @@ module Google
64
64
  # If a request is not approved or dismissed, we call it pending.
65
65
  #
66
66
  class Client
67
+ # @private
68
+ DEFAULT_ENDPOINT_TEMPLATE = "accessapproval.$UNIVERSE_DOMAIN$"
69
+
67
70
  include Paths
68
71
 
69
72
  # @private
@@ -149,6 +152,15 @@ module Google
149
152
  @config
150
153
  end
151
154
 
155
+ ##
156
+ # The effective universe domain
157
+ #
158
+ # @return [String]
159
+ #
160
+ def universe_domain
161
+ @access_approval_stub.universe_domain
162
+ end
163
+
152
164
  ##
153
165
  # Create a new AccessApproval REST client object.
154
166
  #
@@ -176,8 +188,9 @@ module Google
176
188
  credentials = @config.credentials
177
189
  # Use self-signed JWT if the endpoint is unchanged from default,
178
190
  # but only if the default endpoint does not have a region prefix.
179
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
180
- !@config.endpoint.split(".").first.include?("-")
191
+ enable_self_signed_jwt = @config.endpoint.nil? ||
192
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
193
+ !@config.endpoint.split(".").first.include?("-"))
181
194
  credentials ||= Credentials.default scope: @config.scope,
182
195
  enable_self_signed_jwt: enable_self_signed_jwt
183
196
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -187,7 +200,12 @@ module Google
187
200
  @quota_project_id = @config.quota_project
188
201
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
189
202
 
190
- @access_approval_stub = ::Google::Cloud::AccessApproval::V1::AccessApproval::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
203
+ @access_approval_stub = ::Google::Cloud::AccessApproval::V1::AccessApproval::Rest::ServiceStub.new(
204
+ endpoint: @config.endpoint,
205
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
206
+ universe_domain: @config.universe_domain,
207
+ credentials: credentials
208
+ )
191
209
  end
192
210
 
193
211
  # Service calls
@@ -239,6 +257,26 @@ module Google
239
257
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AccessApproval::V1::ApprovalRequest>]
240
258
  #
241
259
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
260
+ #
261
+ # @example Basic example
262
+ # require "google/cloud/access_approval/v1"
263
+ #
264
+ # # Create a client object. The client can be reused for multiple calls.
265
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
266
+ #
267
+ # # Create a request. To set request fields, pass in keyword arguments.
268
+ # request = Google::Cloud::AccessApproval::V1::ListApprovalRequestsMessage.new
269
+ #
270
+ # # Call the list_approval_requests method.
271
+ # result = client.list_approval_requests request
272
+ #
273
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
274
+ # # over elements, and API calls will be issued to fetch pages as needed.
275
+ # result.each do |item|
276
+ # # Each element is of type ::Google::Cloud::AccessApproval::V1::ApprovalRequest.
277
+ # p item
278
+ # end
279
+ #
242
280
  def list_approval_requests request, options = nil
243
281
  raise ::ArgumentError, "request must be provided" if request.nil?
244
282
 
@@ -304,6 +342,22 @@ module Google
304
342
  # @return [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
305
343
  #
306
344
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
345
+ #
346
+ # @example Basic example
347
+ # require "google/cloud/access_approval/v1"
348
+ #
349
+ # # Create a client object. The client can be reused for multiple calls.
350
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
351
+ #
352
+ # # Create a request. To set request fields, pass in keyword arguments.
353
+ # request = Google::Cloud::AccessApproval::V1::GetApprovalRequestMessage.new
354
+ #
355
+ # # Call the get_approval_request method.
356
+ # result = client.get_approval_request request
357
+ #
358
+ # # The returned object is of type Google::Cloud::AccessApproval::V1::ApprovalRequest.
359
+ # p result
360
+ #
307
361
  def get_approval_request request, options = nil
308
362
  raise ::ArgumentError, "request must be provided" if request.nil?
309
363
 
@@ -371,6 +425,22 @@ module Google
371
425
  # @return [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
372
426
  #
373
427
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
428
+ #
429
+ # @example Basic example
430
+ # require "google/cloud/access_approval/v1"
431
+ #
432
+ # # Create a client object. The client can be reused for multiple calls.
433
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
434
+ #
435
+ # # Create a request. To set request fields, pass in keyword arguments.
436
+ # request = Google::Cloud::AccessApproval::V1::ApproveApprovalRequestMessage.new
437
+ #
438
+ # # Call the approve_approval_request method.
439
+ # result = client.approve_approval_request request
440
+ #
441
+ # # The returned object is of type Google::Cloud::AccessApproval::V1::ApprovalRequest.
442
+ # p result
443
+ #
374
444
  def approve_approval_request request, options = nil
375
445
  raise ::ArgumentError, "request must be provided" if request.nil?
376
446
 
@@ -442,6 +512,22 @@ module Google
442
512
  # @return [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
443
513
  #
444
514
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
515
+ #
516
+ # @example Basic example
517
+ # require "google/cloud/access_approval/v1"
518
+ #
519
+ # # Create a client object. The client can be reused for multiple calls.
520
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
521
+ #
522
+ # # Create a request. To set request fields, pass in keyword arguments.
523
+ # request = Google::Cloud::AccessApproval::V1::DismissApprovalRequestMessage.new
524
+ #
525
+ # # Call the dismiss_approval_request method.
526
+ # result = client.dismiss_approval_request request
527
+ #
528
+ # # The returned object is of type Google::Cloud::AccessApproval::V1::ApprovalRequest.
529
+ # p result
530
+ #
445
531
  def dismiss_approval_request request, options = nil
446
532
  raise ::ArgumentError, "request must be provided" if request.nil?
447
533
 
@@ -511,6 +597,22 @@ module Google
511
597
  # @return [::Google::Cloud::AccessApproval::V1::ApprovalRequest]
512
598
  #
513
599
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
600
+ #
601
+ # @example Basic example
602
+ # require "google/cloud/access_approval/v1"
603
+ #
604
+ # # Create a client object. The client can be reused for multiple calls.
605
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
606
+ #
607
+ # # Create a request. To set request fields, pass in keyword arguments.
608
+ # request = Google::Cloud::AccessApproval::V1::InvalidateApprovalRequestMessage.new
609
+ #
610
+ # # Call the invalidate_approval_request method.
611
+ # result = client.invalidate_approval_request request
612
+ #
613
+ # # The returned object is of type Google::Cloud::AccessApproval::V1::ApprovalRequest.
614
+ # p result
615
+ #
514
616
  def invalidate_approval_request request, options = nil
515
617
  raise ::ArgumentError, "request must be provided" if request.nil?
516
618
 
@@ -574,6 +676,22 @@ module Google
574
676
  # @return [::Google::Cloud::AccessApproval::V1::AccessApprovalSettings]
575
677
  #
576
678
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
679
+ #
680
+ # @example Basic example
681
+ # require "google/cloud/access_approval/v1"
682
+ #
683
+ # # Create a client object. The client can be reused for multiple calls.
684
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
685
+ #
686
+ # # Create a request. To set request fields, pass in keyword arguments.
687
+ # request = Google::Cloud::AccessApproval::V1::GetAccessApprovalSettingsMessage.new
688
+ #
689
+ # # Call the get_access_approval_settings method.
690
+ # result = client.get_access_approval_settings request
691
+ #
692
+ # # The returned object is of type Google::Cloud::AccessApproval::V1::AccessApprovalSettings.
693
+ # p result
694
+ #
577
695
  def get_access_approval_settings request, options = nil
578
696
  raise ::ArgumentError, "request must be provided" if request.nil?
579
697
 
@@ -648,6 +766,22 @@ module Google
648
766
  # @return [::Google::Cloud::AccessApproval::V1::AccessApprovalSettings]
649
767
  #
650
768
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
769
+ #
770
+ # @example Basic example
771
+ # require "google/cloud/access_approval/v1"
772
+ #
773
+ # # Create a client object. The client can be reused for multiple calls.
774
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
775
+ #
776
+ # # Create a request. To set request fields, pass in keyword arguments.
777
+ # request = Google::Cloud::AccessApproval::V1::UpdateAccessApprovalSettingsMessage.new
778
+ #
779
+ # # Call the update_access_approval_settings method.
780
+ # result = client.update_access_approval_settings request
781
+ #
782
+ # # The returned object is of type Google::Cloud::AccessApproval::V1::AccessApprovalSettings.
783
+ # p result
784
+ #
651
785
  def update_access_approval_settings request, options = nil
652
786
  raise ::ArgumentError, "request must be provided" if request.nil?
653
787
 
@@ -715,6 +849,22 @@ module Google
715
849
  # @return [::Google::Protobuf::Empty]
716
850
  #
717
851
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
852
+ #
853
+ # @example Basic example
854
+ # require "google/cloud/access_approval/v1"
855
+ #
856
+ # # Create a client object. The client can be reused for multiple calls.
857
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
858
+ #
859
+ # # Create a request. To set request fields, pass in keyword arguments.
860
+ # request = Google::Cloud::AccessApproval::V1::DeleteAccessApprovalSettingsMessage.new
861
+ #
862
+ # # Call the delete_access_approval_settings method.
863
+ # result = client.delete_access_approval_settings request
864
+ #
865
+ # # The returned object is of type Google::Protobuf::Empty.
866
+ # p result
867
+ #
718
868
  def delete_access_approval_settings request, options = nil
719
869
  raise ::ArgumentError, "request must be provided" if request.nil?
720
870
 
@@ -778,6 +928,22 @@ module Google
778
928
  # @return [::Google::Cloud::AccessApproval::V1::AccessApprovalServiceAccount]
779
929
  #
780
930
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
931
+ #
932
+ # @example Basic example
933
+ # require "google/cloud/access_approval/v1"
934
+ #
935
+ # # Create a client object. The client can be reused for multiple calls.
936
+ # client = Google::Cloud::AccessApproval::V1::AccessApproval::Rest::Client.new
937
+ #
938
+ # # Create a request. To set request fields, pass in keyword arguments.
939
+ # request = Google::Cloud::AccessApproval::V1::GetAccessApprovalServiceAccountMessage.new
940
+ #
941
+ # # Call the get_access_approval_service_account method.
942
+ # result = client.get_access_approval_service_account request
943
+ #
944
+ # # The returned object is of type Google::Cloud::AccessApproval::V1::AccessApprovalServiceAccount.
945
+ # p result
946
+ #
781
947
  def get_access_approval_service_account request, options = nil
782
948
  raise ::ArgumentError, "request must be provided" if request.nil?
783
949
 
@@ -843,9 +1009,9 @@ module Google
843
1009
  # end
844
1010
  #
845
1011
  # @!attribute [rw] endpoint
846
- # The hostname or hostname:port of the service endpoint.
847
- # Defaults to `"accessapproval.googleapis.com"`.
848
- # @return [::String]
1012
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1013
+ # nil, indicating to use the default endpoint in the current universe domain.
1014
+ # @return [::String,nil]
849
1015
  # @!attribute [rw] credentials
850
1016
  # Credentials to send with calls. You may provide any of the following types:
851
1017
  # * (`String`) The path to a service account key file in JSON format
@@ -882,13 +1048,20 @@ module Google
882
1048
  # @!attribute [rw] quota_project
883
1049
  # A separate project against which to charge quota.
884
1050
  # @return [::String]
1051
+ # @!attribute [rw] universe_domain
1052
+ # The universe domain within which to make requests. This determines the
1053
+ # default endpoint URL. The default value of nil uses the environment
1054
+ # universe (usually the default "googleapis.com" universe).
1055
+ # @return [::String,nil]
885
1056
  #
886
1057
  class Configuration
887
1058
  extend ::Gapic::Config
888
1059
 
1060
+ # @private
1061
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
889
1062
  DEFAULT_ENDPOINT = "accessapproval.googleapis.com"
890
1063
 
891
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1064
+ config_attr :endpoint, nil, ::String, nil
892
1065
  config_attr :credentials, nil do |value|
893
1066
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
894
1067
  allowed.any? { |klass| klass === value }
@@ -900,6 +1073,7 @@ module Google
900
1073
  config_attr :metadata, nil, ::Hash, nil
901
1074
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
902
1075
  config_attr :quota_project, nil, ::String, nil
1076
+ config_attr :universe_domain, nil, ::String, nil
903
1077
 
904
1078
  # @private
905
1079
  def initialize parent_config = nil
@@ -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_approval_requests REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module AccessApproval
23
23
  module V1
24
- VERSION = "0.9.0"
24
+ VERSION = "0.11.0"
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
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-access_approval-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
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-06-06 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.19.1
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.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
211
211
  - !ruby/object:Gem::Version
212
212
  version: '0'
213
213
  requirements: []
214
- rubygems_version: 3.4.2
214
+ rubygems_version: 3.5.3
215
215
  signing_key:
216
216
  specification_version: 4
217
217
  summary: An API for controlling access to data by Google personnel.