google-cloud-beyond_corp 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '02907bdd814831500a3b618ea7fc2bf4479ca0e87f0d59a7d49c03d2b228db3c'
4
- data.tar.gz: e18dd5ebdc7af39af6e7c501fde8151f41302015c3e9cdcbec2e440a1dd3f9bc
3
+ metadata.gz: 3ab82125dfdb50d8659c955c007dc72245351c2fbabc353ff8a2cebcdac5b58c
4
+ data.tar.gz: 6ac94814bc7f99a7af25845416e9d519006ca7ac50df61b2e85cfd2d2279d79d
5
5
  SHA512:
6
- metadata.gz: dc9324e0f25d9d2dfa659050bb7449f39bc234a4b10e525fc7a97794dd29e11687b20b4b2c7ec9d8697b50987bbc1b4522dd580e6793c167a1cc1bb7339a1f65
7
- data.tar.gz: cf98a680b4b584e987811ecaa419b64e53d30c50cee47cccf412f50125a2249116bdc498e952b98522f94fd08797d5ceb4cd9f8cb89055cd43ff764dbbb8f845
6
+ metadata.gz: 8e344a5ffb04bda23b492acfd7841ca3e303f9ad7a79d19f15a486cdb6359a979d0ed35db88a6d6891a253b781f0c763c1ddcf8643318c838314fa4249752201
7
+ data.tar.gz: 457d770a91a16f571e70af2a287b72ca7a7a318856ee659df8633733ac0a4bc7ede94e465bb74d04ab2157d46ad4724810ff04debeb686a7af80c87a96379d16
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-beyond_corp 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-beyond_corp library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/beyond_corp"
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::BeyondCorp::AppConnections.app_connections_service
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-beyond_corp 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-beyond_corp 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-beyond_corp
66
- checks for credentials are configured on the service Credentials class (such as
67
- `::Google::Cloud::BeyondCorp::AppConnections::V1::AppConnectionsService::Credentials`):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
72
41
 
73
- ```ruby
74
- require "google/cloud/beyond_corp"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = Google::Cloud::BeyondCorp::AppConnections.app_connections_service
79
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
80
49
 
81
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/beyond_corp"
88
58
 
89
59
  client = Google::Cloud::BeyondCorp::AppConnections.app_connections_service do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/beyond_corp"
98
68
 
99
69
  Google::Cloud::BeyondCorp::AppConnections.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = Google::Cloud::BeyondCorp::AppConnections.app_connections_service
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
111
82
 
112
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-beyond_corp
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/beyond_corp"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-beyond_corp.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = Google::Cloud::BeyondCorp::AppConnections.app_connections_service
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/README.md CHANGED
@@ -19,7 +19,6 @@ client gems:
19
19
  [google-cloud-beyond_corp-app_connections-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-app_connections-v1/latest),
20
20
  [google-cloud-beyond_corp-app_connectors-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-app_connectors-v1/latest),
21
21
  [google-cloud-beyond_corp-app_gateways-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-app_gateways-v1/latest),
22
- [google-cloud-beyond_corp-client_connector_services-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-client_connector_services-v1/latest),
23
22
  [google-cloud-beyond_corp-client_gateways-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-client_gateways-v1/latest).
24
23
 
25
24
  See also the [Product Documentation](https://cloud.google.com/beyondcorp/)
@@ -132,3 +131,4 @@ The `google-apis-` clients have wide coverage across Google services, so you
132
131
  might need to use one if there is no modern client available for the service.
133
132
  However, if a modern client is available, we generally recommend it over the
134
133
  older `google-apis-` clients.
134
+
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :beyond_corp_app_connections do |config|
32
- config.add_field! :endpoint, "beyondcorp.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :beyond_corp_app_connectors do |config|
32
- config.add_field! :endpoint, "beyondcorp.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :beyond_corp_app_gateways do |config|
32
- config.add_field! :endpoint, "beyondcorp.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -29,7 +29,7 @@ require "google/cloud/config"
29
29
 
30
30
  # Set the default configuration
31
31
  ::Google::Cloud.configure.add_config! :beyond_corp_client_gateways do |config|
32
- config.add_field! :endpoint, "beyondcorp.googleapis.com", match: ::String
32
+ config.add_field! :endpoint, nil, match: ::String
33
33
  config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
34
  config.add_field! :scope, nil, match: [::Array, ::String]
35
35
  config.add_field! :lib_name, nil, match: ::String
@@ -39,6 +39,7 @@ require "google/cloud/config"
39
39
  config.add_field! :metadata, nil, match: ::Hash
40
40
  config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
41
  config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
42
43
  end
43
44
 
44
45
  module Google
@@ -17,7 +17,7 @@
17
17
  module Google
18
18
  module Cloud
19
19
  module BeyondCorp
20
- VERSION = "1.0.0"
20
+ VERSION = "1.2.0"
21
21
  end
22
22
  end
23
23
  end
@@ -19,5 +19,4 @@
19
19
  require "google/cloud/beyond_corp" unless defined? Google::Cloud::BeyondCorp::VERSION
20
20
  require "google/cloud/beyond_corp/app_connectors" unless defined? Google::Cloud::BeyondCorp::AppConnectors::VERSION
21
21
  require "google/cloud/beyond_corp/app_gateways" unless defined? Google::Cloud::BeyondCorp::AppGateways::VERSION
22
- require "google/cloud/beyond_corp/client_connector_services" unless defined? Google::Cloud::BeyondCorp::ClientConnectorServices::VERSION
23
22
  require "google/cloud/beyond_corp/client_gateways" unless defined? Google::Cloud::BeyondCorp::ClientGateways::VERSION
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-beyond_corp
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.2.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-07-28 00:00:00.000000000 Z
11
+ date: 2024-02-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-beyond_corp-app_connections-v1
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.0'
19
+ version: '0.4'
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.0'
29
+ version: '0.4'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.0'
53
+ version: '0.4'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.0'
63
+ version: '0.4'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -70,7 +70,7 @@ dependencies:
70
70
  requirements:
71
71
  - - ">="
72
72
  - !ruby/object:Gem::Version
73
- version: '0.0'
73
+ version: '0.4'
74
74
  - - "<"
75
75
  - !ruby/object:Gem::Version
76
76
  version: 2.a
@@ -80,27 +80,7 @@ dependencies:
80
80
  requirements:
81
81
  - - ">="
82
82
  - !ruby/object:Gem::Version
83
- version: '0.0'
84
- - - "<"
85
- - !ruby/object:Gem::Version
86
- version: 2.a
87
- - !ruby/object:Gem::Dependency
88
- name: google-cloud-beyond_corp-client_connector_services-v1
89
- requirement: !ruby/object:Gem::Requirement
90
- requirements:
91
- - - ">="
92
- - !ruby/object:Gem::Version
93
- version: '0.0'
94
- - - "<"
95
- - !ruby/object:Gem::Version
96
- version: 2.a
97
- type: :runtime
98
- prerelease: false
99
- version_requirements: !ruby/object:Gem::Requirement
100
- requirements:
101
- - - ">="
102
- - !ruby/object:Gem::Version
103
- version: '0.0'
83
+ version: '0.4'
104
84
  - - "<"
105
85
  - !ruby/object:Gem::Version
106
86
  version: 2.a
@@ -110,7 +90,7 @@ dependencies:
110
90
  requirements:
111
91
  - - ">="
112
92
  - !ruby/object:Gem::Version
113
- version: '0.0'
93
+ version: '0.4'
114
94
  - - "<"
115
95
  - !ruby/object:Gem::Version
116
96
  version: 2.a
@@ -120,7 +100,7 @@ dependencies:
120
100
  requirements:
121
101
  - - ">="
122
102
  - !ruby/object:Gem::Version
123
- version: '0.0'
103
+ version: '0.4'
124
104
  - - "<"
125
105
  - !ruby/object:Gem::Version
126
106
  version: 2.a
@@ -257,8 +237,6 @@ files:
257
237
  - lib/google/cloud/beyond_corp/app_connectors/version.rb
258
238
  - lib/google/cloud/beyond_corp/app_gateways.rb
259
239
  - lib/google/cloud/beyond_corp/app_gateways/version.rb
260
- - lib/google/cloud/beyond_corp/client_connector_services.rb
261
- - lib/google/cloud/beyond_corp/client_connector_services/version.rb
262
240
  - lib/google/cloud/beyond_corp/client_gateways.rb
263
241
  - lib/google/cloud/beyond_corp/client_gateways/version.rb
264
242
  - lib/google/cloud/beyond_corp/version.rb
@@ -281,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
281
259
  - !ruby/object:Gem::Version
282
260
  version: '0'
283
261
  requirements: []
284
- rubygems_version: 3.4.2
262
+ rubygems_version: 3.5.3
285
263
  signing_key:
286
264
  specification_version: 4
287
265
  summary: API client library for the BeyondCorp API
@@ -1,29 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2022 Google LLC
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # https://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
-
20
- module Google
21
- module Cloud
22
- module BeyondCorp
23
- module ClientConnectorServices
24
- # @private Unused
25
- VERSION = ""
26
- end
27
- end
28
- end
29
- end
@@ -1,127 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2022 Google LLC
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # https://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
- # Require this file early so that the version constant gets defined before
20
- # requiring "google/cloud". This is because google-cloud-core will load the
21
- # entrypoint (gem name) file, which in turn re-requires this file (hence
22
- # causing a require cycle) unless the version constant is already defined.
23
- require "google/cloud/beyond_corp/client_connector_services/version"
24
-
25
- require "googleauth"
26
- gem "google-cloud-core"
27
- require "google/cloud" unless defined? ::Google::Cloud.new
28
- require "google/cloud/config"
29
-
30
- # Set the default configuration
31
- ::Google::Cloud.configure.add_config! :beyond_corp_client_connector_services do |config|
32
- config.add_field! :endpoint, "beyondcorp.googleapis.com", match: ::String
33
- config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
- config.add_field! :scope, nil, match: [::Array, ::String]
35
- config.add_field! :lib_name, nil, match: ::String
36
- config.add_field! :lib_version, nil, match: ::String
37
- config.add_field! :interceptors, nil, match: ::Array
38
- config.add_field! :timeout, nil, match: ::Numeric
39
- config.add_field! :metadata, nil, match: ::Hash
40
- config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
- config.add_field! :quota_project, nil, match: ::String
42
- end
43
-
44
- module Google
45
- module Cloud
46
- module BeyondCorp
47
- module ClientConnectorServices
48
- ##
49
- # Create a new client object for ClientConnectorServicesService.
50
- #
51
- # By default, this returns an instance of
52
- # [Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-client_connector_services-v1/latest/Google-Cloud-BeyondCorp-ClientConnectorServices-V1-ClientConnectorServicesService-Client)
53
- # for a gRPC client for version V1 of the API.
54
- # However, you can specify a different API version by passing it in the
55
- # `version` parameter. If the ClientConnectorServicesService service is
56
- # supported by that API version, and the corresponding gem is available, the
57
- # appropriate versioned client will be returned.
58
- #
59
- # ## About ClientConnectorServicesService
60
- #
61
- # API Overview:
62
- #
63
- # The `beyondcorp.googleapis.com` service implements the Google Cloud
64
- # BeyondCorp API.
65
- #
66
- # Data Model:
67
- #
68
- # The ClientConnectorServicesService exposes the following resources:
69
- #
70
- # * Client Connector Services, named as follows:
71
- # `projects/{project_id}/locations/{location_id}/client_connector_services/{client_connector_service_id}`.
72
- #
73
- # @param version [::String, ::Symbol] The API version to connect to. Optional.
74
- # Defaults to `:v1`.
75
- # @return [::Object] A client object for the specified version.
76
- #
77
- def self.client_connector_services_service version: :v1, &block
78
- require "google/cloud/beyond_corp/client_connector_services/#{version.to_s.downcase}"
79
-
80
- package_name = Google::Cloud::BeyondCorp::ClientConnectorServices
81
- .constants
82
- .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
83
- .first
84
- service_module = Google::Cloud::BeyondCorp::ClientConnectorServices.const_get(package_name).const_get(:ClientConnectorServicesService)
85
- service_module.const_get(:Client).new(&block)
86
- end
87
-
88
- ##
89
- # Configure the google-cloud-beyond_corp-client_connector_services library.
90
- #
91
- # The following configuration parameters are supported:
92
- #
93
- # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
94
- # The path to the keyfile as a String, the contents of the keyfile as a
95
- # Hash, or a Google::Auth::Credentials object.
96
- # * `lib_name` (*type:* `String`) -
97
- # The library name as recorded in instrumentation and logging.
98
- # * `lib_version` (*type:* `String`) -
99
- # The library version as recorded in instrumentation and logging.
100
- # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
101
- # An array of interceptors that are run before calls are executed.
102
- # * `timeout` (*type:* `Numeric`) -
103
- # Default timeout in seconds.
104
- # * `metadata` (*type:* `Hash{Symbol=>String}`) -
105
- # Additional headers to be sent with the call.
106
- # * `retry_policy` (*type:* `Hash`) -
107
- # The retry policy. The value is a hash with the following keys:
108
- # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
109
- # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
110
- # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
111
- # * `:retry_codes` (*type:* `Array<String>`) -
112
- # The error codes that should trigger a retry.
113
- #
114
- # @return [::Google::Cloud::Config] The default configuration used by this library
115
- #
116
- def self.configure
117
- yield ::Google::Cloud.configure.beyond_corp_client_connector_services if block_given?
118
-
119
- ::Google::Cloud.configure.beyond_corp_client_connector_services
120
- end
121
- end
122
- end
123
- end
124
- end
125
-
126
- helper_path = ::File.join __dir__, "client_connector_services", "helpers.rb"
127
- require "google/cloud/beyond_corp/client_connector_services/helpers" if ::File.file? helper_path