google-cloud-device_streaming 0.1.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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 7ddf70cd75a8faf55b51c5d554eb9525a2397e33ca4f7cf77b7efa56ce9a8332
4
+ data.tar.gz: e176b716535c4eba738c97fdf862922c3563ac577a0604e24ba270fcd64ce306
5
+ SHA512:
6
+ metadata.gz: 45ad53b2c2d304a186c0a47e67592e6e2862542ac7707c703dcc09e6e8a2d99da6af9e44b79ef4dac0730567a6bac1c45368b082ebd989db91d509c82956bb44
7
+ data.tar.gz: 4977c55d71fd8c899c77e9b93c34cf43f0d34cb65c7cb0874e7ac3769f4109a6c4264bbe9afbb951726e273a45217871a0d9d619c9acbc2d14d4a153721d1f99
data/.yardopts ADDED
@@ -0,0 +1,11 @@
1
+ --no-private
2
+ --title="Device Streaming API"
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ -
9
+ README.md
10
+ AUTHENTICATION.md
11
+ LICENSE.md
data/AUTHENTICATION.md ADDED
@@ -0,0 +1,122 @@
1
+ # Authentication
2
+
3
+ The recommended way to authenticate to the google-cloud-device_streaming 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-device_streaming 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/device_streaming"
58
+
59
+ client = Google::Cloud::DeviceStreaming.direct_access_service 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/device_streaming"
68
+
69
+ Google::Cloud::DeviceStreaming.configure do |config|
70
+ config.credentials = "path/to/credentialfile.json"
71
+ end
72
+
73
+ client = Google::Cloud::DeviceStreaming.direct_access_service
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-device_streaming
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/device_streaming"
100
+
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
102
+
103
+ client = Google::Cloud::DeviceStreaming.direct_access_service
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).
data/LICENSE.md ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,133 @@
1
+ # Ruby Client for the Device Streaming API
2
+
3
+ The Cloud API for device streaming usage.
4
+
5
+
6
+ Actual client classes for the various versions of this API are defined in
7
+ _versioned_ client gems, with names of the form `google-cloud-device_streaming-v*`.
8
+ The gem `google-cloud-device_streaming` is the main client library that brings the
9
+ versioned gems in as dependencies, and provides high-level methods for
10
+ constructing clients. More information on versioned clients can be found below
11
+ in the section titled *Which client should I use?*.
12
+
13
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-device_streaming/latest)
14
+ for this library, google-cloud-device_streaming, to see the convenience methods for
15
+ constructing client objects. Reference documentation for the client objects
16
+ themselves can be found in the client library documentation for the versioned
17
+ client gems:
18
+ [google-cloud-device_streaming-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-device_streaming-v1/latest).
19
+
20
+ See also the [Product Documentation](https://cloud.google.com/device-streaming/docs)
21
+ for more usage information.
22
+
23
+ ## Quick Start
24
+
25
+ ```
26
+ $ gem install google-cloud-device_streaming
27
+ ```
28
+
29
+ In order to use this library, you first need to go through the following steps:
30
+
31
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
32
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
33
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/devicestreaming.googleapis.com)
34
+ 1. {file:AUTHENTICATION.md Set up authentication.}
35
+
36
+ ## Debug Logging
37
+
38
+ This library comes with opt-in Debug Logging that can help you troubleshoot
39
+ your application's integration with the API. When logging is activated, key
40
+ events such as requests and responses, along with data payloads and metadata
41
+ such as headers and client configuration, are logged to the standard error
42
+ stream.
43
+
44
+ **WARNING:** Client Library Debug Logging includes your data payloads in
45
+ plaintext, which could include sensitive data such as PII for yourself or your
46
+ customers, private keys, or other security data that could be compromising if
47
+ leaked. Always practice good data hygiene with your application logs, and follow
48
+ the principle of least access. Google also recommends that Client Library Debug
49
+ Logging be enabled only temporarily during active debugging, and not used
50
+ permanently in production.
51
+
52
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
53
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
54
+ list of client library gem names. This will select the default logging behavior,
55
+ which writes logs to the standard error stream. On a local workstation, this may
56
+ result in logs appearing on the console. When running on a Google Cloud hosting
57
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
58
+ results in logs appearing alongside your application logs in the
59
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
60
+
61
+ Debug logging also requires that the versioned clients for this service be
62
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
63
+ working, try updating the versioned clients in your bundle or installed gems:
64
+ [google-cloud-device_streaming-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-device_streaming-v1/latest).
65
+
66
+ ## Supported Ruby Versions
67
+
68
+ This library is supported on Ruby 3.0+.
69
+
70
+ Google provides official support for Ruby versions that are actively supported
71
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
72
+ in security maintenance, and not end of life. Older versions of Ruby _may_
73
+ still work, but are unsupported and not recommended. See
74
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
75
+ support schedule.
76
+
77
+ ## Which client should I use?
78
+
79
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
80
+ client library with a name such as `google-cloud-device_streaming`,
81
+ and lower-level _versioned_ client libraries with names such as
82
+ `google-cloud-device_streaming-v1`.
83
+ _In most cases, you should install the main client._
84
+
85
+ ### What's the difference between the main client and a versioned client?
86
+
87
+ A _versioned client_ provides a basic set of data types and client classes for
88
+ a _single version_ of a specific service. (That is, for a service with multiple
89
+ versions, there might be a separate versioned client for each service version.)
90
+ Most versioned clients are written and maintained by a code generator.
91
+
92
+ The _main client_ is designed to provide you with the _recommended_ client
93
+ interfaces for the service. There will be only one main client for any given
94
+ service, even a service with multiple versions. The main client includes
95
+ factory methods for constructing the client objects we recommend for most
96
+ users. In some cases, those will be classes provided by an underlying versioned
97
+ client; in other cases, they will be handwritten higher-level client objects
98
+ with additional capabilities, convenience methods, or best practices built in.
99
+ Generally, the main client will default to a recommended service version,
100
+ although in some cases you can override this if you need to talk to a specific
101
+ service version.
102
+
103
+ ### Why would I want to use the main client?
104
+
105
+ We recommend that most users install the main client gem for a service. You can
106
+ identify this gem as the one _without_ a version in its name, e.g.
107
+ `google-cloud-device_streaming`.
108
+ The main client is recommended because it will embody the best practices for
109
+ accessing the service, and may also provide more convenient interfaces or
110
+ tighter integration into frameworks and third-party libraries. In addition, the
111
+ documentation and samples published by Google will generally demonstrate use of
112
+ the main client.
113
+
114
+ ### Why would I want to use a versioned client?
115
+
116
+ You can use a versioned client if you are content with a possibly lower-level
117
+ class interface, you explicitly want to avoid features provided by the main
118
+ client, or you want to access a specific service version not be covered by the
119
+ main client. You can identify versioned client gems because the service version
120
+ is part of the name, e.g. `google-cloud-device_streaming-v1`.
121
+
122
+ ### What about the google-apis-<name> clients?
123
+
124
+ Client library gems with names that begin with `google-apis-` are based on an
125
+ older code generation technology. They talk to a REST/JSON backend (whereas
126
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
127
+ not offer the same performance, features, and ease of use provided by more
128
+ modern clients.
129
+
130
+ The `google-apis-` clients have wide coverage across Google services, so you
131
+ might need to use one if there is no modern client available for the service.
132
+ However, if a modern client is available, we generally recommend it over the
133
+ older `google-apis-` clients.
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 DeviceStreaming
23
+ VERSION = "0.1.0"
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,165 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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/device_streaming/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! :device_streaming do |config|
32
+ config.add_field! :endpoint, nil, 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
+ config.add_field! :universe_domain, nil, match: ::String
43
+ end
44
+
45
+ module Google
46
+ module Cloud
47
+ module DeviceStreaming
48
+ ##
49
+ # Create a new client object for DirectAccessService.
50
+ #
51
+ # By default, this returns an instance of
52
+ # [Google::Cloud::DeviceStreaming::V1::DirectAccessService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-device_streaming-v1/latest/Google-Cloud-DeviceStreaming-V1-DirectAccessService-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 DirectAccessService service is
56
+ # supported by that API version, and the corresponding gem is available, the
57
+ # appropriate versioned client will be returned.
58
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
59
+ # the `transport` parameter.
60
+ #
61
+ # Raises an exception if the currently installed versioned client gem for the
62
+ # given API version does not support the given transport of the DirectAccessService service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::DeviceStreaming.direct_access_service_available?}.
65
+ #
66
+ # ## About DirectAccessService
67
+ #
68
+ # A service for allocating Android devices and interacting with the
69
+ # live-allocated devices.
70
+ #
71
+ # Each Session will wait for available capacity, at a higher
72
+ # priority over Test Execution. When allocated, the session will be exposed
73
+ # through a stream for integration.
74
+ #
75
+ # DirectAccessService is currently available as a preview to select developers.
76
+ # You can register today on behalf of you and your team at
77
+ # https://developer.android.com/studio/preview/android-device-streaming
78
+ #
79
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
80
+ # Defaults to `:v1`.
81
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
82
+ # @return [::Object] A client object for the specified version.
83
+ #
84
+ def self.direct_access_service version: :v1, transport: :grpc, &block
85
+ require "google/cloud/device_streaming/#{version.to_s.downcase}"
86
+
87
+ package_name = Google::Cloud::DeviceStreaming
88
+ .constants
89
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
90
+ .first
91
+ service_module = Google::Cloud::DeviceStreaming.const_get(package_name).const_get(:DirectAccessService)
92
+ service_module = service_module.const_get(:Rest) if transport == :rest
93
+ service_module.const_get(:Client).new(&block)
94
+ end
95
+
96
+ ##
97
+ # Determines whether the DirectAccessService service is supported by the current client.
98
+ # If true, you can retrieve a client object by calling {Google::Cloud::DeviceStreaming.direct_access_service}.
99
+ # If false, that method will raise an exception. This could happen if the given
100
+ # API version does not exist or does not support the DirectAccessService service,
101
+ # or if the versioned client gem needs an update to support the DirectAccessService service.
102
+ #
103
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
104
+ # Defaults to `:v1`.
105
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
106
+ # @return [boolean] Whether the service is available.
107
+ #
108
+ def self.direct_access_service_available? version: :v1, transport: :grpc
109
+ require "google/cloud/device_streaming/#{version.to_s.downcase}"
110
+ package_name = Google::Cloud::DeviceStreaming
111
+ .constants
112
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
113
+ .first
114
+ return false unless package_name
115
+ service_module = Google::Cloud::DeviceStreaming.const_get package_name
116
+ return false unless service_module.const_defined? :DirectAccessService
117
+ service_module = service_module.const_get :DirectAccessService
118
+ if transport == :rest
119
+ return false unless service_module.const_defined? :Rest
120
+ service_module = service_module.const_get :Rest
121
+ end
122
+ service_module.const_defined? :Client
123
+ rescue ::LoadError
124
+ false
125
+ end
126
+
127
+ ##
128
+ # Configure the google-cloud-device_streaming library.
129
+ #
130
+ # The following configuration parameters are supported:
131
+ #
132
+ # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
133
+ # The path to the keyfile as a String, the contents of the keyfile as a
134
+ # Hash, or a Google::Auth::Credentials object.
135
+ # * `lib_name` (*type:* `String`) -
136
+ # The library name as recorded in instrumentation and logging.
137
+ # * `lib_version` (*type:* `String`) -
138
+ # The library version as recorded in instrumentation and logging.
139
+ # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
140
+ # An array of interceptors that are run before calls are executed.
141
+ # * `timeout` (*type:* `Numeric`) -
142
+ # Default timeout in seconds.
143
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) -
144
+ # Additional headers to be sent with the call.
145
+ # * `retry_policy` (*type:* `Hash`) -
146
+ # The retry policy. The value is a hash with the following keys:
147
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
148
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
149
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
150
+ # * `:retry_codes` (*type:* `Array<String>`) -
151
+ # The error codes that should trigger a retry.
152
+ #
153
+ # @return [::Google::Cloud::Config] The default configuration used by this library
154
+ #
155
+ def self.configure
156
+ yield ::Google::Cloud.configure.device_streaming if block_given?
157
+
158
+ ::Google::Cloud.configure.device_streaming
159
+ end
160
+ end
161
+ end
162
+ end
163
+
164
+ helper_path = ::File.join __dir__, "device_streaming", "helpers.rb"
165
+ require "google/cloud/device_streaming/helpers" if ::File.file? helper_path
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 "google/cloud/device_streaming" unless defined? Google::Cloud::DeviceStreaming::VERSION
metadata ADDED
@@ -0,0 +1,80 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-cloud-device_streaming
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: google-cloud-core
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: '1.6'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: '1.6'
26
+ - !ruby/object:Gem::Dependency
27
+ name: google-cloud-device_streaming-v1
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: '0.0'
33
+ - - "<"
34
+ - !ruby/object:Gem::Version
35
+ version: 2.a
36
+ type: :runtime
37
+ prerelease: false
38
+ version_requirements: !ruby/object:Gem::Requirement
39
+ requirements:
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ version: '0.0'
43
+ - - "<"
44
+ - !ruby/object:Gem::Version
45
+ version: 2.a
46
+ description: The Cloud API for device streaming usage.
47
+ email: googleapis-packages@google.com
48
+ executables: []
49
+ extensions: []
50
+ extra_rdoc_files: []
51
+ files:
52
+ - ".yardopts"
53
+ - AUTHENTICATION.md
54
+ - LICENSE.md
55
+ - README.md
56
+ - lib/google-cloud-device_streaming.rb
57
+ - lib/google/cloud/device_streaming.rb
58
+ - lib/google/cloud/device_streaming/version.rb
59
+ homepage: https://github.com/googleapis/google-cloud-ruby
60
+ licenses:
61
+ - Apache-2.0
62
+ metadata: {}
63
+ rdoc_options: []
64
+ require_paths:
65
+ - lib
66
+ required_ruby_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '3.0'
71
+ required_rubygems_version: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ requirements: []
77
+ rubygems_version: 3.6.9
78
+ specification_version: 4
79
+ summary: The Cloud API for device streaming usage.
80
+ test_files: []