google-cloud-vision_ai-v1 0.a → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (104) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/vision_ai/v1/app_platform/client.rb +3318 -0
  6. data/lib/google/cloud/vision_ai/v1/app_platform/credentials.rb +47 -0
  7. data/lib/google/cloud/vision_ai/v1/app_platform/operations.rb +809 -0
  8. data/lib/google/cloud/vision_ai/v1/app_platform/paths.rb +151 -0
  9. data/lib/google/cloud/vision_ai/v1/app_platform/rest/client.rb +3106 -0
  10. data/lib/google/cloud/vision_ai/v1/app_platform/rest/operations.rb +951 -0
  11. data/lib/google/cloud/vision_ai/v1/app_platform/rest/service_stub.rb +1618 -0
  12. data/lib/google/cloud/vision_ai/v1/app_platform/rest.rb +53 -0
  13. data/lib/google/cloud/vision_ai/v1/app_platform.rb +56 -0
  14. data/lib/google/cloud/vision_ai/v1/health_check_service/client.rb +456 -0
  15. data/lib/google/cloud/vision_ai/v1/health_check_service/credentials.rb +47 -0
  16. data/lib/google/cloud/vision_ai/v1/health_check_service/paths.rb +52 -0
  17. data/lib/google/cloud/vision_ai/v1/health_check_service/rest/client.rb +423 -0
  18. data/lib/google/cloud/vision_ai/v1/health_check_service/rest/service_stub.rb +128 -0
  19. data/lib/google/cloud/vision_ai/v1/health_check_service/rest.rb +53 -0
  20. data/lib/google/cloud/vision_ai/v1/health_check_service.rb +56 -0
  21. data/lib/google/cloud/vision_ai/v1/live_video_analytics/client.rb +2375 -0
  22. data/lib/google/cloud/vision_ai/v1/live_video_analytics/credentials.rb +47 -0
  23. data/lib/google/cloud/vision_ai/v1/live_video_analytics/operations.rb +809 -0
  24. data/lib/google/cloud/vision_ai/v1/live_video_analytics/paths.rb +130 -0
  25. data/lib/google/cloud/vision_ai/v1/live_video_analytics/rest/client.rb +2220 -0
  26. data/lib/google/cloud/vision_ai/v1/live_video_analytics/rest/operations.rb +951 -0
  27. data/lib/google/cloud/vision_ai/v1/live_video_analytics/rest/service_stub.rb +1139 -0
  28. data/lib/google/cloud/vision_ai/v1/live_video_analytics/rest.rb +54 -0
  29. data/lib/google/cloud/vision_ai/v1/live_video_analytics.rb +57 -0
  30. data/lib/google/cloud/vision_ai/v1/rest.rb +42 -0
  31. data/lib/google/cloud/vision_ai/v1/streaming_service/client.rb +915 -0
  32. data/lib/google/cloud/vision_ai/v1/streaming_service/credentials.rb +47 -0
  33. data/lib/google/cloud/vision_ai/v1/streaming_service/paths.rb +54 -0
  34. data/lib/google/cloud/vision_ai/v1/streaming_service/rest/client.rb +610 -0
  35. data/lib/google/cloud/vision_ai/v1/streaming_service/rest/service_stub.rb +249 -0
  36. data/lib/google/cloud/vision_ai/v1/streaming_service/rest.rb +52 -0
  37. data/lib/google/cloud/vision_ai/v1/streaming_service.rb +55 -0
  38. data/lib/google/cloud/vision_ai/v1/streams_service/client.rb +2931 -0
  39. data/lib/google/cloud/vision_ai/v1/streams_service/credentials.rb +47 -0
  40. data/lib/google/cloud/vision_ai/v1/streams_service/operations.rb +809 -0
  41. data/lib/google/cloud/vision_ai/v1/streams_service/paths.rb +153 -0
  42. data/lib/google/cloud/vision_ai/v1/streams_service/rest/client.rb +2740 -0
  43. data/lib/google/cloud/vision_ai/v1/streams_service/rest/operations.rb +951 -0
  44. data/lib/google/cloud/vision_ai/v1/streams_service/rest/service_stub.rb +1437 -0
  45. data/lib/google/cloud/vision_ai/v1/streams_service/rest.rb +56 -0
  46. data/lib/google/cloud/vision_ai/v1/streams_service.rb +59 -0
  47. data/lib/google/cloud/vision_ai/v1/version.rb +8 -3
  48. data/lib/google/cloud/vision_ai/v1/warehouse/client.rb +6957 -0
  49. data/lib/google/cloud/vision_ai/v1/warehouse/credentials.rb +47 -0
  50. data/lib/google/cloud/vision_ai/v1/warehouse/operations.rb +809 -0
  51. data/lib/google/cloud/vision_ai/v1/warehouse/paths.rb +237 -0
  52. data/lib/google/cloud/vision_ai/v1/warehouse/rest/client.rb +6402 -0
  53. data/lib/google/cloud/vision_ai/v1/warehouse/rest/operations.rb +951 -0
  54. data/lib/google/cloud/vision_ai/v1/warehouse/rest/service_stub.rb +3760 -0
  55. data/lib/google/cloud/vision_ai/v1/warehouse/rest.rb +53 -0
  56. data/lib/google/cloud/vision_ai/v1/warehouse.rb +56 -0
  57. data/lib/google/cloud/vision_ai/v1.rb +50 -0
  58. data/lib/google/cloud/visionai/v1/annotations_pb.rb +90 -0
  59. data/lib/google/cloud/visionai/v1/common_pb.rb +50 -0
  60. data/lib/google/cloud/visionai/v1/health_service_pb.rb +48 -0
  61. data/lib/google/cloud/visionai/v1/health_service_services_pb.rb +46 -0
  62. data/lib/google/cloud/visionai/v1/lva_pb.rb +54 -0
  63. data/lib/google/cloud/visionai/v1/lva_resources_pb.rb +51 -0
  64. data/lib/google/cloud/visionai/v1/lva_service_pb.rb +80 -0
  65. data/lib/google/cloud/visionai/v1/lva_service_services_pb.rb +81 -0
  66. data/lib/google/cloud/visionai/v1/platform_pb.rb +162 -0
  67. data/lib/google/cloud/visionai/v1/platform_services_pb.rb +111 -0
  68. data/lib/google/cloud/visionai/v1/streaming_resources_pb.rb +58 -0
  69. data/lib/google/cloud/visionai/v1/streaming_service_pb.rb +71 -0
  70. data/lib/google/cloud/visionai/v1/streaming_service_services_pb.rb +55 -0
  71. data/lib/google/cloud/visionai/v1/streams_resources_pb.rb +53 -0
  72. data/lib/google/cloud/visionai/v1/streams_service_pb.rb +85 -0
  73. data/lib/google/cloud/visionai/v1/streams_service_services_pb.rb +92 -0
  74. data/lib/google/cloud/visionai/v1/warehouse_pb.rb +250 -0
  75. data/lib/google/cloud/visionai/v1/warehouse_services_pb.rb +227 -0
  76. data/lib/google-cloud-vision_ai-v1.rb +21 -0
  77. data/proto_docs/README.md +4 -0
  78. data/proto_docs/google/api/client.rb +403 -0
  79. data/proto_docs/google/api/field_behavior.rb +85 -0
  80. data/proto_docs/google/api/launch_stage.rb +71 -0
  81. data/proto_docs/google/api/resource.rb +227 -0
  82. data/proto_docs/google/cloud/visionai/v1/annotations.rb +787 -0
  83. data/proto_docs/google/cloud/visionai/v1/common.rb +134 -0
  84. data/proto_docs/google/cloud/visionai/v1/health_service.rb +61 -0
  85. data/proto_docs/google/cloud/visionai/v1/lva.rb +345 -0
  86. data/proto_docs/google/cloud/visionai/v1/lva_resources.rb +167 -0
  87. data/proto_docs/google/cloud/visionai/v1/lva_service.rb +543 -0
  88. data/proto_docs/google/cloud/visionai/v1/platform.rb +2228 -0
  89. data/proto_docs/google/cloud/visionai/v1/streaming_resources.rb +178 -0
  90. data/proto_docs/google/cloud/visionai/v1/streaming_service.rb +393 -0
  91. data/proto_docs/google/cloud/visionai/v1/streams_resources.rb +229 -0
  92. data/proto_docs/google/cloud/visionai/v1/streams_service.rb +644 -0
  93. data/proto_docs/google/cloud/visionai/v1/warehouse.rb +3002 -0
  94. data/proto_docs/google/longrunning/operations.rb +164 -0
  95. data/proto_docs/google/protobuf/any.rb +145 -0
  96. data/proto_docs/google/protobuf/duration.rb +98 -0
  97. data/proto_docs/google/protobuf/empty.rb +34 -0
  98. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  99. data/proto_docs/google/protobuf/struct.rb +96 -0
  100. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  101. data/proto_docs/google/rpc/status.rb +48 -0
  102. data/proto_docs/google/type/datetime.rb +99 -0
  103. data/proto_docs/google/type/expr.rb +75 -0
  104. metadata +183 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c210fa7ca799f71816489490bae23f7e060cc0f2db7ec55452ac1353e61fe07f
4
- data.tar.gz: 3a073dc1af0be8967e29951b9484fc7db5612824b5a90594b7ad7cac01779447
3
+ metadata.gz: 125b7f4c100f03758e1def2cde1fb0a42e6497d782201f48303d34f5ecabd94e
4
+ data.tar.gz: b010e7a3a960c8bacc6b75bbddc66217e1b65485a6460c7ea30bb50df0bfe00d
5
5
  SHA512:
6
- metadata.gz: 14596507630b7083a089149b23274f2076bcf71ac0312429bb7b9bbd376244288007a22d9e00ebc6e6a083f19921e69d956ed1919ec1d35607054f6878ad0e5a
7
- data.tar.gz: 8083e05ff55a38fa4b74160546a8bc320147985c960d25651aa4e00d5e0f22a07f5c9203faa6fdd5e7d3f8116c3ab387435f43be6951c7eae33f05cfed60f284
6
+ metadata.gz: dee75044ec83caa86aadf6a6aa225e599fc3f858ce1fdc52f4b0457e169160f452aa4055200bf0d67042f67ff02cf9639d4d9b4001d65fab611f2a13be3d83d2
7
+ data.tar.gz: 923c98427667de4e41807a43dc12a13ab64fffabc709394f6677cc5bff2677cdca4dc94b4b63dcccfbaa4c577b3024dd44c2a207fcc291890f0b2c54844c51e4
data/.yardopts ADDED
@@ -0,0 +1,12 @@
1
+ --no-private
2
+ --title="Vision AI V1 API"
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ ./proto_docs/**/*.rb
9
+ -
10
+ README.md
11
+ LICENSE.md
12
+ AUTHENTICATION.md
data/AUTHENTICATION.md ADDED
@@ -0,0 +1,122 @@
1
+ # Authentication
2
+
3
+ The recommended way to authenticate to the google-cloud-vision_ai-v1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
6
+
7
+ ## Quickstart
8
+
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
11
+
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
14
+
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
17
+
18
+ ```sh
19
+ gcloud auth application-default login
20
+ ```
21
+
22
+ 3. Write code as if already authenticated.
23
+
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
26
+
27
+ ## Credential Lookup
28
+
29
+ The google-cloud-vision_ai-v1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
33
+
34
+ Credentials are accepted in the following ways, in the following order or precedence:
35
+
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
41
+
42
+ ### Configuration
43
+
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
49
+
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
53
+
54
+ To configure a credentials file for an individual client initialization:
55
+
56
+ ```ruby
57
+ require "google/cloud/vision_ai/v1"
58
+
59
+ client = ::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new do |config|
60
+ config.credentials = "path/to/credentialfile.json"
61
+ end
62
+ ```
63
+
64
+ To configure a credentials file globally for all clients:
65
+
66
+ ```ruby
67
+ require "google/cloud/vision_ai/v1"
68
+
69
+ ::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.configure do |config|
70
+ config.credentials = "path/to/credentialfile.json"
71
+ end
72
+
73
+ client = ::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new
74
+ ```
75
+
76
+ ### Environment Variables
77
+
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
82
+
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
87
+
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-vision_ai-v1
93
+ checks for credentials are:
94
+
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
97
+
98
+ ```ruby
99
+ require "google/cloud/vision_ai/v1"
100
+
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
102
+
103
+ client = ::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new
104
+ ```
105
+
106
+ ### Local ADC file
107
+
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
111
+
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
113
+
114
+ ### Google Cloud Platform environments
115
+
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
120
+
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/README.md CHANGED
@@ -1,8 +1,144 @@
1
- # Placeholder for Ruby gem google-cloud-vision_ai-v1
2
-
3
- This is a placeholder for the future Google-authored gem google-cloud-vision_ai-v1.
4
- This placeholder is being released on 2024-07-18 in order to reserve the name.
5
- The final gem should be available shortly after that date. If it has not been
6
- released in a timely manner, or if this placeholder interferes with your work,
7
- you can contact the Google Ruby team by opening an issue in the GitHub
8
- repository https://github.com/googleapis/google-cloud-ruby.
1
+ # Ruby Client for the Vision AI V1 API
2
+
3
+ API Client library for the Vision AI V1 API
4
+
5
+ google-cloud-vision_ai-v1 is the official client library for the Vision AI V1 API.
6
+
7
+ https://github.com/googleapis/google-cloud-ruby
8
+
9
+ This gem is a _versioned_ client. It provides basic client classes for a
10
+ specific version of the Vision AI V1 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-vision_ai](https://rubygems.org/gems/google-cloud-vision_ai).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
15
+ ## Installation
16
+
17
+ ```
18
+ $ gem install google-cloud-vision_ai-v1
19
+ ```
20
+
21
+ ## Before You Begin
22
+
23
+ In order to use this library, you first need to go through the following steps:
24
+
25
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
26
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
27
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/visionai.googleapis.com)
28
+ 1. {file:AUTHENTICATION.md Set up authentication.}
29
+
30
+ ## Quick Start
31
+
32
+ ```ruby
33
+ require "google/cloud/vision_ai/v1"
34
+
35
+ client = ::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new
36
+ request = ::Google::Cloud::VisionAI::V1::ListPublicOperatorsRequest.new # (request fields as keyword arguments...)
37
+ response = client.list_public_operators request
38
+ ```
39
+
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-vision_ai-v1/latest)
41
+ for class and method documentation.
42
+
43
+ See also the [Product Documentation](https://cloud.google.com/vision-ai/docs)
44
+ for general usage information.
45
+
46
+ ## Enabling Logging
47
+
48
+ To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
+ or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
+ that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
+ and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
+
54
+ Configuring a Ruby stdlib logger:
55
+
56
+ ```ruby
57
+ require "logger"
58
+
59
+ module MyLogger
60
+ LOGGER = Logger.new $stderr, level: Logger::WARN
61
+ def logger
62
+ LOGGER
63
+ end
64
+ end
65
+
66
+ # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
+ module GRPC
68
+ extend MyLogger
69
+ end
70
+ ```
71
+
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
77
+ ## Supported Ruby Versions
78
+
79
+ This library is supported on Ruby 2.7+.
80
+
81
+ Google provides official support for Ruby versions that are actively supported
82
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
83
+ in security maintenance, and not end of life. Older versions of Ruby _may_
84
+ still work, but are unsupported and not recommended. See
85
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
86
+ support schedule.
87
+
88
+ ## Which client should I use?
89
+
90
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
91
+ client library with a name such as `google-cloud-vision_ai`,
92
+ and lower-level _versioned_ client libraries with names such as
93
+ `google-cloud-vision_ai-v1`.
94
+ _In most cases, you should install the main client._
95
+
96
+ ### What's the difference between the main client and a versioned client?
97
+
98
+ A _versioned client_ provides a basic set of data types and client classes for
99
+ a _single version_ of a specific service. (That is, for a service with multiple
100
+ versions, there might be a separate versioned client for each service version.)
101
+ Most versioned clients are written and maintained by a code generator.
102
+
103
+ The _main client_ is designed to provide you with the _recommended_ client
104
+ interfaces for the service. There will be only one main client for any given
105
+ service, even a service with multiple versions. The main client includes
106
+ factory methods for constructing the client objects we recommend for most
107
+ users. In some cases, those will be classes provided by an underlying versioned
108
+ client; in other cases, they will be handwritten higher-level client objects
109
+ with additional capabilities, convenience methods, or best practices built in.
110
+ Generally, the main client will default to a recommended service version,
111
+ although in some cases you can override this if you need to talk to a specific
112
+ service version.
113
+
114
+ ### Why would I want to use the main client?
115
+
116
+ We recommend that most users install the main client gem for a service. You can
117
+ identify this gem as the one _without_ a version in its name, e.g.
118
+ `google-cloud-vision_ai`.
119
+ The main client is recommended because it will embody the best practices for
120
+ accessing the service, and may also provide more convenient interfaces or
121
+ tighter integration into frameworks and third-party libraries. In addition, the
122
+ documentation and samples published by Google will generally demonstrate use of
123
+ the main client.
124
+
125
+ ### Why would I want to use a versioned client?
126
+
127
+ You can use a versioned client if you are content with a possibly lower-level
128
+ class interface, you explicitly want to avoid features provided by the main
129
+ client, or you want to access a specific service version not be covered by the
130
+ main client. You can identify versioned client gems because the service version
131
+ is part of the name, e.g. `google-cloud-vision_ai-v1`.
132
+
133
+ ### What about the google-apis-<name> clients?
134
+
135
+ Client library gems with names that begin with `google-apis-` are based on an
136
+ older code generation technology. They talk to a REST/JSON backend (whereas
137
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
138
+ not offer the same performance, features, and ease of use provided by more
139
+ modern clients.
140
+
141
+ The `google-apis-` clients have wide coverage across Google services, so you
142
+ might need to use one if there is no modern client available for the service.
143
+ However, if a modern client is available, we generally recommend it over the
144
+ older `google-apis-` clients.