google-cloud-video_intelligence 2.1.1 → 3.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -54
  4. data/LICENSE.md +201 -0
  5. data/MIGRATING.md +274 -0
  6. data/README.md +97 -64
  7. data/lib/{google/cloud/video_intelligence/credentials.rb → google-cloud-video_intelligence.rb} +5 -13
  8. data/lib/google/cloud/video_intelligence.rb +87 -156
  9. data/lib/google/cloud/video_intelligence/version.rb +6 -2
  10. metadata +100 -84
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/video_intelligence/v1.rb +0 -186
  13. data/lib/google/cloud/video_intelligence/v1/credentials.rb +0 -41
  14. data/lib/google/cloud/video_intelligence/v1/doc/google/cloud/videointelligence/v1/video_intelligence.rb +0 -789
  15. data/lib/google/cloud/video_intelligence/v1/doc/google/longrunning/operations.rb +0 -51
  16. data/lib/google/cloud/video_intelligence/v1/doc/google/protobuf/any.rb +0 -131
  17. data/lib/google/cloud/video_intelligence/v1/doc/google/protobuf/duration.rb +0 -91
  18. data/lib/google/cloud/video_intelligence/v1/doc/google/rpc/status.rb +0 -39
  19. data/lib/google/cloud/video_intelligence/v1/video_intelligence_service_client.rb +0 -309
  20. data/lib/google/cloud/video_intelligence/v1/video_intelligence_service_client_config.json +0 -31
  21. data/lib/google/cloud/video_intelligence/v1beta2.rb +0 -149
  22. data/lib/google/cloud/video_intelligence/v1beta2/credentials.rb +0 -41
  23. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/cloud/videointelligence/v1beta2/video_intelligence.rb +0 -372
  24. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/longrunning/operations.rb +0 -51
  25. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/protobuf/any.rb +0 -131
  26. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/protobuf/duration.rb +0 -91
  27. data/lib/google/cloud/video_intelligence/v1beta2/doc/google/rpc/status.rb +0 -39
  28. data/lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service_client.rb +0 -309
  29. data/lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service_client_config.json +0 -31
  30. data/lib/google/cloud/video_intelligence/v1p1beta1.rb +0 -187
  31. data/lib/google/cloud/video_intelligence/v1p1beta1/credentials.rb +0 -41
  32. data/lib/google/cloud/video_intelligence/v1p1beta1/doc/google/cloud/videointelligence/v1p1beta1/video_intelligence.rb +0 -410
  33. data/lib/google/cloud/video_intelligence/v1p1beta1/doc/google/longrunning/operations.rb +0 -51
  34. data/lib/google/cloud/video_intelligence/v1p1beta1/doc/google/protobuf/any.rb +0 -131
  35. data/lib/google/cloud/video_intelligence/v1p1beta1/doc/google/protobuf/duration.rb +0 -91
  36. data/lib/google/cloud/video_intelligence/v1p1beta1/doc/google/rpc/status.rb +0 -39
  37. data/lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service_client.rb +0 -309
  38. data/lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service_client_config.json +0 -31
  39. data/lib/google/cloud/video_intelligence/v1p2beta1.rb +0 -187
  40. data/lib/google/cloud/video_intelligence/v1p2beta1/credentials.rb +0 -41
  41. data/lib/google/cloud/video_intelligence/v1p2beta1/doc/google/cloud/videointelligence/v1p2beta1/video_intelligence.rb +0 -442
  42. data/lib/google/cloud/video_intelligence/v1p2beta1/doc/google/longrunning/operations.rb +0 -51
  43. data/lib/google/cloud/video_intelligence/v1p2beta1/doc/google/protobuf/any.rb +0 -131
  44. data/lib/google/cloud/video_intelligence/v1p2beta1/doc/google/protobuf/duration.rb +0 -91
  45. data/lib/google/cloud/video_intelligence/v1p2beta1/doc/google/rpc/status.rb +0 -39
  46. data/lib/google/cloud/video_intelligence/v1p2beta1/video_intelligence_service_client.rb +0 -309
  47. data/lib/google/cloud/video_intelligence/v1p2beta1/video_intelligence_service_client_config.json +0 -31
  48. data/lib/google/cloud/videointelligence/v1/video_intelligence_pb.rb +0 -304
  49. data/lib/google/cloud/videointelligence/v1/video_intelligence_services_pb.rb +0 -50
  50. data/lib/google/cloud/videointelligence/v1beta2/video_intelligence_pb.rb +0 -170
  51. data/lib/google/cloud/videointelligence/v1beta2/video_intelligence_services_pb.rb +0 -51
  52. data/lib/google/cloud/videointelligence/v1p1beta1/video_intelligence_pb.rb +0 -172
  53. data/lib/google/cloud/videointelligence/v1p1beta1/video_intelligence_services_pb.rb +0 -51
  54. data/lib/google/cloud/videointelligence/v1p2beta1/video_intelligence_pb.rb +0 -193
  55. data/lib/google/cloud/videointelligence/v1p2beta1/video_intelligence_services_pb.rb +0 -51
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b8f882729628af5ff2abfb0ba04414bd2ca907a12b8324d2d2f371bdc9d19111
4
- data.tar.gz: fb8488114d62a97ef066d638d38caa3c09cfd05c2177c0ecbe8932efdc6cb962
3
+ metadata.gz: ee0cad769301ff973438d06054e213e0360919ec0031488ba8a2b8f04d4f3185
4
+ data.tar.gz: 8f57b43f40ba0c596b7a1e0d5f99f7e0640e45345c418ab8d5d3513b98d47990
5
5
  SHA512:
6
- metadata.gz: f96bc4fe9d6273f7587a39335d6758c0444aba26ea809ef85b524a197ae0b17a5c7382c94bd30f5635dd3760690bd768382e4ae368e72e45a5c71e733d0189ec
7
- data.tar.gz: a7aac11d0f95172a90eb18e26a21b94bff10a9d60641f101edc371a2b4be449747216622680579ec379860bea28b1ade007ce4a016b0180ffed85662416f234f
6
+ metadata.gz: 9198ae7a065833ee2a2d2dad70c0681afd84c04423123c399276550d0a0e98a890f28a75718db486a18ac2e452df4544d1616bececd36c16876d79a81c578fe6
7
+ data.tar.gz: 345a0afd68a05a3940d5686f4c92b1801e2fd81f6c3363d9bfa56426f553a08f3624a24c9af24f9be4ceba6a76e0868a7ab171565ac3da55d155110c1ed04369
data/.yardopts CHANGED
@@ -8,4 +8,5 @@
8
8
  -
9
9
  README.md
10
10
  AUTHENTICATION.md
11
- LICENSE
11
+ MIGRATING.md
12
+ LICENSE.md
data/AUTHENTICATION.md CHANGED
@@ -1,16 +1,17 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-video_intelligence library uses [Service
4
- Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within [Google
6
- Cloud Platform environments](#google-cloud-platform-environments)
7
- the credentials will be discovered automatically. When running on other
3
+ In general, the google-cloud-video_intelligence library uses
4
+ [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
+ credentials to connect to Google Cloud services. When running within
6
+ [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
+ credentials will be discovered automatically. When running on other
8
8
  environments, the Service Account credentials can be specified by providing the
9
- path to the [JSON
10
- keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
11
- the account (or the JSON itself) in [environment
12
- variables](#environment-variables). Additionally, Cloud SDK credentials can also
13
- be discovered automatically, but this is only recommended during development.
9
+ path to the
10
+ [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
+ for the account (or the JSON itself) in
12
+ [environment variables](#environment-variables). Additionally, Cloud SDK
13
+ credentials can also be discovered automatically, but this is only recommended
14
+ during development.
14
15
 
15
16
  ## Quickstart
16
17
 
@@ -18,7 +19,7 @@ be discovered automatically, but this is only recommended during development.
18
19
  2. Set the [environment variable](#environment-variables).
19
20
 
20
21
  ```sh
21
- export VIDEO_INTELLIGENCE_CREDENTIALS=/path/to/json`
22
+ export VIDEO_INTELLIGENCE_CREDENTIALS=path/to/keyfile.json
22
23
  ```
23
24
 
24
25
  3. Initialize the client.
@@ -26,23 +27,14 @@ export VIDEO_INTELLIGENCE_CREDENTIALS=/path/to/json`
26
27
  ```ruby
27
28
  require "google/cloud/video_intelligence"
28
29
 
29
- client = Google::Cloud::VideoIntelligence.new
30
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service
30
31
  ```
31
32
 
32
- ## Project and Credential Lookup
33
+ ## Credential Lookup
33
34
 
34
35
  The google-cloud-video_intelligence library aims to make authentication
35
36
  as simple as possible, and provides several mechanisms to configure your system
36
- without providing **Project ID** and **Service Account Credentials** directly in
37
- code.
38
-
39
- **Project ID** is discovered in the following order:
40
-
41
- 1. Specify project ID in method arguments
42
- 2. Specify project ID in configuration
43
- 3. Discover project ID in environment variables
44
- 4. Discover GCP project ID
45
- 5. Discover project ID in credentials JSON
37
+ without requiring **Service Account Credentials** directly in code.
46
38
 
47
39
  **Credentials** are discovered in the following order:
48
40
 
@@ -55,28 +47,24 @@ code.
55
47
 
56
48
  ### Google Cloud Platform environments
57
49
 
58
- When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
59
- Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
60
- (GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
61
- automatically. Code should be written as if already authenticated.
50
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
51
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
+ Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
+ Code should be written as if already authenticated.
62
54
 
63
55
  ### Environment Variables
64
56
 
65
- The **Project ID** and **Credentials JSON** can be placed in environment
66
- variables instead of declaring them directly in code. Each service has its own
67
- environment variable, allowing for different service accounts to be used for
68
- different services. (See the READMEs for the individual service gems for
69
- details.) The path to the **Credentials JSON** file can be stored in the
70
- environment variable, or the **Credentials JSON** itself can be stored for
71
- environments such as Docker containers where writing files is difficult or not
72
- encouraged.
73
-
74
- The environment variables that google-cloud-video_intelligence checks for project ID are:
57
+ The **Credentials JSON** can be placed in environment variables instead of
58
+ declaring them directly in code. Each service has its own environment variable,
59
+ allowing for different service accounts to be used for different services. (See
60
+ the READMEs for the individual service gems for details.) The path to the
61
+ **Credentials JSON** file can be stored in the environment variable, or the
62
+ **Credentials JSON** itself can be stored for environments such as Docker
63
+ containers where writing files is difficult or not encouraged.
75
64
 
76
- 1. `VIDEO_INTELLIGENCE_PROJECT`
77
- 2. `GOOGLE_CLOUD_PROJECT`
78
-
79
- The environment variables that google-cloud-video_intelligence checks for credentials are configured on {Google::Cloud::VideoIntelligence::V1::Credentials}:
65
+ The environment variables that google-cloud-video_intelligence
66
+ checks for credentials are configured on the service Credentials class (such as
67
+ `::Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Credentials`):
80
68
 
81
69
  1. `VIDEO_INTELLIGENCE_CREDENTIALS` - Path to JSON file, or JSON contents
82
70
  2. `VIDEO_INTELLIGENCE_KEYFILE` - Path to JSON file, or JSON contents
@@ -87,25 +75,34 @@ The environment variables that google-cloud-video_intelligence checks for creden
87
75
  ```ruby
88
76
  require "google/cloud/video_intelligence"
89
77
 
90
- ENV["VIDEO_INTELLIGENCE_PROJECT"] = "my-project-id"
91
78
  ENV["VIDEO_INTELLIGENCE_CREDENTIALS"] = "path/to/keyfile.json"
92
79
 
93
- client = Google::Cloud::VideoIntelligence.new
80
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service
94
81
  ```
95
82
 
96
83
  ### Configuration
97
84
 
98
- The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
85
+ The **Credentials JSON** can be configured instead of placing them in
86
+ environment variables. Either on an individual client initialization:
87
+
88
+ ```ruby
89
+ require "google/cloud/video_intelligence"
90
+
91
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service do |config|
92
+ config.credentials = "path/to/keyfile.json"
93
+ end
94
+ ```
95
+
96
+ Or configured globally for all clients:
99
97
 
100
98
  ```ruby
101
99
  require "google/cloud/video_intelligence"
102
100
 
103
101
  Google::Cloud::VideoIntelligence.configure do |config|
104
- config.project_id = "my-project-id"
105
102
  config.credentials = "path/to/keyfile.json"
106
103
  end
107
104
 
108
- client = Google::Cloud::VideoIntelligence.new
105
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service
109
106
  ```
110
107
 
111
108
  ### Cloud SDK
@@ -134,24 +131,24 @@ To configure your system for this, simply:
134
131
 
135
132
  ## Creating a Service Account
136
133
 
137
- Google Cloud requires a **Project ID** and **Service Account Credentials** to
138
- connect to the APIs. You will use the **Project ID** and **JSON key file** to
134
+ Google Cloud requires **Service Account Credentials** to
135
+ connect to the APIs. You will use the **JSON key file** to
139
136
  connect to most services with google-cloud-video_intelligence.
140
137
 
141
- If you are not running this client within [Google Cloud Platform
142
- environments](#google-cloud-platform-environments), you need a Google
143
- Developers service account.
138
+ If you are not running this client within
139
+ [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
+ need a Google Developers service account.
144
141
 
145
142
  1. Visit the [Google Developers Console][dev-console].
146
- 1. Create a new project or click on an existing project.
147
- 1. Activate the slide-out navigation tray and select **API Manager**. From
143
+ 2. Create a new project or click on an existing project.
144
+ 3. Activate the slide-out navigation tray and select **API Manager**. From
148
145
  here, you will enable the APIs that your application requires.
149
146
 
150
147
  ![Enable the APIs that your application requires][enable-apis]
151
148
 
152
149
  *Note: You may need to enable billing in order to use these services.*
153
150
 
154
- 1. Select **Credentials** from the side navigation.
151
+ 4. Select **Credentials** from the side navigation.
155
152
 
156
153
  You should see a screen like one of the following.
157
154
 
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/MIGRATING.md ADDED
@@ -0,0 +1,274 @@
1
+ ## Migrating to google-cloud-video_intelligence 3.0
2
+
3
+ The 3.0 release of the google-cloud-video_intelligence client is a significant upgrade
4
+ based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
5
+ and includes substantial interface changes. Existing code written for earlier
6
+ versions of this library will likely require updates to use this version.
7
+ This document describes the changes that have been made, and what you need to
8
+ do to update your usage.
9
+
10
+ To summarize:
11
+
12
+ * The library has been broken out into multiple libraries. The new gems
13
+ `google-cloud-video_intelligence-v1`, `google-cloud-video_intelligence-v1beta2`,
14
+ `google-cloud-video_intelligence-v1p1beta1`, and
15
+ `google-cloud-video_intelligence-v1p2beta1` contain the
16
+ actual client classes for the various versions of the VideoIntelligence service,
17
+ and the gem `google-cloud-video_intelligence` now simply provides a convenience wrapper.
18
+ See [Library Structure](#library-structure) for more info.
19
+ * The library uses a new configuration mechanism giving you closer control
20
+ over endpoint address, network timeouts, and retry. See
21
+ [Client Configuration](#client-configuration) for more info. Furthermore,
22
+ when creating a client object, you can customize its configuration in a
23
+ block rather than passing arguments to the constructor. See
24
+ [Creating Clients](#creating-clients) for more info.
25
+ * Previously, positional arguments were used to indicate required arguments.
26
+ Now, all method arguments are keyword arguments, with documentation that
27
+ specifies whether they are required or optional. Additionally, you can pass
28
+ a proto request object instead of separate arguments. See
29
+ [Passing Arguments](#passing-arguments) for more info.
30
+ * Previously, clients reported RPC errors by raising instances of
31
+ `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
32
+ `Google::Cloud::Error` and its subclasses. See
33
+ [Handling Errors](#handling-errors) for more info.
34
+ * Some classes have moved into different namespaces. See
35
+ [Class Namespaces](#class-namespaces) for more info.
36
+
37
+ ### Library Structure
38
+
39
+ Older releases of the `google-cloud-video_intelligence` gem were all-in-one gems
40
+ that included potentially multiple clients for multiple versions of the Video Intelligence
41
+ service. The `Google::Cloud::VideoIntelligence.new` factory method would
42
+ return you an instance of a `Google::Cloud::VideoIntelligence::V1::VideoIntelligenceServiceClient`
43
+ object for the V1 version of the service, (or other corresponding classes for
44
+ other versions of the service). All these classes were defined in the same gem.
45
+
46
+ With the 3.0 release, the `google-cloud-video_intelligence` gem still provides factory
47
+ methods for obtaining clients. (The method signatures will have changed. See
48
+ [Creating Clients](#creating-clients) for details.) However, the actual client
49
+ classes have been moved into separate gems, one per service version. The
50
+ `Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Client` class, along with its
51
+ helpers and data types, is now part of the `google-cloud-video_intelligence-v1` gem.
52
+ Corresponding classes for other versions of the service are similarly moved to
53
+ other gems with the version in the gem name.
54
+
55
+ For normal usage, you can continue to install the `google-cloud-video_intelligence` gem
56
+ (which will bring in the versioned client gems as dependencies) and continue to
57
+ use factory methods to create clients. However, you may alternatively choose to
58
+ install only one of the versioned gems. For example, if you know you will only
59
+ use `V1` of the service, you can install `google-cloud-video_intelligence-v1` by
60
+ itself, and construct instances of the
61
+ `Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Client` client class directly.
62
+
63
+ ### Client Configuration
64
+
65
+ In older releases, if you wanted to customize performance parameters or
66
+ low-level behavior of the client (such as credentials, timeouts, or
67
+ instrumentation), you would pass a variety of keyword arguments to the client
68
+ constructor. It was also extremely difficult to customize the default settings.
69
+
70
+ With the 3.0 release, a configuration interface provides control over these
71
+ parameters, including defaults for all instances of a client, and settings for
72
+ each specific client instance. For example, to set default credentials and
73
+ timeout for all Speech V1 clients:
74
+
75
+ ```
76
+ Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Client.configure do |config|
77
+ config.credentials = "/path/to/credentials.json"
78
+ config.timeout = 10.0
79
+ end
80
+ ```
81
+
82
+ Individual RPCs can also be configured independently. For example, to set the
83
+ timeout for the `annotate_video` call:
84
+
85
+ ```
86
+ Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Client.configure do |config|
87
+ config.rpcs.annotate_video.timeout = 20.0
88
+ end
89
+ ```
90
+
91
+ Defaults for certain configurations can be set for all Video Intelligence versions and
92
+ services globally:
93
+
94
+ ```
95
+ Google::Cloud::VideoIntelligence.configure do |config|
96
+ config.credentials = "/path/to/credentials.json"
97
+ config.timeout = 10.0
98
+ end
99
+ ```
100
+
101
+ Finally, you can override the configuration for each client instance. See the
102
+ next section on [Creating Clients](#creating-clients) for details.
103
+
104
+ ### Creating Clients
105
+
106
+ In older releases, to create a client object, you would use the
107
+ `Google::Cloud::VideoIntelligence.new` class method. Keyword arguments were available to
108
+ select a service version and to configure parameters such as credentials and
109
+ timeouts.
110
+
111
+ With the 3.0 release, use the `Google::Cloud::VideoIntelligence.video_intelligence_service` class
112
+ method to create a client object. You may select a service version using the
113
+ `:version` keyword argument. However, other configuration parameters should be
114
+ set in a configuration block when you create the client.
115
+
116
+ Old:
117
+ ```
118
+ client = Google::Cloud::VideoIntelligence.new credentials: "/path/to/credentials.json"
119
+ ```
120
+
121
+ New:
122
+ ```
123
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service do |config|
124
+ config.credentials = "/path/to/credentials.json"
125
+ end
126
+ ```
127
+
128
+ The configuration block is optional. If you do not provide it, or you do not
129
+ set some configuration parameters, then the default configuration is used. See
130
+ [Client Configuration](#client-configuration).
131
+
132
+ ### Passing Arguments
133
+
134
+ In older releases, required arguments would be passed as positional method
135
+ arguments, while most optional arguments would be passed as keyword arguments.
136
+
137
+ With the 3.0 release, all RPC arguments are passed as keyword arguments,
138
+ regardless of whether they are required or optional. For example:
139
+
140
+ Old:
141
+ ```
142
+ client = Google::Cloud::VideoIntelligence.new
143
+
144
+ features = [Google::Cloud::VideoIntelligence::V1::Feature::FACE_DETECTION]
145
+ input_uri = "gs://my-bucket/my-video"
146
+
147
+ # features is a positional argument, but input_uri is a keyword argument
148
+ response = client.annotate_video features, input_uri: input_uri
149
+ ```
150
+
151
+ New:
152
+ ```
153
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service
154
+
155
+ features = [Google::Cloud::VideoIntelligence::V1::Feature::FACE_DETECTION]
156
+ input_uri = "gs://my-bucket/my-video"
157
+
158
+ # features and input_uri are both keyword arguments
159
+ response = client.annotate_video features: features, input_uri: input_uri
160
+ ```
161
+
162
+ In the 3.0 release, it is also possible to pass a request object, either
163
+ as a hash or as a protocol buffer.
164
+
165
+ New:
166
+ ```
167
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service
168
+
169
+ request = Google::Cloud::VideoIntelligence::V1::AnnotateVideoRequest.new(
170
+ features: [Google::Cloud::VideoIntelligence::V1::Feature::FACE_DETECTION],
171
+ input_uri: "gs://my-bucket/my-video"
172
+ )
173
+
174
+ # Pass a request object as a positional argument:
175
+ response = client.annotate_video request
176
+ ```
177
+
178
+ Finally, in older releases, to provide call options, you would pass a
179
+ `Google::Gax::CallOptions` object with the `:options` keyword argument. In the
180
+ 3.0 release, pass call options using a _second set_ of keyword arguments.
181
+
182
+ Old:
183
+ ```
184
+ client = Google::Cloud::VideoIntelligence.new
185
+
186
+ features = [Google::Cloud::VideoIntelligence::V1::Feature::FACE_DETECTION]
187
+ input_uri = "gs://my-bucket/my-video"
188
+
189
+ options = Google::Gax::CallOptions.new timeout: 10.0
190
+
191
+ response = client.annotate_video features, input_uri: input_uri, options: options
192
+ ```
193
+
194
+ New:
195
+ ```
196
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service
197
+
198
+ features = [Google::Cloud::VideoIntelligence::V1::Feature::FACE_DETECTION]
199
+ input_uri = "gs://my-bucket/my-video"
200
+
201
+ # Use a hash to wrap the normal call arguments (or pass a request object), and
202
+ # then add further keyword arguments for the call options.
203
+ response = client.annotate_video(
204
+ { features: features, input_uri: input_uri },
205
+ timeout: 10.0)
206
+ ```
207
+
208
+ ### Handling Errors
209
+
210
+ The client reports standard
211
+ [gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
212
+ by raising exceptions. In older releases, these exceptions were located in the
213
+ `Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
214
+ exception class, defined in the `google-gax` gem. However, these classes were
215
+ different from the standard exceptions (subclasses of `Google::Cloud::Error`)
216
+ thrown by other client libraries such as `google-cloud-storage`.
217
+
218
+ The 3.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
219
+ for consistency across all the Google Cloud client libraries. In general, these
220
+ exceptions have the same name as their counterparts from older releases, but
221
+ are located in the `Google::Cloud` namespace rather than the `Google::Gax`
222
+ namespace.
223
+
224
+ Old:
225
+ ```
226
+ client = Google::Cloud::VideoIntelligence.new
227
+
228
+ features = [Google::Cloud::VideoIntelligence::V1::Feature::FACE_DETECTION]
229
+ input_uri = "gs://my-bucket/my-video"
230
+
231
+ begin
232
+ response = client.annotate_video features, input_uri: input_uri
233
+ rescue Google::Gax::Error => e
234
+ # Handle exceptions that subclass Google::Gax::Error
235
+ end
236
+ ```
237
+
238
+ New:
239
+ ```
240
+ client = Google::Cloud::VideoIntelligence.video_intelligence_service
241
+
242
+ features = [Google::Cloud::VideoIntelligence::V1::Feature::FACE_DETECTION]
243
+ input_uri = "gs://my-bucket/my-video"
244
+
245
+ begin
246
+ response = client.annotate_video features: features, input_uri: input_uri
247
+ rescue Google::Cloud::Error => e
248
+ # Handle exceptions that subclass Google::Cloud::Error
249
+ end
250
+ ```
251
+
252
+ ### Class Namespaces
253
+
254
+ In some significantly older releases, (protobuf) data type classes were located
255
+ in the namespace `Google::Cloud::Videointelligence::V1` (note the lower-case "i".)
256
+ In more recent releases, these were moved into `Google::Cloud::VideoIntelligence::V1`
257
+ (with an upper-case "I"), but the older namespace also continued to work.
258
+ In the 3.0 release, the old namespace with a lower-case "i" has been dropped.
259
+
260
+ In older releases, the client object was of classes with names like:
261
+ `Google::Cloud::VideoIntelligence::V1::VideoIntelligenceServiceClient`.
262
+ In the 3.0 release, the client object is of a different class:
263
+ `Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Client`.
264
+ Note that most users will use the factory methods such as
265
+ `Google::Cloud::VideoIntelligence.video_intelligence_service` to create instances of the client object,
266
+ so you may not need to reference the actual class directly.
267
+ See [Creating Clients](#creating-clients).
268
+
269
+ In older releases, the credentials object was of class
270
+ `Google::Cloud::VideoIntelligence::V1::Credentials`.
271
+ In the 3.0 release, each service has its own credentials class, e.g.
272
+ `Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Credentials`.
273
+ Again, most users will not need to reference this class directly.
274
+ See [Client Configuration](#client-configuration).