google-cloud-automl 0.7.1 → 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +56 -59
  4. data/LICENSE.md +201 -0
  5. data/MIGRATING.md +324 -0
  6. data/README.md +97 -27
  7. data/lib/google-cloud-automl.rb +6 -2
  8. data/lib/google/cloud/automl.rb +132 -190
  9. data/lib/google/cloud/automl/version.rb +6 -2
  10. metadata +83 -107
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/automl/v1beta1.rb +0 -231
  13. data/lib/google/cloud/automl/v1beta1/annotation_payload_pb.rb +0 -34
  14. data/lib/google/cloud/automl/v1beta1/annotation_spec_pb.rb +0 -19
  15. data/lib/google/cloud/automl/v1beta1/automl_client.rb +0 -1909
  16. data/lib/google/cloud/automl/v1beta1/automl_client_config.json +0 -146
  17. data/lib/google/cloud/automl/v1beta1/automl_client_helpers.rb +0 -109
  18. data/lib/google/cloud/automl/v1beta1/classification_pb.rb +0 -66
  19. data/lib/google/cloud/automl/v1beta1/column_spec_pb.rb +0 -29
  20. data/lib/google/cloud/automl/v1beta1/credentials.rb +0 -41
  21. data/lib/google/cloud/automl/v1beta1/data_items_pb.rb +0 -88
  22. data/lib/google/cloud/automl/v1beta1/data_stats_pb.rb +0 -77
  23. data/lib/google/cloud/automl/v1beta1/data_types_pb.rb +0 -36
  24. data/lib/google/cloud/automl/v1beta1/dataset_pb.rb +0 -39
  25. data/lib/google/cloud/automl/v1beta1/detection_pb.rb +0 -52
  26. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/annotation_payload.rb +0 -63
  27. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/annotation_spec.rb +0 -39
  28. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/classification.rb +0 -212
  29. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/column_spec.rb +0 -67
  30. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/data_items.rb +0 -202
  31. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/data_stats.rb +0 -160
  32. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/data_types.rb +0 -99
  33. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/dataset.rb +0 -77
  34. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/detection.rb +0 -130
  35. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/geometry.rb +0 -43
  36. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/image.rb +0 -183
  37. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/io.rb +0 -1110
  38. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/model.rb +0 -88
  39. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/model_evaluation.rb +0 -96
  40. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/prediction_service.rb +0 -186
  41. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/ranges.rb +0 -31
  42. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/regression.rb +0 -41
  43. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/service.rb +0 -356
  44. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/table_spec.rb +0 -68
  45. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/tables.rb +0 -275
  46. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/temporal.rb +0 -33
  47. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/text.rb +0 -54
  48. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/text_extraction.rb +0 -60
  49. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/text_segment.rb +0 -37
  50. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/text_sentiment.rb +0 -76
  51. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/translation.rb +0 -63
  52. data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/video.rb +0 -35
  53. data/lib/google/cloud/automl/v1beta1/doc/google/longrunning/operations.rb +0 -51
  54. data/lib/google/cloud/automl/v1beta1/doc/google/protobuf/any.rb +0 -131
  55. data/lib/google/cloud/automl/v1beta1/doc/google/protobuf/duration.rb +0 -91
  56. data/lib/google/cloud/automl/v1beta1/doc/google/protobuf/field_mask.rb +0 -222
  57. data/lib/google/cloud/automl/v1beta1/doc/google/protobuf/struct.rb +0 -74
  58. data/lib/google/cloud/automl/v1beta1/doc/google/protobuf/timestamp.rb +0 -113
  59. data/lib/google/cloud/automl/v1beta1/doc/google/rpc/status.rb +0 -39
  60. data/lib/google/cloud/automl/v1beta1/geometry_pb.rb +0 -21
  61. data/lib/google/cloud/automl/v1beta1/image_pb.rb +0 -50
  62. data/lib/google/cloud/automl/v1beta1/io_pb.rb +0 -80
  63. data/lib/google/cloud/automl/v1beta1/model_evaluation_pb.rb +0 -38
  64. data/lib/google/cloud/automl/v1beta1/model_pb.rb +0 -45
  65. data/lib/google/cloud/automl/v1beta1/operations_pb.rb +0 -90
  66. data/lib/google/cloud/automl/v1beta1/prediction_service_client.rb +0 -480
  67. data/lib/google/cloud/automl/v1beta1/prediction_service_client_config.json +0 -36
  68. data/lib/google/cloud/automl/v1beta1/prediction_service_pb.rb +0 -43
  69. data/lib/google/cloud/automl/v1beta1/prediction_service_services_pb.rb +0 -74
  70. data/lib/google/cloud/automl/v1beta1/ranges_pb.rb +0 -17
  71. data/lib/google/cloud/automl/v1beta1/regression_pb.rb +0 -20
  72. data/lib/google/cloud/automl/v1beta1/service_pb.rb +0 -180
  73. data/lib/google/cloud/automl/v1beta1/service_services_pb.rb +0 -158
  74. data/lib/google/cloud/automl/v1beta1/table_spec_pb.rb +0 -24
  75. data/lib/google/cloud/automl/v1beta1/tables_pb.rb +0 -58
  76. data/lib/google/cloud/automl/v1beta1/temporal_pb.rb +0 -18
  77. data/lib/google/cloud/automl/v1beta1/text_extraction_pb.rb +0 -32
  78. data/lib/google/cloud/automl/v1beta1/text_pb.rb +0 -34
  79. data/lib/google/cloud/automl/v1beta1/text_segment_pb.rb +0 -18
  80. data/lib/google/cloud/automl/v1beta1/text_sentiment_pb.rb +0 -29
  81. data/lib/google/cloud/automl/v1beta1/translation_pb.rb +0 -34
  82. data/lib/google/cloud/automl/v1beta1/video_pb.rb +0 -25
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 54a4341c5230b19c84a6b36c092791640d75643190af83679f675c45a62d1b96
4
- data.tar.gz: b16dbed73d513940696ea7a42a4f5a991a7ff9d4d881dbea4fb22d9122ca7bc9
3
+ metadata.gz: a069761c67c6853965853521bc88be499c59da0ab5fc324b81886217515679cf
4
+ data.tar.gz: a918bc6a01b0575c0472b38a239f71345c1a6cf74ca948732ae330610f9c8c05
5
5
  SHA512:
6
- metadata.gz: 47ef42a23dd3161e27ca4c0f0774788aae4a1e37c4d6b569a0616102290f100f5f02e392da0ece5449213ec19a355c8bf6bbd8617994b0758ddc25292aa8f4fc
7
- data.tar.gz: 168674cfda87d45f5f91a8eb9497f14edc65e24da4c12d28f48426b0a99ac81348ef87ee7a3cbaff95ddcbd225d01b4e89533baa486df4675e64b9386cc87739
6
+ metadata.gz: 77289b1985e217fc5b47760d7f95d28b03664da1fc9e0f24ca9f9a94ff071769ffd0385fdaa191b5dfa9dcb2ba9a3cb14ba7512315c22cf93a59bd0e0217b3df
7
+ data.tar.gz: 296106cb6f566c270e69405b00fe3c6f366bd1fe15499b5d0e21e1549d33e661513de81d3b6b7a95a9121fec6e9d4e3ad1a332ec794664a76cf7c45009b4f2f6
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-automl 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-automl 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 AUTOML_CREDENTIALS=/path/to/json`
22
+ export AUTOML_CREDENTIALS=path/to/keyfile.json
22
23
  ```
23
24
 
24
25
  3. Initialize the client.
@@ -26,23 +27,14 @@ export AUTOML_CREDENTIALS=/path/to/json`
26
27
  ```ruby
27
28
  require "google/cloud/automl"
28
29
 
29
- client = Google::Cloud::AutoML::AutoML.new
30
+ client = Google::Cloud::AutoML.prediction_service
30
31
  ```
31
32
 
32
- ## Project and Credential Lookup
33
+ ## Credential Lookup
33
34
 
34
35
  The google-cloud-automl 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,57 +47,62 @@ 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-automl 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. `AUTOML_PROJECT`
77
- 2. `GOOGLE_CLOUD_PROJECT`
65
+ The environment variables that google-cloud-automl
66
+ checks for credentials are configured on the service Credentials class (such as
67
+ `::Google::Cloud::AutoML::V1::PredictionService::Credentials`):
78
68
 
79
- The environment variables that google-cloud-automl checks for credentials are configured on {Google::Cloud::AutoML::V1beta1::Credentials}:
80
-
81
- 1. `AUTOML_CREDENTIALS` - Path to JSON file, or JSON contents
82
- 2. `AUTOML_KEYFILE` - Path to JSON file, or JSON contents
83
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
84
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
85
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `AUTOML_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `AUTOML_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
86
74
 
87
75
  ```ruby
88
76
  require "google/cloud/automl"
89
77
 
90
- ENV["AUTOML_PROJECT"] = "my-project-id"
91
78
  ENV["AUTOML_CREDENTIALS"] = "path/to/keyfile.json"
92
79
 
93
- client = Google::Cloud::AutoML::AutoML.new
80
+ client = Google::Cloud::AutoML.prediction_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/automl"
90
+
91
+ client = Google::Cloud::AutoML.prediction_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/automl"
102
100
 
103
101
  Google::Cloud::AutoML.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::AutoML::AutoML.new
105
+ client = Google::Cloud::AutoML.prediction_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-automl.
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,324 @@
1
+ ## Migrating to google-cloud-automl 1.0
2
+
3
+ The 1.0 release of the google-cloud-automl 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 1.0 release supports versions V1 and V1beta1 of the AutoML service, and
13
+ defaults to V1. Earlier releases supported only V1beta1.
14
+ * The library has been broken out into multiple libraries. The new gems
15
+ `google-cloud-automl-v1` and `google-cloud-automl-v1beta1` contain the
16
+ actual client classes for versions V1 and V1beta1 of the AutoML service,
17
+ and the gem `google-cloud-automl` 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, some client classes included class methods for constructing
31
+ resource paths. These paths are now instance methods on the client objects,
32
+ and are also available in a separate paths module. See
33
+ [Resource Path Helpers](#resource-path-helpers) for more info.
34
+ * Previously, clients reported RPC errors by raising instances of
35
+ `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
36
+ `Google::Cloud::Error` and its subclasses. See
37
+ [Handling Errors](#handling-errors) for more info.
38
+ * Some classes have moved into different namespaces. See
39
+ [Class Namespaces](#class-namespaces) for more info.
40
+
41
+ ### Library Structure
42
+
43
+ Older 0.x releases of the `google-cloud-automl` gem were all-in-one gems
44
+ that included potentially multiple clients for multiple versions of the AutoML
45
+ service. Factory methods such as `Google::Cloud::AutoML::AutoML.new`
46
+ would return you instances of client classes such as
47
+ `Google::Cloud::AutoML::V1beta1::AutoMLClient`.
48
+ These classes were all defined in the same gem.
49
+
50
+ With the 1.0 release, the `google-cloud-automl` gem still provides factory
51
+ methods for obtaining clients. (The method signatures will have changed. See
52
+ [Creating Clients](#creating-clients) for details.) However, the actual client
53
+ classes have been moved into separate gems, one per service version. The
54
+ `Google::Cloud::AutoML::V1::AutoML::Client` class, along with its
55
+ helpers and data types, is now part of the `google-cloud-automl-v1` gem.
56
+ Similarly, the `Google::Cloud::AutoML::V1beta1::AutoML::Client`
57
+ class is part of the `google-cloud-automl-v1beta1` gem.
58
+
59
+ For normal usage, you can continue to install the `google-cloud-automl` gem
60
+ (which will bring in the versioned client gems as dependencies) and continue to
61
+ use factory methods to create clients. However, you may alternatively choose to
62
+ install only one of the versioned gems. For example, if you know you will only
63
+ use `V1` of the service, you can install `google-cloud-automl-v1` by
64
+ itself, and construct instances of the
65
+ `Google::Cloud::AutoML::V1::AutoML::Client` client class directly.
66
+
67
+ ### Client Configuration
68
+
69
+ In older releases, if you wanted to customize performance parameters or
70
+ low-level behavior of the client (such as credentials, timeouts, or
71
+ instrumentation), you would pass a variety of keyword arguments to the client
72
+ constructor. It was also extremely difficult to customize the default settings.
73
+
74
+ With the 1.0 release, a configuration interface provides control over these
75
+ parameters, including defaults for all instances of a client, and settings for
76
+ each specific client instance. For example, to set default credentials and
77
+ timeout for all AutoML V1 clients:
78
+
79
+ ```
80
+ Google::Cloud::AutoML::V1::AutoML::Client.configure do |config|
81
+ config.credentials = "/path/to/credentials.json"
82
+ config.timeout = 10.0
83
+ end
84
+ ```
85
+
86
+ Individual RPCs can also be configured independently. For example, to set the
87
+ timeout for the `create_dataset` call:
88
+
89
+ ```
90
+ Google::Cloud::AutoML::V1::AutoML::Client.configure do |config|
91
+ config.rpcs.create_dataset.timeout = 20.0
92
+ end
93
+ ```
94
+
95
+ Defaults for certain configurations can be set for all AutoML versions and
96
+ services globally:
97
+
98
+ ```
99
+ Google::Cloud::AutoML.configure do |config|
100
+ config.credentials = "/path/to/credentials.json"
101
+ config.timeout = 10.0
102
+ end
103
+ ```
104
+
105
+ Finally, you can override the configuration for each client instance. See the
106
+ next section on [Creating Clients](#creating-clients) for details.
107
+
108
+ ### Creating Clients
109
+
110
+ In older releases, to create a client object, you would use the `new` method
111
+ of modules under `Google::Cloud::AutoML`. For example, you might call
112
+ `Google::Cloud::AutoML::AutoML.new`. Keyword arguments were available to
113
+ select a service version and to configure parameters such as credentials and
114
+ timeouts.
115
+
116
+ With the 1.0 release, use named class methods of `Google::Cloud::AutoML` to
117
+ create a client object. For example, `Google::Cloud::AutoML.auto_ml`.
118
+ You may select a service version using the `:version` keyword argument.
119
+ However, other configuration parameters should be set in a configuration block
120
+ when you create the client.
121
+
122
+ Old:
123
+ ```
124
+ client = Google::Cloud::AutoML::AutoML.new credentials: "/path/to/credentials.json"
125
+ ```
126
+
127
+ New:
128
+ ```
129
+ client = Google::Cloud::AutoML.auto_ml do |config|
130
+ config.credentials = "/path/to/credentials.json"
131
+ end
132
+ ```
133
+
134
+ The configuration block is optional. If you do not provide it, or you do not
135
+ set some configuration parameters, then the default configuration is used. See
136
+ [Client Configuration](#client-configuration).
137
+
138
+ ### Passing Arguments
139
+
140
+ In older releases, required arguments would be passed as positional method
141
+ arguments, while most optional arguments would be passed as keyword arguments.
142
+
143
+ With the 1.0 release, all RPC arguments are passed as keyword arguments,
144
+ regardless of whether they are required or optional. For example:
145
+
146
+ Old:
147
+ ```
148
+ client = Google::Cloud::AutoML::AutoML.new
149
+
150
+ parent = "projects/my-project/locations/my-location"
151
+
152
+ # parent is a positional argument, but page_size is a keyword argument.
153
+ response = client.list_datasets parent, page_size: 10
154
+ ```
155
+
156
+ New:
157
+ ```
158
+ client = Google::Cloud::AutoML.auto_ml
159
+
160
+ parent = "projects/my-project/locations/my-location"
161
+
162
+ # requests is a keyword argument
163
+ response = client.list_datasets parent: parent, page_size: 10
164
+ ```
165
+
166
+ In the 1.0 release, it is also possible to pass a request object, either
167
+ as a hash or as a protocol buffer.
168
+
169
+ New:
170
+ ```
171
+ client = Google::Cloud::AutoML.auto_ml
172
+
173
+ request = Google::Cloud::AutoML::V1::ListDatasetsRequest.new(
174
+ parent: "projects/my-project/locations/my-location",
175
+ page_size: 10
176
+ )
177
+
178
+ # Pass a request object as a positional argument:
179
+ response = client.list_datasets request
180
+ ```
181
+
182
+ Finally, in older releases, to provide call options, you would pass a
183
+ `Google::Gax::CallOptions` object with the `:options` keyword argument. In the
184
+ 1.0 release, pass call options using a _second set_ of keyword arguments.
185
+
186
+ Old:
187
+ ```
188
+ client = Google::Cloud::AutoML::AutoML.new
189
+
190
+ parent = "projects/my-project/locations/my-location"
191
+
192
+ options = Google::Gax::CallOptions.new timeout: 10.0
193
+
194
+ response = client.list_datasets parent, page_size: 10, options: options
195
+ ```
196
+
197
+ New:
198
+ ```
199
+ client = Google::Cloud::AutoML.auto_ml
200
+
201
+ parent = "projects/my-project/locations/my-location"
202
+
203
+ # Use a hash to wrap the normal call arguments (or pass a request object), and
204
+ # then add further keyword arguments for the call options.
205
+ response = client.batch_annotate_images(
206
+ { parent: parent, page_size: 10 },
207
+ timeout: 10.0
208
+ )
209
+ ```
210
+
211
+ ### Resource Path Helpers
212
+
213
+ The client library includes helper methods for generating the resource path
214
+ strings passed to many calls. These helpers have changed in two ways:
215
+
216
+ * In older releases, they are _class_ methods on the client class. In the 1.0
217
+ release, they are _instance_ methods on the client. They are also available
218
+ on a separate paths module that you can include elsewhere for convenience.
219
+ * In older releases, arguments to a resource path helper are passed as
220
+ _positional_ arguments. In the 1.0 release, they are passed as named _keyword_
221
+ arguments.
222
+
223
+ Following is an example involving using a resource path helper.
224
+
225
+ Old:
226
+ ```
227
+ client = Google::Cloud::AutoML::AutoML.new
228
+
229
+ # Call the helper on the client class
230
+ parent = Google::Cloud::AutoML::V1::AutoMLClient.location_path(
231
+ "my-project", "my-location"
232
+ )
233
+
234
+ response = client.list_datasets parent
235
+ ```
236
+
237
+ New:
238
+ ```
239
+ client = Google::Cloud::AutoML.auto_ml
240
+
241
+ # Call the helper on the client instance, and use keyword arguments
242
+ parent = client.location_path project: "my-project", location: "my-location"
243
+
244
+ response = client.list_datasets parent: parent
245
+ ```
246
+
247
+ In the 1.0 client, you can also use the paths module as a convenience module.
248
+
249
+ New:
250
+ ```
251
+ # Bring the path helper methods into the current class
252
+ include Google::Cloud::AutoML::V1::AutoML::Paths
253
+
254
+ def foo
255
+ client = Google::Cloud::AutoML.auto_ml
256
+
257
+ # Call the included helper method
258
+ parent = location_path project: "my-project", location: "my-location"
259
+
260
+ response = client.list_datasets parent: parent
261
+
262
+ # Do something with response...
263
+ end
264
+ ```
265
+
266
+ ### Handling Errors
267
+
268
+ The client reports standard
269
+ {file:https://github.com/grpc/grpc/blob/master/doc/statuscodes.md gRPC error codes}
270
+ by raising exceptions. In older releases, these exceptions were located in the
271
+ `Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
272
+ exception class, defined in the `google-gax` gem. However, these classes were
273
+ different from the standard exceptions (subclasses of `Google::Cloud::Error`)
274
+ thrown by other client libraries such as `google-cloud-storage`.
275
+
276
+ The 1.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
277
+ for consistency across all the Google Cloud client libraries. In general, these
278
+ exceptions have the same name as their counterparts from older releases, but
279
+ are located in the `Google::Cloud` namespace rather than the `Google::Gax`
280
+ namespace.
281
+
282
+ Old:
283
+ ```
284
+ client = Google::Cloud::AutoML::AutoML.new
285
+
286
+ parent = "projects/my-project/locations/my-location"
287
+
288
+ begin
289
+ response = client.list_datasets parent, page_size: 10
290
+ rescue Google::Gax::Error => e
291
+ # Handle exceptions that subclass Google::Gax::Error
292
+ end
293
+ ```
294
+
295
+ New:
296
+ ```
297
+ client = Google::Cloud::AutoML.auto_ml
298
+
299
+ parent = "projects/my-project/locations/my-location"
300
+
301
+ begin
302
+ response = client.list_datasets parent: parent, page_size: 10
303
+ rescue Google::Cloud::Error => e
304
+ # Handle exceptions that subclass Google::Cloud::Error
305
+ end
306
+ ```
307
+
308
+ ### Class Namespaces
309
+
310
+ In older releases, the client object was of classes with names like:
311
+ `Google::Cloud::AutoML::V1::AutoMLClient`.
312
+ In the 1.0 release, the client object is of a different class:
313
+ `Google::Cloud::AutoML::V1::AutoML::Client`.
314
+ Note that most users will use the factory methods such as
315
+ `Google::Cloud::AutoML.auto_ml` to create instances of the client object,
316
+ so you may not need to reference the actual class directly.
317
+ See [Creating Clients](#creating-clients).
318
+
319
+ In older releases, the credentials object was of class
320
+ `Google::Cloud::AutoML::V1::Credentials`.
321
+ In the 1.0 release, each service has its own credentials class, e.g.
322
+ `Google::Cloud::AutoML::V1::AutoML::Credentials`.
323
+ Again, most users will not need to reference this class directly.
324
+ See [Client Configuration](#client-configuration).