google-cloud-iot-v1 0.9.2 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -143
- data/lib/google/cloud/iot/v1/version.rb +3 -8
- metadata +15 -203
- data/.yardopts +0 -12
- data/AUTHENTICATION.md +0 -122
- data/lib/google/cloud/iot/v1/device_manager/client.rb +0 -2316
- data/lib/google/cloud/iot/v1/device_manager/credentials.rb +0 -52
- data/lib/google/cloud/iot/v1/device_manager/paths.rb +0 -90
- data/lib/google/cloud/iot/v1/device_manager/rest/client.rb +0 -2157
- data/lib/google/cloud/iot/v1/device_manager/rest/service_stub.rb +0 -1293
- data/lib/google/cloud/iot/v1/device_manager/rest.rb +0 -52
- data/lib/google/cloud/iot/v1/device_manager.rb +0 -55
- data/lib/google/cloud/iot/v1/device_manager_pb.rb +0 -77
- data/lib/google/cloud/iot/v1/device_manager_services_pb.rb +0 -102
- data/lib/google/cloud/iot/v1/resources_pb.rb +0 -68
- data/lib/google/cloud/iot/v1/rest.rb +0 -37
- data/lib/google/cloud/iot/v1.rb +0 -45
- data/lib/google-cloud-iot-v1.rb +0 -21
- data/proto_docs/README.md +0 -4
- data/proto_docs/google/api/client.rb +0 -395
- data/proto_docs/google/api/field_behavior.rb +0 -85
- data/proto_docs/google/api/launch_stage.rb +0 -71
- data/proto_docs/google/api/resource.rb +0 -222
- data/proto_docs/google/cloud/iot/v1/device_manager.rb +0 -399
- data/proto_docs/google/cloud/iot/v1/resources.rb +0 -517
- data/proto_docs/google/iam/v1/iam_policy.rb +0 -87
- data/proto_docs/google/iam/v1/options.rb +0 -50
- data/proto_docs/google/iam/v1/policy.rb +0 -426
- data/proto_docs/google/protobuf/any.rb +0 -145
- data/proto_docs/google/protobuf/duration.rb +0 -98
- data/proto_docs/google/protobuf/empty.rb +0 -34
- data/proto_docs/google/protobuf/field_mask.rb +0 -229
- data/proto_docs/google/protobuf/timestamp.rb +0 -127
- data/proto_docs/google/rpc/status.rb +0 -48
- data/proto_docs/google/type/expr.rb +0 -75
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 757ea2616690ccdfc1b565744c84b1c6970ec2ed09a07011a3730b8c508b63db
|
4
|
+
data.tar.gz: 15f4412365eeba96864bee71b9acb24da72cad8e13a7d89c32b83fc3b404ff2b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a1d81d4e9daac94d82132f106e821696489f29de2346a21e0cd7ec7d4ca70892b4d0aa984aca46a91f7d900907e03f7c79bf2cc4d0b59d730864d8168899517
|
7
|
+
data.tar.gz: 02e9216687355528756ca07904be544fb1003ba48d0916810adb33399fce6163463f6713663f32279030afe1c9c3be8bbc609951767400d021a0685eb411fbf9
|
data/README.md
CHANGED
@@ -1,144 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# Tombstone for Ruby gem google-cloud-iot-v1
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.
|
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 Cloud IoT V1 API. Most users should consider using
|
11
|
-
the main client gem,
|
12
|
-
[google-cloud-iot](https://rubygems.org/gems/google-cloud-iot).
|
13
|
-
See the section below titled *Which client should I use?* for more information.
|
14
|
-
|
15
|
-
## Installation
|
16
|
-
|
17
|
-
```
|
18
|
-
$ gem install google-cloud-iot-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/cloudiot.googleapis.com)
|
28
|
-
1. {file:AUTHENTICATION.md Set up authentication.}
|
29
|
-
|
30
|
-
## Quick Start
|
31
|
-
|
32
|
-
```ruby
|
33
|
-
require "google/cloud/iot/v1"
|
34
|
-
|
35
|
-
client = ::Google::Cloud::Iot::V1::DeviceManager::Client.new
|
36
|
-
request = ::Google::Cloud::Iot::V1::CreateDeviceRegistryRequest.new # (request fields as keyword arguments...)
|
37
|
-
response = client.create_device_registry request
|
38
|
-
```
|
39
|
-
|
40
|
-
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-iot-v1/latest)
|
41
|
-
for class and method documentation.
|
42
|
-
|
43
|
-
See also the [Product Documentation](https://cloud.google.com/iot)
|
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-iot`,
|
92
|
-
and lower-level _versioned_ client libraries with names such as
|
93
|
-
`google-cloud-iot-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-iot`.
|
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-iot-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
|
-
#
|
2
|
-
|
3
|
-
# Copyright 2020 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
|
-
#
|
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,14 +12,11 @@
|
|
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 Iot
|
23
18
|
module V1
|
24
|
-
VERSION = "0.
|
19
|
+
VERSION = "1.0.0"
|
25
20
|
end
|
26
21
|
end
|
27
22
|
end
|
metadata
CHANGED
@@ -1,224 +1,37 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-iot-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
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-
|
12
|
-
dependencies:
|
13
|
-
|
14
|
-
|
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: grpc-google-iam-v1
|
49
|
-
requirement: !ruby/object:Gem::Requirement
|
50
|
-
requirements:
|
51
|
-
- - "~>"
|
52
|
-
- !ruby/object:Gem::Version
|
53
|
-
version: '1.1'
|
54
|
-
type: :runtime
|
55
|
-
prerelease: false
|
56
|
-
version_requirements: !ruby/object:Gem::Requirement
|
57
|
-
requirements:
|
58
|
-
- - "~>"
|
59
|
-
- !ruby/object:Gem::Version
|
60
|
-
version: '1.1'
|
61
|
-
- !ruby/object:Gem::Dependency
|
62
|
-
name: google-style
|
63
|
-
requirement: !ruby/object:Gem::Requirement
|
64
|
-
requirements:
|
65
|
-
- - "~>"
|
66
|
-
- !ruby/object:Gem::Version
|
67
|
-
version: 1.26.3
|
68
|
-
type: :development
|
69
|
-
prerelease: false
|
70
|
-
version_requirements: !ruby/object:Gem::Requirement
|
71
|
-
requirements:
|
72
|
-
- - "~>"
|
73
|
-
- !ruby/object:Gem::Version
|
74
|
-
version: 1.26.3
|
75
|
-
- !ruby/object:Gem::Dependency
|
76
|
-
name: minitest
|
77
|
-
requirement: !ruby/object:Gem::Requirement
|
78
|
-
requirements:
|
79
|
-
- - "~>"
|
80
|
-
- !ruby/object:Gem::Version
|
81
|
-
version: '5.16'
|
82
|
-
type: :development
|
83
|
-
prerelease: false
|
84
|
-
version_requirements: !ruby/object:Gem::Requirement
|
85
|
-
requirements:
|
86
|
-
- - "~>"
|
87
|
-
- !ruby/object:Gem::Version
|
88
|
-
version: '5.16'
|
89
|
-
- !ruby/object:Gem::Dependency
|
90
|
-
name: minitest-focus
|
91
|
-
requirement: !ruby/object:Gem::Requirement
|
92
|
-
requirements:
|
93
|
-
- - "~>"
|
94
|
-
- !ruby/object:Gem::Version
|
95
|
-
version: '1.1'
|
96
|
-
type: :development
|
97
|
-
prerelease: false
|
98
|
-
version_requirements: !ruby/object:Gem::Requirement
|
99
|
-
requirements:
|
100
|
-
- - "~>"
|
101
|
-
- !ruby/object:Gem::Version
|
102
|
-
version: '1.1'
|
103
|
-
- !ruby/object:Gem::Dependency
|
104
|
-
name: minitest-rg
|
105
|
-
requirement: !ruby/object:Gem::Requirement
|
106
|
-
requirements:
|
107
|
-
- - "~>"
|
108
|
-
- !ruby/object:Gem::Version
|
109
|
-
version: '5.2'
|
110
|
-
type: :development
|
111
|
-
prerelease: false
|
112
|
-
version_requirements: !ruby/object:Gem::Requirement
|
113
|
-
requirements:
|
114
|
-
- - "~>"
|
115
|
-
- !ruby/object:Gem::Version
|
116
|
-
version: '5.2'
|
117
|
-
- !ruby/object:Gem::Dependency
|
118
|
-
name: rake
|
119
|
-
requirement: !ruby/object:Gem::Requirement
|
120
|
-
requirements:
|
121
|
-
- - ">="
|
122
|
-
- !ruby/object:Gem::Version
|
123
|
-
version: '13.0'
|
124
|
-
type: :development
|
125
|
-
prerelease: false
|
126
|
-
version_requirements: !ruby/object:Gem::Requirement
|
127
|
-
requirements:
|
128
|
-
- - ">="
|
129
|
-
- !ruby/object:Gem::Version
|
130
|
-
version: '13.0'
|
131
|
-
- !ruby/object:Gem::Dependency
|
132
|
-
name: redcarpet
|
133
|
-
requirement: !ruby/object:Gem::Requirement
|
134
|
-
requirements:
|
135
|
-
- - "~>"
|
136
|
-
- !ruby/object:Gem::Version
|
137
|
-
version: '3.0'
|
138
|
-
type: :development
|
139
|
-
prerelease: false
|
140
|
-
version_requirements: !ruby/object:Gem::Requirement
|
141
|
-
requirements:
|
142
|
-
- - "~>"
|
143
|
-
- !ruby/object:Gem::Version
|
144
|
-
version: '3.0'
|
145
|
-
- !ruby/object:Gem::Dependency
|
146
|
-
name: simplecov
|
147
|
-
requirement: !ruby/object:Gem::Requirement
|
148
|
-
requirements:
|
149
|
-
- - "~>"
|
150
|
-
- !ruby/object:Gem::Version
|
151
|
-
version: '0.18'
|
152
|
-
type: :development
|
153
|
-
prerelease: false
|
154
|
-
version_requirements: !ruby/object:Gem::Requirement
|
155
|
-
requirements:
|
156
|
-
- - "~>"
|
157
|
-
- !ruby/object:Gem::Version
|
158
|
-
version: '0.18'
|
159
|
-
- !ruby/object:Gem::Dependency
|
160
|
-
name: yard
|
161
|
-
requirement: !ruby/object:Gem::Requirement
|
162
|
-
requirements:
|
163
|
-
- - "~>"
|
164
|
-
- !ruby/object:Gem::Version
|
165
|
-
version: '0.9'
|
166
|
-
type: :development
|
167
|
-
prerelease: false
|
168
|
-
version_requirements: !ruby/object:Gem::Requirement
|
169
|
-
requirements:
|
170
|
-
- - "~>"
|
171
|
-
- !ruby/object:Gem::Version
|
172
|
-
version: '0.9'
|
173
|
-
description: Registers and manages IoT (Internet of Things) devices that connect to
|
174
|
-
the Google Cloud Platform. Note that google-cloud-iot-v1 is a version-specific client
|
175
|
-
library. For most uses, we recommend installing the main client library google-cloud-iot
|
176
|
-
instead. See the readme for more details.
|
11
|
+
date: 2024-02-07 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.
|
177
15
|
email: googleapis-packages@google.com
|
178
16
|
executables: []
|
179
17
|
extensions: []
|
180
18
|
extra_rdoc_files: []
|
181
19
|
files:
|
182
|
-
- ".yardopts"
|
183
|
-
- AUTHENTICATION.md
|
184
20
|
- LICENSE.md
|
185
21
|
- README.md
|
186
|
-
- lib/google-cloud-iot-v1.rb
|
187
|
-
- lib/google/cloud/iot/v1.rb
|
188
|
-
- lib/google/cloud/iot/v1/device_manager.rb
|
189
|
-
- lib/google/cloud/iot/v1/device_manager/client.rb
|
190
|
-
- lib/google/cloud/iot/v1/device_manager/credentials.rb
|
191
|
-
- lib/google/cloud/iot/v1/device_manager/paths.rb
|
192
|
-
- lib/google/cloud/iot/v1/device_manager/rest.rb
|
193
|
-
- lib/google/cloud/iot/v1/device_manager/rest/client.rb
|
194
|
-
- lib/google/cloud/iot/v1/device_manager/rest/service_stub.rb
|
195
|
-
- lib/google/cloud/iot/v1/device_manager_pb.rb
|
196
|
-
- lib/google/cloud/iot/v1/device_manager_services_pb.rb
|
197
|
-
- lib/google/cloud/iot/v1/resources_pb.rb
|
198
|
-
- lib/google/cloud/iot/v1/rest.rb
|
199
22
|
- lib/google/cloud/iot/v1/version.rb
|
200
|
-
- proto_docs/README.md
|
201
|
-
- proto_docs/google/api/client.rb
|
202
|
-
- proto_docs/google/api/field_behavior.rb
|
203
|
-
- proto_docs/google/api/launch_stage.rb
|
204
|
-
- proto_docs/google/api/resource.rb
|
205
|
-
- proto_docs/google/cloud/iot/v1/device_manager.rb
|
206
|
-
- proto_docs/google/cloud/iot/v1/resources.rb
|
207
|
-
- proto_docs/google/iam/v1/iam_policy.rb
|
208
|
-
- proto_docs/google/iam/v1/options.rb
|
209
|
-
- proto_docs/google/iam/v1/policy.rb
|
210
|
-
- proto_docs/google/protobuf/any.rb
|
211
|
-
- proto_docs/google/protobuf/duration.rb
|
212
|
-
- proto_docs/google/protobuf/empty.rb
|
213
|
-
- proto_docs/google/protobuf/field_mask.rb
|
214
|
-
- proto_docs/google/protobuf/timestamp.rb
|
215
|
-
- proto_docs/google/rpc/status.rb
|
216
|
-
- proto_docs/google/type/expr.rb
|
217
23
|
homepage: https://github.com/googleapis/google-cloud-ruby
|
218
24
|
licenses:
|
219
25
|
- Apache-2.0
|
220
26
|
metadata: {}
|
221
|
-
post_install_message:
|
27
|
+
post_install_message: |2+
|
28
|
+
|
29
|
+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
30
|
+
The google-cloud-iot-v1 gem is OBSOLETE.
|
31
|
+
For more information, see:
|
32
|
+
https://cloud.google.com/terms/deprecation
|
33
|
+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
34
|
+
|
222
35
|
rdoc_options: []
|
223
36
|
require_paths:
|
224
37
|
- lib
|
@@ -226,7 +39,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
226
39
|
requirements:
|
227
40
|
- - ">="
|
228
41
|
- !ruby/object:Gem::Version
|
229
|
-
version: '2.
|
42
|
+
version: '2.0'
|
230
43
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
231
44
|
requirements:
|
232
45
|
- - ">="
|
@@ -236,6 +49,5 @@ requirements: []
|
|
236
49
|
rubygems_version: 3.5.3
|
237
50
|
signing_key:
|
238
51
|
specification_version: 4
|
239
|
-
summary:
|
240
|
-
Google Cloud Platform.
|
52
|
+
summary: This gem is obsolete because the related backend is turned down.
|
241
53
|
test_files: []
|
data/.yardopts
DELETED
data/AUTHENTICATION.md
DELETED
@@ -1,122 +0,0 @@
|
|
1
|
-
# Authentication
|
2
|
-
|
3
|
-
The recommended way to authenticate to the google-cloud-iot-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-iot-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/iot/v1"
|
58
|
-
|
59
|
-
client = ::Google::Cloud::Iot::V1::DeviceManager::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/iot/v1"
|
68
|
-
|
69
|
-
::Google::Cloud::Iot::V1::DeviceManager::Client.configure do |config|
|
70
|
-
config.credentials = "path/to/credentialfile.json"
|
71
|
-
end
|
72
|
-
|
73
|
-
client = ::Google::Cloud::Iot::V1::DeviceManager::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-iot-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/iot/v1"
|
100
|
-
|
101
|
-
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
102
|
-
|
103
|
-
client = ::Google::Cloud::Iot::V1::DeviceManager::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).
|