google-cloud-binary_authorization-v1beta1 0.11.0 → 0.12.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: ecdbdf896e63e143d094234e3309a8060f7e1d0d920b8c3013f6a56072b942e3
4
- data.tar.gz: 9208eab268d5c8d459e6698ab2e1b06f40e8bf907b1417f7a395dd26ebd2f3fd
3
+ metadata.gz: f1bcbea3e1453c3a10d30b89c630fd373cffdfb7b46f66cb6e5be1ba6c0dcd79
4
+ data.tar.gz: 7de176a477c5b2d5e1a09c671278d3fc76b25d013fa0cc8fadbe7744790ebdc0
5
5
  SHA512:
6
- metadata.gz: 20a07157ba610006104fb77e9542f2388e7535ed0e48eae3aaa6e94c71b2247b46af359dba6339f18eac6e15ddc3fabb1ca8073065976c86ef53cbb328601a69
7
- data.tar.gz: a7b1e40fa7f04f28e5ba6d27134d79982604880a25230f0ead8f6873ebd22c2e91940e55c2711364c45e53eb081f6cbfab7f0896881bca7fef22e27d577e1fbf
6
+ metadata.gz: 6d944bb6e6681546ca151961a925441879a3dcaefe838d928cc4748355e4459642cebd82f421c38ef55261a4644f03648d267795f1128544f4bd5d7e7c4701cb
7
+ data.tar.gz: bcbdd5591ba87b68d962857f7a14432c6a3d426a75e18957ba1327e54112f7a3d2e35c5e4abb62d0d860ebb18edaff8f1faf70d54b12555c2cc1f9c5ad83b1e2
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-binary_authorization-v1beta1 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-binary_authorization-v1beta1 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 BINARY_AUTHORIZATION_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/binary_authorization/v1beta1"
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::BinaryAuthorization::V1beta1::BinauthzManagementService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-binary_authorization-v1beta1 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-binary_authorization-v1beta1 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-binary_authorization-v1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::BinaryAuthorization::V1beta1::BinauthzManagementService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `BINARY_AUTHORIZATION_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `BINARY_AUTHORIZATION_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/binary_authorization/v1beta1"
77
-
78
- ENV["BINARY_AUTHORIZATION_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::BinaryAuthorization::V1beta1::BinauthzManagementService::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/binary_authorization/v1beta1"
90
58
 
91
59
  client = ::Google::Cloud::BinaryAuthorization::V1beta1::BinauthzManagementService::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/binary_authorization/v1beta1"
100
68
 
101
69
  ::Google::Cloud::BinaryAuthorization::V1beta1::BinauthzManagementService::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::BinaryAuthorization::V1beta1::BinauthzManagementService::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-binary_authorization-v1beta1
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/binary_authorization/v1beta1"
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-binary_authorization-v1beta1.
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::BinaryAuthorization::V1beta1::BinauthzManagementService::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).
@@ -36,6 +36,9 @@ module Google
36
36
  # * {::Google::Cloud::BinaryAuthorization::V1beta1::Attestor Attestor}
37
37
  #
38
38
  class Client
39
+ # @private
40
+ DEFAULT_ENDPOINT_TEMPLATE = "binaryauthorization.$UNIVERSE_DOMAIN$"
41
+
39
42
  include Paths
40
43
 
41
44
  # @private
@@ -128,6 +131,15 @@ module Google
128
131
  @config
129
132
  end
130
133
 
134
+ ##
135
+ # The effective universe domain
136
+ #
137
+ # @return [String]
138
+ #
139
+ def universe_domain
140
+ @binauthz_management_service_stub.universe_domain
141
+ end
142
+
131
143
  ##
132
144
  # Create a new BinauthzManagementService client object.
133
145
  #
@@ -161,8 +173,9 @@ module Google
161
173
  credentials = @config.credentials
162
174
  # Use self-signed JWT if the endpoint is unchanged from default,
163
175
  # but only if the default endpoint does not have a region prefix.
164
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
165
- !@config.endpoint.split(".").first.include?("-")
176
+ enable_self_signed_jwt = @config.endpoint.nil? ||
177
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
178
+ !@config.endpoint.split(".").first.include?("-"))
166
179
  credentials ||= Credentials.default scope: @config.scope,
167
180
  enable_self_signed_jwt: enable_self_signed_jwt
168
181
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -173,8 +186,10 @@ module Google
173
186
 
174
187
  @binauthz_management_service_stub = ::Gapic::ServiceStub.new(
175
188
  ::Google::Cloud::BinaryAuthorization::V1beta1::BinauthzManagementServiceV1Beta1::Stub,
176
- credentials: credentials,
177
- endpoint: @config.endpoint,
189
+ credentials: credentials,
190
+ endpoint: @config.endpoint,
191
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
192
+ universe_domain: @config.universe_domain,
178
193
  channel_args: @config.channel_args,
179
194
  interceptors: @config.interceptors,
180
195
  channel_pool_config: @config.channel_pool
@@ -851,9 +866,9 @@ module Google
851
866
  # end
852
867
  #
853
868
  # @!attribute [rw] endpoint
854
- # The hostname or hostname:port of the service endpoint.
855
- # Defaults to `"binaryauthorization.googleapis.com"`.
856
- # @return [::String]
869
+ # A custom service endpoint, as a hostname or hostname:port. The default is
870
+ # nil, indicating to use the default endpoint in the current universe domain.
871
+ # @return [::String,nil]
857
872
  # @!attribute [rw] credentials
858
873
  # Credentials to send with calls. You may provide any of the following types:
859
874
  # * (`String`) The path to a service account key file in JSON format
@@ -899,13 +914,20 @@ module Google
899
914
  # @!attribute [rw] quota_project
900
915
  # A separate project against which to charge quota.
901
916
  # @return [::String]
917
+ # @!attribute [rw] universe_domain
918
+ # The universe domain within which to make requests. This determines the
919
+ # default endpoint URL. The default value of nil uses the environment
920
+ # universe (usually the default "googleapis.com" universe).
921
+ # @return [::String,nil]
902
922
  #
903
923
  class Configuration
904
924
  extend ::Gapic::Config
905
925
 
926
+ # @private
927
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
906
928
  DEFAULT_ENDPOINT = "binaryauthorization.googleapis.com"
907
929
 
908
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
930
+ config_attr :endpoint, nil, ::String, nil
909
931
  config_attr :credentials, nil do |value|
910
932
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
911
933
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -920,6 +942,7 @@ module Google
920
942
  config_attr :metadata, nil, ::Hash, nil
921
943
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
922
944
  config_attr :quota_project, nil, ::String, nil
945
+ config_attr :universe_domain, nil, ::String, nil
923
946
 
924
947
  # @private
925
948
  def initialize parent_config = nil
@@ -38,6 +38,9 @@ module Google
38
38
  # * {::Google::Cloud::BinaryAuthorization::V1beta1::Attestor Attestor}
39
39
  #
40
40
  class Client
41
+ # @private
42
+ DEFAULT_ENDPOINT_TEMPLATE = "binaryauthorization.$UNIVERSE_DOMAIN$"
43
+
41
44
  include Paths
42
45
 
43
46
  # @private
@@ -130,6 +133,15 @@ module Google
130
133
  @config
131
134
  end
132
135
 
136
+ ##
137
+ # The effective universe domain
138
+ #
139
+ # @return [String]
140
+ #
141
+ def universe_domain
142
+ @binauthz_management_service_stub.universe_domain
143
+ end
144
+
133
145
  ##
134
146
  # Create a new BinauthzManagementService REST client object.
135
147
  #
@@ -157,8 +169,9 @@ module Google
157
169
  credentials = @config.credentials
158
170
  # Use self-signed JWT if the endpoint is unchanged from default,
159
171
  # but only if the default endpoint does not have a region prefix.
160
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
161
- !@config.endpoint.split(".").first.include?("-")
172
+ enable_self_signed_jwt = @config.endpoint.nil? ||
173
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
174
+ !@config.endpoint.split(".").first.include?("-"))
162
175
  credentials ||= Credentials.default scope: @config.scope,
163
176
  enable_self_signed_jwt: enable_self_signed_jwt
164
177
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -168,7 +181,12 @@ module Google
168
181
  @quota_project_id = @config.quota_project
169
182
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
170
183
 
171
- @binauthz_management_service_stub = ::Google::Cloud::BinaryAuthorization::V1beta1::BinauthzManagementService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
184
+ @binauthz_management_service_stub = ::Google::Cloud::BinaryAuthorization::V1beta1::BinauthzManagementService::Rest::ServiceStub.new(
185
+ endpoint: @config.endpoint,
186
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
187
+ universe_domain: @config.universe_domain,
188
+ credentials: credentials
189
+ )
172
190
  end
173
191
 
174
192
  # Service calls
@@ -792,9 +810,9 @@ module Google
792
810
  # end
793
811
  #
794
812
  # @!attribute [rw] endpoint
795
- # The hostname or hostname:port of the service endpoint.
796
- # Defaults to `"binaryauthorization.googleapis.com"`.
797
- # @return [::String]
813
+ # A custom service endpoint, as a hostname or hostname:port. The default is
814
+ # nil, indicating to use the default endpoint in the current universe domain.
815
+ # @return [::String,nil]
798
816
  # @!attribute [rw] credentials
799
817
  # Credentials to send with calls. You may provide any of the following types:
800
818
  # * (`String`) The path to a service account key file in JSON format
@@ -831,13 +849,20 @@ module Google
831
849
  # @!attribute [rw] quota_project
832
850
  # A separate project against which to charge quota.
833
851
  # @return [::String]
852
+ # @!attribute [rw] universe_domain
853
+ # The universe domain within which to make requests. This determines the
854
+ # default endpoint URL. The default value of nil uses the environment
855
+ # universe (usually the default "googleapis.com" universe).
856
+ # @return [::String,nil]
834
857
  #
835
858
  class Configuration
836
859
  extend ::Gapic::Config
837
860
 
861
+ # @private
862
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
838
863
  DEFAULT_ENDPOINT = "binaryauthorization.googleapis.com"
839
864
 
840
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
865
+ config_attr :endpoint, nil, ::String, nil
841
866
  config_attr :credentials, nil do |value|
842
867
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
843
868
  allowed.any? { |klass| klass === value }
@@ -849,6 +874,7 @@ module Google
849
874
  config_attr :metadata, nil, ::Hash, nil
850
875
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
851
876
  config_attr :quota_project, nil, ::String, nil
877
+ config_attr :universe_domain, nil, ::String, nil
852
878
 
853
879
  # @private
854
880
  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 get_policy REST call
45
57
  #
@@ -30,6 +30,9 @@ module Google
30
30
  # API for working with the system policy.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "binaryauthorization.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -90,6 +93,15 @@ module Google
90
93
  @config
91
94
  end
92
95
 
96
+ ##
97
+ # The effective universe domain
98
+ #
99
+ # @return [String]
100
+ #
101
+ def universe_domain
102
+ @system_policy_stub.universe_domain
103
+ end
104
+
93
105
  ##
94
106
  # Create a new SystemPolicy client object.
95
107
  #
@@ -123,8 +135,9 @@ module Google
123
135
  credentials = @config.credentials
124
136
  # Use self-signed JWT if the endpoint is unchanged from default,
125
137
  # but only if the default endpoint does not have a region prefix.
126
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
127
- !@config.endpoint.split(".").first.include?("-")
138
+ enable_self_signed_jwt = @config.endpoint.nil? ||
139
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
+ !@config.endpoint.split(".").first.include?("-"))
128
141
  credentials ||= Credentials.default scope: @config.scope,
129
142
  enable_self_signed_jwt: enable_self_signed_jwt
130
143
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -135,8 +148,10 @@ module Google
135
148
 
136
149
  @system_policy_stub = ::Gapic::ServiceStub.new(
137
150
  ::Google::Cloud::BinaryAuthorization::V1beta1::SystemPolicyV1Beta1::Stub,
138
- credentials: credentials,
139
- endpoint: @config.endpoint,
151
+ credentials: credentials,
152
+ endpoint: @config.endpoint,
153
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
154
+ universe_domain: @config.universe_domain,
140
155
  channel_args: @config.channel_args,
141
156
  interceptors: @config.interceptors,
142
157
  channel_pool_config: @config.channel_pool
@@ -261,9 +276,9 @@ module Google
261
276
  # end
262
277
  #
263
278
  # @!attribute [rw] endpoint
264
- # The hostname or hostname:port of the service endpoint.
265
- # Defaults to `"binaryauthorization.googleapis.com"`.
266
- # @return [::String]
279
+ # A custom service endpoint, as a hostname or hostname:port. The default is
280
+ # nil, indicating to use the default endpoint in the current universe domain.
281
+ # @return [::String,nil]
267
282
  # @!attribute [rw] credentials
268
283
  # Credentials to send with calls. You may provide any of the following types:
269
284
  # * (`String`) The path to a service account key file in JSON format
@@ -309,13 +324,20 @@ module Google
309
324
  # @!attribute [rw] quota_project
310
325
  # A separate project against which to charge quota.
311
326
  # @return [::String]
327
+ # @!attribute [rw] universe_domain
328
+ # The universe domain within which to make requests. This determines the
329
+ # default endpoint URL. The default value of nil uses the environment
330
+ # universe (usually the default "googleapis.com" universe).
331
+ # @return [::String,nil]
312
332
  #
313
333
  class Configuration
314
334
  extend ::Gapic::Config
315
335
 
336
+ # @private
337
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
316
338
  DEFAULT_ENDPOINT = "binaryauthorization.googleapis.com"
317
339
 
318
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
340
+ config_attr :endpoint, nil, ::String, nil
319
341
  config_attr :credentials, nil do |value|
320
342
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
321
343
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -330,6 +352,7 @@ module Google
330
352
  config_attr :metadata, nil, ::Hash, nil
331
353
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
332
354
  config_attr :quota_project, nil, ::String, nil
355
+ config_attr :universe_domain, nil, ::String, nil
333
356
 
334
357
  # @private
335
358
  def initialize parent_config = nil
@@ -32,6 +32,9 @@ module Google
32
32
  # API for working with the system policy.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "binaryauthorization.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @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
+ @system_policy_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new SystemPolicy REST client object.
97
109
  #
@@ -119,8 +131,9 @@ module Google
119
131
  credentials = @config.credentials
120
132
  # Use self-signed JWT if the endpoint is unchanged from default,
121
133
  # but only if the default endpoint does not have a region prefix.
122
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
123
- !@config.endpoint.split(".").first.include?("-")
134
+ enable_self_signed_jwt = @config.endpoint.nil? ||
135
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
136
+ !@config.endpoint.split(".").first.include?("-"))
124
137
  credentials ||= Credentials.default scope: @config.scope,
125
138
  enable_self_signed_jwt: enable_self_signed_jwt
126
139
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -130,7 +143,12 @@ module Google
130
143
  @quota_project_id = @config.quota_project
131
144
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
132
145
 
133
- @system_policy_stub = ::Google::Cloud::BinaryAuthorization::V1beta1::SystemPolicy::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
146
+ @system_policy_stub = ::Google::Cloud::BinaryAuthorization::V1beta1::SystemPolicy::Rest::ServiceStub.new(
147
+ endpoint: @config.endpoint,
148
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
149
+ universe_domain: @config.universe_domain,
150
+ credentials: credentials
151
+ )
134
152
  end
135
153
 
136
154
  # Service calls
@@ -244,9 +262,9 @@ module Google
244
262
  # end
245
263
  #
246
264
  # @!attribute [rw] endpoint
247
- # The hostname or hostname:port of the service endpoint.
248
- # Defaults to `"binaryauthorization.googleapis.com"`.
249
- # @return [::String]
265
+ # A custom service endpoint, as a hostname or hostname:port. The default is
266
+ # nil, indicating to use the default endpoint in the current universe domain.
267
+ # @return [::String,nil]
250
268
  # @!attribute [rw] credentials
251
269
  # Credentials to send with calls. You may provide any of the following types:
252
270
  # * (`String`) The path to a service account key file in JSON format
@@ -283,13 +301,20 @@ module Google
283
301
  # @!attribute [rw] quota_project
284
302
  # A separate project against which to charge quota.
285
303
  # @return [::String]
304
+ # @!attribute [rw] universe_domain
305
+ # The universe domain within which to make requests. This determines the
306
+ # default endpoint URL. The default value of nil uses the environment
307
+ # universe (usually the default "googleapis.com" universe).
308
+ # @return [::String,nil]
286
309
  #
287
310
  class Configuration
288
311
  extend ::Gapic::Config
289
312
 
313
+ # @private
314
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
290
315
  DEFAULT_ENDPOINT = "binaryauthorization.googleapis.com"
291
316
 
292
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
317
+ config_attr :endpoint, nil, ::String, nil
293
318
  config_attr :credentials, nil do |value|
294
319
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
295
320
  allowed.any? { |klass| klass === value }
@@ -301,6 +326,7 @@ module Google
301
326
  config_attr :metadata, nil, ::Hash, nil
302
327
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
303
328
  config_attr :quota_project, nil, ::String, nil
329
+ config_attr :universe_domain, nil, ::String, nil
304
330
 
305
331
  # @private
306
332
  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 get_system_policy REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module BinaryAuthorization
23
23
  module V1beta1
24
- VERSION = "0.11.0"
24
+ VERSION = "0.12.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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-binary_authorization-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.11.0
4
+ version: 0.12.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-12-04 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
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
223
223
  - !ruby/object:Gem::Version
224
224
  version: '0'
225
225
  requirements: []
226
- rubygems_version: 3.4.19
226
+ rubygems_version: 3.5.3
227
227
  signing_key:
228
228
  specification_version: 4
229
229
  summary: The management interface for Binary Authorization, a system providing policy