google-cloud-beyond_corp-client_connector_services-v1 0.4.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -143
  3. data/lib/google/cloud/beyond_corp/client_connector_services/v1/version.rb +3 -8
  4. metadata +15 -226
  5. data/.yardopts +0 -12
  6. data/AUTHENTICATION.md +0 -122
  7. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/client.rb +0 -954
  8. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/credentials.rb +0 -49
  9. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/operations.rb +0 -803
  10. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/paths.rb +0 -71
  11. data/lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service.rb +0 -62
  12. data/lib/google/cloud/beyond_corp/client_connector_services/v1.rb +0 -42
  13. data/lib/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service_pb.rb +0 -68
  14. data/lib/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service_services_pb.rb +0 -65
  15. data/lib/google-cloud-beyond_corp-client_connector_services-v1.rb +0 -21
  16. data/proto_docs/README.md +0 -4
  17. data/proto_docs/google/api/client.rb +0 -395
  18. data/proto_docs/google/api/field_behavior.rb +0 -85
  19. data/proto_docs/google/api/launch_stage.rb +0 -71
  20. data/proto_docs/google/api/resource.rb +0 -222
  21. data/proto_docs/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.rb +0 -336
  22. data/proto_docs/google/longrunning/operations.rb +0 -164
  23. data/proto_docs/google/protobuf/any.rb +0 -145
  24. data/proto_docs/google/protobuf/duration.rb +0 -98
  25. data/proto_docs/google/protobuf/empty.rb +0 -34
  26. data/proto_docs/google/protobuf/field_mask.rb +0 -229
  27. data/proto_docs/google/protobuf/timestamp.rb +0 -127
  28. data/proto_docs/google/rpc/status.rb +0 -48
  29. data/proto_docs/google/type/expr.rb +0 -75
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d59652a2715cd73f52ea2336a79d16cbbd0b26abadf6d223a4942e98bc9a100d
4
- data.tar.gz: d268f079a50ea1454f07786e1f725bff1dd38ded26e69f38a661bb0c495c2e24
3
+ metadata.gz: 7dfb32d4301b0c596ab0ff39ca105a7f8bb58b29ee7aa027e2a36f937742e669
4
+ data.tar.gz: 488ed35a8f73427ab02bc7e1c616c4cf9a7471e1225965d7e0c502b1232a5b3b
5
5
  SHA512:
6
- metadata.gz: 7a19314d6cfa8c8f64986a6429cc2427b4745a74a0283722ce2e1c893575425d91269d033f7aa2f9b48be986c4264eeaabd7d906db1bd3d62034e349bfaab9fd
7
- data.tar.gz: '0992729eeaf6243ba4eb488133cf2e04244d25fa2d3d19516bf6962a571b6ead649ca2d3a8233fbfe536099521a7610dd9ec480a8f7d8d10317dc7a25fc28ac0'
6
+ metadata.gz: 00ae36847d77c40397373fc731627804c14b5d18256ed68b5d1d0fdc9fceb143d1a3aaa3ac34c7408e44e1fe867290db85e15599ed6a69b51992d103e5cf19d8
7
+ data.tar.gz: 786b7cc07ba8b35f38376758194bf92f8b72c0c362ad1652342740da78501cabf69abc869d638a34fdad7b0ca65fca1a58c00a6ceea388f1c830e78882d471df
data/README.md CHANGED
@@ -1,144 +1,4 @@
1
- # Ruby Client for the BeyondCorp ClientConnectorServices V1 API
1
+ # Tombstone for Ruby gem google-cloud-beyond_corp-client_connector_services-v1
2
2
 
3
- Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity using the App Connector hybrid connectivity solution.
4
-
5
- Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity using the App Connector hybrid connectivity solution.
6
-
7
- https://github.com/googleapis/google-cloud-ruby
8
-
9
- This gem is a _versioned_ client. It provides basic client classes for a
10
- specific version of the BeyondCorp ClientConnectorServices V1 API. Most users should consider using
11
- the main client gem,
12
- [google-cloud-beyond_corp](https://rubygems.org/gems/google-cloud-beyond_corp).
13
- See the section below titled *Which client should I use?* for more information.
14
-
15
- ## Installation
16
-
17
- ```
18
- $ gem install google-cloud-beyond_corp-client_connector_services-v1
19
- ```
20
-
21
- ## Before You Begin
22
-
23
- In order to use this library, you first need to go through the following steps:
24
-
25
- 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
26
- 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
27
- 1. [Enable the API.](https://console.cloud.google.com/apis/library/beyondcorp.googleapis.com)
28
- 1. {file:AUTHENTICATION.md Set up authentication.}
29
-
30
- ## Quick Start
31
-
32
- ```ruby
33
- require "google/cloud/beyond_corp/client_connector_services/v1"
34
-
35
- client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
36
- request = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ListClientConnectorServicesRequest.new # (request fields as keyword arguments...)
37
- response = client.list_client_connector_services request
38
- ```
39
-
40
- View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-client_connector_services-v1/latest)
41
- for class and method documentation.
42
-
43
- See also the [Product Documentation](https://cloud.google.com/beyondcorp/)
44
- for general usage information.
45
-
46
- ## Enabling Logging
47
-
48
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
-
54
- Configuring a Ruby stdlib logger:
55
-
56
- ```ruby
57
- require "logger"
58
-
59
- module MyLogger
60
- LOGGER = Logger.new $stderr, level: Logger::WARN
61
- def logger
62
- LOGGER
63
- end
64
- end
65
-
66
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
- module GRPC
68
- extend MyLogger
69
- end
70
- ```
71
-
72
-
73
- ## Google Cloud Samples
74
-
75
- To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
-
77
- ## Supported Ruby Versions
78
-
79
- This library is supported on Ruby 2.6+.
80
-
81
- Google provides official support for Ruby versions that are actively supported
82
- by Ruby Core—that is, Ruby versions that are either in normal maintenance or
83
- in security maintenance, and not end of life. Older versions of Ruby _may_
84
- still work, but are unsupported and not recommended. See
85
- https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
86
- support schedule.
87
-
88
- ## Which client should I use?
89
-
90
- Most modern Ruby client libraries for Google APIs come in two flavors: the main
91
- client library with a name such as `google-cloud-beyond_corp`,
92
- and lower-level _versioned_ client libraries with names such as
93
- `google-cloud-beyond_corp-client_connector_services-v1`.
94
- _In most cases, you should install the main client._
95
-
96
- ### What's the difference between the main client and a versioned client?
97
-
98
- A _versioned client_ provides a basic set of data types and client classes for
99
- a _single version_ of a specific service. (That is, for a service with multiple
100
- versions, there might be a separate versioned client for each service version.)
101
- Most versioned clients are written and maintained by a code generator.
102
-
103
- The _main client_ is designed to provide you with the _recommended_ client
104
- interfaces for the service. There will be only one main client for any given
105
- service, even a service with multiple versions. The main client includes
106
- factory methods for constructing the client objects we recommend for most
107
- users. In some cases, those will be classes provided by an underlying versioned
108
- client; in other cases, they will be handwritten higher-level client objects
109
- with additional capabilities, convenience methods, or best practices built in.
110
- Generally, the main client will default to a recommended service version,
111
- although in some cases you can override this if you need to talk to a specific
112
- service version.
113
-
114
- ### Why would I want to use the main client?
115
-
116
- We recommend that most users install the main client gem for a service. You can
117
- identify this gem as the one _without_ a version in its name, e.g.
118
- `google-cloud-beyond_corp`.
119
- The main client is recommended because it will embody the best practices for
120
- accessing the service, and may also provide more convenient interfaces or
121
- tighter integration into frameworks and third-party libraries. In addition, the
122
- documentation and samples published by Google will generally demonstrate use of
123
- the main client.
124
-
125
- ### Why would I want to use a versioned client?
126
-
127
- You can use a versioned client if you are content with a possibly lower-level
128
- class interface, you explicitly want to avoid features provided by the main
129
- client, or you want to access a specific service version not be covered by the
130
- main client. You can identify versioned client gems because the service version
131
- is part of the name, e.g. `google-cloud-beyond_corp-client_connector_services-v1`.
132
-
133
- ### What about the google-apis-<name> clients?
134
-
135
- Client library gems with names that begin with `google-apis-` are based on an
136
- older code generation technology. They talk to a REST/JSON backend (whereas
137
- most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
138
- not offer the same performance, features, and ease of use provided by more
139
- modern clients.
140
-
141
- The `google-apis-` clients have wide coverage across Google services, so you
142
- might need to use one if there is no modern client available for the service.
143
- However, if a modern client is available, we generally recommend it over the
144
- older `google-apis-` clients.
3
+ This gem is obsolete because the related Google backend is turned down.
4
+ For more information, see https://cloud.google.com/terms/deprecation.
@@ -1,12 +1,10 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2022 Google LLC
1
+ # Copyright 2024 Google LLC
4
2
  #
5
3
  # Licensed under the Apache License, Version 2.0 (the "License");
6
4
  # you may not use this file except in compliance with the License.
7
5
  # You may obtain a copy of the License at
8
6
  #
9
- # https://www.apache.org/licenses/LICENSE-2.0
7
+ # http://www.apache.org/licenses/LICENSE-2.0
10
8
  #
11
9
  # Unless required by applicable law or agreed to in writing, software
12
10
  # distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,15 +12,12 @@
14
12
  # See the License for the specific language governing permissions and
15
13
  # limitations under the License.
16
14
 
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
-
20
15
  module Google
21
16
  module Cloud
22
17
  module BeyondCorp
23
18
  module ClientConnectorServices
24
19
  module V1
25
- VERSION = "0.4.2"
20
+ VERSION = "1.0.0"
26
21
  end
27
22
  end
28
23
  end
metadata CHANGED
@@ -1,245 +1,37 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-beyond_corp-client_connector_services-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
4
+ version: 1.0.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: 2024-02-01 00:00:00.000000000 Z
12
- dependencies:
13
- - !ruby/object:Gem::Dependency
14
- name: gapic-common
15
- requirement: !ruby/object:Gem::Requirement
16
- requirements:
17
- - - ">="
18
- - !ruby/object:Gem::Version
19
- version: 0.21.1
20
- - - "<"
21
- - !ruby/object:Gem::Version
22
- version: 2.a
23
- type: :runtime
24
- prerelease: false
25
- version_requirements: !ruby/object:Gem::Requirement
26
- requirements:
27
- - - ">="
28
- - !ruby/object:Gem::Version
29
- version: 0.21.1
30
- - - "<"
31
- - !ruby/object:Gem::Version
32
- version: 2.a
33
- - !ruby/object:Gem::Dependency
34
- name: google-cloud-errors
35
- requirement: !ruby/object:Gem::Requirement
36
- requirements:
37
- - - "~>"
38
- - !ruby/object:Gem::Version
39
- version: '1.0'
40
- type: :runtime
41
- prerelease: false
42
- version_requirements: !ruby/object:Gem::Requirement
43
- requirements:
44
- - - "~>"
45
- - !ruby/object:Gem::Version
46
- version: '1.0'
47
- - !ruby/object:Gem::Dependency
48
- name: google-cloud-location
49
- requirement: !ruby/object:Gem::Requirement
50
- requirements:
51
- - - ">="
52
- - !ruby/object:Gem::Version
53
- version: '0.7'
54
- - - "<"
55
- - !ruby/object:Gem::Version
56
- version: 2.a
57
- type: :runtime
58
- prerelease: false
59
- version_requirements: !ruby/object:Gem::Requirement
60
- requirements:
61
- - - ">="
62
- - !ruby/object:Gem::Version
63
- version: '0.7'
64
- - - "<"
65
- - !ruby/object:Gem::Version
66
- version: 2.a
67
- - !ruby/object:Gem::Dependency
68
- name: google-iam-v1
69
- requirement: !ruby/object:Gem::Requirement
70
- requirements:
71
- - - ">="
72
- - !ruby/object:Gem::Version
73
- version: '0.7'
74
- - - "<"
75
- - !ruby/object:Gem::Version
76
- version: 2.a
77
- type: :runtime
78
- prerelease: false
79
- version_requirements: !ruby/object:Gem::Requirement
80
- requirements:
81
- - - ">="
82
- - !ruby/object:Gem::Version
83
- version: '0.7'
84
- - - "<"
85
- - !ruby/object:Gem::Version
86
- version: 2.a
87
- - !ruby/object:Gem::Dependency
88
- name: google-style
89
- requirement: !ruby/object:Gem::Requirement
90
- requirements:
91
- - - "~>"
92
- - !ruby/object:Gem::Version
93
- version: 1.26.3
94
- type: :development
95
- prerelease: false
96
- version_requirements: !ruby/object:Gem::Requirement
97
- requirements:
98
- - - "~>"
99
- - !ruby/object:Gem::Version
100
- version: 1.26.3
101
- - !ruby/object:Gem::Dependency
102
- name: minitest
103
- requirement: !ruby/object:Gem::Requirement
104
- requirements:
105
- - - "~>"
106
- - !ruby/object:Gem::Version
107
- version: '5.16'
108
- type: :development
109
- prerelease: false
110
- version_requirements: !ruby/object:Gem::Requirement
111
- requirements:
112
- - - "~>"
113
- - !ruby/object:Gem::Version
114
- version: '5.16'
115
- - !ruby/object:Gem::Dependency
116
- name: minitest-focus
117
- requirement: !ruby/object:Gem::Requirement
118
- requirements:
119
- - - "~>"
120
- - !ruby/object:Gem::Version
121
- version: '1.1'
122
- type: :development
123
- prerelease: false
124
- version_requirements: !ruby/object:Gem::Requirement
125
- requirements:
126
- - - "~>"
127
- - !ruby/object:Gem::Version
128
- version: '1.1'
129
- - !ruby/object:Gem::Dependency
130
- name: minitest-rg
131
- requirement: !ruby/object:Gem::Requirement
132
- requirements:
133
- - - "~>"
134
- - !ruby/object:Gem::Version
135
- version: '5.2'
136
- type: :development
137
- prerelease: false
138
- version_requirements: !ruby/object:Gem::Requirement
139
- requirements:
140
- - - "~>"
141
- - !ruby/object:Gem::Version
142
- version: '5.2'
143
- - !ruby/object:Gem::Dependency
144
- name: rake
145
- requirement: !ruby/object:Gem::Requirement
146
- requirements:
147
- - - ">="
148
- - !ruby/object:Gem::Version
149
- version: '13.0'
150
- type: :development
151
- prerelease: false
152
- version_requirements: !ruby/object:Gem::Requirement
153
- requirements:
154
- - - ">="
155
- - !ruby/object:Gem::Version
156
- version: '13.0'
157
- - !ruby/object:Gem::Dependency
158
- name: redcarpet
159
- requirement: !ruby/object:Gem::Requirement
160
- requirements:
161
- - - "~>"
162
- - !ruby/object:Gem::Version
163
- version: '3.0'
164
- type: :development
165
- prerelease: false
166
- version_requirements: !ruby/object:Gem::Requirement
167
- requirements:
168
- - - "~>"
169
- - !ruby/object:Gem::Version
170
- version: '3.0'
171
- - !ruby/object:Gem::Dependency
172
- name: simplecov
173
- requirement: !ruby/object:Gem::Requirement
174
- requirements:
175
- - - "~>"
176
- - !ruby/object:Gem::Version
177
- version: '0.18'
178
- type: :development
179
- prerelease: false
180
- version_requirements: !ruby/object:Gem::Requirement
181
- requirements:
182
- - - "~>"
183
- - !ruby/object:Gem::Version
184
- version: '0.18'
185
- - !ruby/object:Gem::Dependency
186
- name: yard
187
- requirement: !ruby/object:Gem::Requirement
188
- requirements:
189
- - - "~>"
190
- - !ruby/object:Gem::Version
191
- version: '0.9'
192
- type: :development
193
- prerelease: false
194
- version_requirements: !ruby/object:Gem::Requirement
195
- requirements:
196
- - - "~>"
197
- - !ruby/object:Gem::Version
198
- version: '0.9'
199
- description: Beyondcorp Enterprise provides identity and context aware access controls
200
- for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise
201
- APIs, enterprises can set up multi-cloud and on-prem connectivity using the App
202
- Connector hybrid connectivity solution. Note that google-cloud-beyond_corp-client_connector_services-v1
203
- is a version-specific client library. For most uses, we recommend installing the
204
- main client library google-cloud-beyond_corp instead. See the readme for more details.
11
+ date: 2024-02-12 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: This gem is obsolete because the related Google backend is turned down.
14
+ For more information, see https://cloud.google.com/terms/deprecation.
205
15
  email: googleapis-packages@google.com
206
16
  executables: []
207
17
  extensions: []
208
18
  extra_rdoc_files: []
209
19
  files:
210
- - ".yardopts"
211
- - AUTHENTICATION.md
212
20
  - LICENSE.md
213
21
  - README.md
214
- - lib/google-cloud-beyond_corp-client_connector_services-v1.rb
215
- - lib/google/cloud/beyond_corp/client_connector_services/v1.rb
216
- - lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service.rb
217
- - lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/client.rb
218
- - lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/credentials.rb
219
- - lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/operations.rb
220
- - lib/google/cloud/beyond_corp/client_connector_services/v1/client_connector_services_service/paths.rb
221
22
  - lib/google/cloud/beyond_corp/client_connector_services/v1/version.rb
222
- - lib/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service_pb.rb
223
- - lib/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service_services_pb.rb
224
- - proto_docs/README.md
225
- - proto_docs/google/api/client.rb
226
- - proto_docs/google/api/field_behavior.rb
227
- - proto_docs/google/api/launch_stage.rb
228
- - proto_docs/google/api/resource.rb
229
- - proto_docs/google/cloud/beyondcorp/clientconnectorservices/v1/client_connector_services_service.rb
230
- - proto_docs/google/longrunning/operations.rb
231
- - proto_docs/google/protobuf/any.rb
232
- - proto_docs/google/protobuf/duration.rb
233
- - proto_docs/google/protobuf/empty.rb
234
- - proto_docs/google/protobuf/field_mask.rb
235
- - proto_docs/google/protobuf/timestamp.rb
236
- - proto_docs/google/rpc/status.rb
237
- - proto_docs/google/type/expr.rb
238
23
  homepage: https://github.com/googleapis/google-cloud-ruby
239
24
  licenses:
240
25
  - Apache-2.0
241
26
  metadata: {}
242
- post_install_message:
27
+ post_install_message: |2+
28
+
29
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
30
+ The google-cloud-beyond_corp-client_connector_services-v1 gem is OBSOLETE.
31
+ For more information, see:
32
+ https://cloud.google.com/terms/deprecation
33
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
34
+
243
35
  rdoc_options: []
244
36
  require_paths:
245
37
  - lib
@@ -247,7 +39,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
247
39
  requirements:
248
40
  - - ">="
249
41
  - !ruby/object:Gem::Version
250
- version: '2.6'
42
+ version: '2.0'
251
43
  required_rubygems_version: !ruby/object:Gem::Requirement
252
44
  requirements:
253
45
  - - ">="
@@ -257,8 +49,5 @@ requirements: []
257
49
  rubygems_version: 3.5.3
258
50
  signing_key:
259
51
  specification_version: 4
260
- summary: Beyondcorp Enterprise provides identity and context aware access controls
261
- for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise
262
- APIs, enterprises can set up multi-cloud and on-prem connectivity using the App
263
- Connector hybrid connectivity solution.
52
+ summary: This gem is obsolete because the related backend is turned down.
264
53
  test_files: []
data/.yardopts DELETED
@@ -1,12 +0,0 @@
1
- --no-private
2
- --title="BeyondCorp ClientConnectorServices V1 API"
3
- --exclude _pb\.rb$
4
- --markup markdown
5
- --markup-provider redcarpet
6
-
7
- ./lib/**/*.rb
8
- ./proto_docs/**/*.rb
9
- -
10
- README.md
11
- LICENSE.md
12
- AUTHENTICATION.md
data/AUTHENTICATION.md DELETED
@@ -1,122 +0,0 @@
1
- # Authentication
2
-
3
- The recommended way to authenticate to the google-cloud-beyond_corp-client_connector_services-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).
6
-
7
- ## Quickstart
8
-
9
- The following example shows how to set up authentication for a local development
10
- environment with your user credentials.
11
-
12
- **NOTE:** This method is _not_ recommended for running in production. User credentials
13
- should be used only during development.
14
-
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:
17
-
18
- ```sh
19
- gcloud auth application-default login
20
- ```
21
-
22
- 3. Write code as if already authenticated.
23
-
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).
26
-
27
- ## Credential Lookup
28
-
29
- The google-cloud-beyond_corp-client_connector_services-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.
33
-
34
- Credentials are accepted in the following ways, in the following order or precedence:
35
-
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)
41
-
42
- ### Configuration
43
-
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).
49
-
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.
53
-
54
- To configure a credentials file for an individual client initialization:
55
-
56
- ```ruby
57
- require "google/cloud/beyond_corp/client_connector_services/v1"
58
-
59
- client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new do |config|
60
- config.credentials = "path/to/credentialfile.json"
61
- end
62
- ```
63
-
64
- To configure a credentials file globally for all clients:
65
-
66
- ```ruby
67
- require "google/cloud/beyond_corp/client_connector_services/v1"
68
-
69
- ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.configure do |config|
70
- config.credentials = "path/to/credentialfile.json"
71
- end
72
-
73
- client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
74
- ```
75
-
76
- ### Environment Variables
77
-
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.
82
-
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).
87
-
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-client_connector_services-v1
93
- checks for credentials are:
94
-
95
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
97
-
98
- ```ruby
99
- require "google/cloud/beyond_corp/client_connector_services/v1"
100
-
101
- ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
102
-
103
- client = ::Google::Cloud::BeyondCorp::ClientConnectorServices::V1::ClientConnectorServicesService::Client.new
104
- ```
105
-
106
- ### Local ADC file
107
-
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.
111
-
112
- Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
113
-
114
- ### Google Cloud Platform environments
115
-
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.
120
-
121
- For more information, see
122
- [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).