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
@@ -0,0 +1,227 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/visionai/v1/warehouse.proto for package 'Google.Cloud.VisionAI.V1'
3
+ # Original file comments:
4
+ # Copyright 2024 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/cloud/visionai/v1/warehouse_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module VisionAI
25
+ module V1
26
+ module Warehouse
27
+ # Service that manages media content + metadata for streaming.
28
+ class Service
29
+
30
+ include ::GRPC::GenericService
31
+
32
+ self.marshal_class_method = :encode
33
+ self.unmarshal_class_method = :decode
34
+ self.service_name = 'google.cloud.visionai.v1.Warehouse'
35
+
36
+ # Creates an asset inside corpus.
37
+ rpc :CreateAsset, ::Google::Cloud::VisionAI::V1::CreateAssetRequest, ::Google::Cloud::VisionAI::V1::Asset
38
+ # Updates an asset inside corpus.
39
+ rpc :UpdateAsset, ::Google::Cloud::VisionAI::V1::UpdateAssetRequest, ::Google::Cloud::VisionAI::V1::Asset
40
+ # Reads an asset inside corpus.
41
+ rpc :GetAsset, ::Google::Cloud::VisionAI::V1::GetAssetRequest, ::Google::Cloud::VisionAI::V1::Asset
42
+ # Lists an list of assets inside corpus.
43
+ rpc :ListAssets, ::Google::Cloud::VisionAI::V1::ListAssetsRequest, ::Google::Cloud::VisionAI::V1::ListAssetsResponse
44
+ # Deletes asset inside corpus.
45
+ rpc :DeleteAsset, ::Google::Cloud::VisionAI::V1::DeleteAssetRequest, ::Google::Longrunning::Operation
46
+ # Upload asset by specifing the asset Cloud Storage uri.
47
+ # For video warehouse, it requires users who call this API have read access
48
+ # to the cloud storage file. Once it is uploaded, it can be retrieved by
49
+ # GenerateRetrievalUrl API which by default, only can retrieve cloud storage
50
+ # files from the same project of the warehouse. To allow retrieval cloud
51
+ # storage files that are in a separate project, it requires to find the
52
+ # vision ai service account (Go to IAM, check checkbox to show "Include
53
+ # Google-provided role grants", search for "Cloud Vision AI Service Agent")
54
+ # and grant the read access of the cloud storage files to that service
55
+ # account.
56
+ rpc :UploadAsset, ::Google::Cloud::VisionAI::V1::UploadAssetRequest, ::Google::Longrunning::Operation
57
+ # Generates a signed url for downloading the asset.
58
+ # For video warehouse, please see comment of UploadAsset about how to allow
59
+ # retrieval of cloud storage files in a different project.
60
+ rpc :GenerateRetrievalUrl, ::Google::Cloud::VisionAI::V1::GenerateRetrievalUrlRequest, ::Google::Cloud::VisionAI::V1::GenerateRetrievalUrlResponse
61
+ # Analyze asset to power search capability.
62
+ rpc :AnalyzeAsset, ::Google::Cloud::VisionAI::V1::AnalyzeAssetRequest, ::Google::Longrunning::Operation
63
+ # Index one asset for search.
64
+ # Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
65
+ rpc :IndexAsset, ::Google::Cloud::VisionAI::V1::IndexAssetRequest, ::Google::Longrunning::Operation
66
+ # Remove one asset's index data for search.
67
+ # Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND
68
+ rpc :RemoveIndexAsset, ::Google::Cloud::VisionAI::V1::RemoveIndexAssetRequest, ::Google::Longrunning::Operation
69
+ # Lists assets inside an index.
70
+ rpc :ViewIndexedAssets, ::Google::Cloud::VisionAI::V1::ViewIndexedAssetsRequest, ::Google::Cloud::VisionAI::V1::ViewIndexedAssetsResponse
71
+ # Creates an Index under the corpus.
72
+ rpc :CreateIndex, ::Google::Cloud::VisionAI::V1::CreateIndexRequest, ::Google::Longrunning::Operation
73
+ # Updates an Index under the corpus.
74
+ # Users can perform a metadata-only update or trigger a full index rebuild
75
+ # with different update_mask values.
76
+ rpc :UpdateIndex, ::Google::Cloud::VisionAI::V1::UpdateIndexRequest, ::Google::Longrunning::Operation
77
+ # Gets the details of a single Index under a Corpus.
78
+ rpc :GetIndex, ::Google::Cloud::VisionAI::V1::GetIndexRequest, ::Google::Cloud::VisionAI::V1::Index
79
+ # List all Indexes in a given Corpus.
80
+ rpc :ListIndexes, ::Google::Cloud::VisionAI::V1::ListIndexesRequest, ::Google::Cloud::VisionAI::V1::ListIndexesResponse
81
+ # Delete a single Index. In order to delete an index, the caller must
82
+ # make sure that it is not deployed to any index endpoint.
83
+ rpc :DeleteIndex, ::Google::Cloud::VisionAI::V1::DeleteIndexRequest, ::Google::Longrunning::Operation
84
+ # Creates a corpus inside a project.
85
+ rpc :CreateCorpus, ::Google::Cloud::VisionAI::V1::CreateCorpusRequest, ::Google::Longrunning::Operation
86
+ # Gets corpus details inside a project.
87
+ rpc :GetCorpus, ::Google::Cloud::VisionAI::V1::GetCorpusRequest, ::Google::Cloud::VisionAI::V1::Corpus
88
+ # Updates a corpus in a project.
89
+ rpc :UpdateCorpus, ::Google::Cloud::VisionAI::V1::UpdateCorpusRequest, ::Google::Cloud::VisionAI::V1::Corpus
90
+ # Lists all corpora in a project.
91
+ rpc :ListCorpora, ::Google::Cloud::VisionAI::V1::ListCorporaRequest, ::Google::Cloud::VisionAI::V1::ListCorporaResponse
92
+ # Deletes a corpus only if its empty.
93
+ # Returns empty response.
94
+ rpc :DeleteCorpus, ::Google::Cloud::VisionAI::V1::DeleteCorpusRequest, ::Google::Protobuf::Empty
95
+ # Analyzes a corpus.
96
+ rpc :AnalyzeCorpus, ::Google::Cloud::VisionAI::V1::AnalyzeCorpusRequest, ::Google::Longrunning::Operation
97
+ # Creates data schema inside corpus.
98
+ rpc :CreateDataSchema, ::Google::Cloud::VisionAI::V1::CreateDataSchemaRequest, ::Google::Cloud::VisionAI::V1::DataSchema
99
+ # Updates data schema inside corpus.
100
+ rpc :UpdateDataSchema, ::Google::Cloud::VisionAI::V1::UpdateDataSchemaRequest, ::Google::Cloud::VisionAI::V1::DataSchema
101
+ # Gets data schema inside corpus.
102
+ rpc :GetDataSchema, ::Google::Cloud::VisionAI::V1::GetDataSchemaRequest, ::Google::Cloud::VisionAI::V1::DataSchema
103
+ # Deletes data schema inside corpus.
104
+ rpc :DeleteDataSchema, ::Google::Cloud::VisionAI::V1::DeleteDataSchemaRequest, ::Google::Protobuf::Empty
105
+ # Lists a list of data schemas inside corpus.
106
+ rpc :ListDataSchemas, ::Google::Cloud::VisionAI::V1::ListDataSchemasRequest, ::Google::Cloud::VisionAI::V1::ListDataSchemasResponse
107
+ # Creates annotation inside asset.
108
+ rpc :CreateAnnotation, ::Google::Cloud::VisionAI::V1::CreateAnnotationRequest, ::Google::Cloud::VisionAI::V1::Annotation
109
+ # Reads annotation inside asset.
110
+ rpc :GetAnnotation, ::Google::Cloud::VisionAI::V1::GetAnnotationRequest, ::Google::Cloud::VisionAI::V1::Annotation
111
+ # Lists a list of annotations inside asset.
112
+ rpc :ListAnnotations, ::Google::Cloud::VisionAI::V1::ListAnnotationsRequest, ::Google::Cloud::VisionAI::V1::ListAnnotationsResponse
113
+ # Updates annotation inside asset.
114
+ rpc :UpdateAnnotation, ::Google::Cloud::VisionAI::V1::UpdateAnnotationRequest, ::Google::Cloud::VisionAI::V1::Annotation
115
+ # Deletes annotation inside asset.
116
+ rpc :DeleteAnnotation, ::Google::Cloud::VisionAI::V1::DeleteAnnotationRequest, ::Google::Protobuf::Empty
117
+ # Ingests data for the asset. It is not allowed to ingest a data chunk which
118
+ # is already expired according to TTL.
119
+ # This method is only available via the gRPC API (not HTTP since
120
+ # bi-directional streaming is not supported via HTTP).
121
+ rpc :IngestAsset, stream(::Google::Cloud::VisionAI::V1::IngestAssetRequest), stream(::Google::Cloud::VisionAI::V1::IngestAssetResponse)
122
+ # Generates clips for downloading. The api takes in a time range, and
123
+ # generates a clip of the first content available after start_time and
124
+ # before end_time, which may overflow beyond these bounds.
125
+ # Returned clips are truncated if the total size of the clips are larger
126
+ # than 100MB.
127
+ rpc :ClipAsset, ::Google::Cloud::VisionAI::V1::ClipAssetRequest, ::Google::Cloud::VisionAI::V1::ClipAssetResponse
128
+ # Generates a uri for an HLS manifest. The api takes in a collection of time
129
+ # ranges, and generates a URI for an HLS manifest that covers all the
130
+ # requested time ranges.
131
+ rpc :GenerateHlsUri, ::Google::Cloud::VisionAI::V1::GenerateHlsUriRequest, ::Google::Cloud::VisionAI::V1::GenerateHlsUriResponse
132
+ # Imports assets (images plus annotations) from a meta file on cloud storage.
133
+ # Each row in the meta file is corresponding to an image (specified by a
134
+ # cloud storage uri) and its annotations.
135
+ rpc :ImportAssets, ::Google::Cloud::VisionAI::V1::ImportAssetsRequest, ::Google::Longrunning::Operation
136
+ # Creates a search configuration inside a corpus.
137
+ #
138
+ # Please follow the rules below to create a valid CreateSearchConfigRequest.
139
+ # --- General Rules ---
140
+ # 1. Request.search_config_id must not be associated with an existing
141
+ # SearchConfig.
142
+ # 2. Request must contain at least one non-empty search_criteria_property or
143
+ # facet_property.
144
+ # 3. mapped_fields must not be empty, and must map to existing UGA keys.
145
+ # 4. All mapped_fields must be of the same type.
146
+ # 5. All mapped_fields must share the same granularity.
147
+ # 6. All mapped_fields must share the same semantic SearchConfig match
148
+ # options.
149
+ # For property-specific rules, please reference the comments for
150
+ # FacetProperty and SearchCriteriaProperty.
151
+ rpc :CreateSearchConfig, ::Google::Cloud::VisionAI::V1::CreateSearchConfigRequest, ::Google::Cloud::VisionAI::V1::SearchConfig
152
+ # Updates a search configuration inside a corpus.
153
+ #
154
+ # Please follow the rules below to create a valid UpdateSearchConfigRequest.
155
+ # --- General Rules ---
156
+ # 1. Request.search_configuration.name must already exist.
157
+ # 2. Request must contain at least one non-empty search_criteria_property or
158
+ # facet_property.
159
+ # 3. mapped_fields must not be empty, and must map to existing UGA keys.
160
+ # 4. All mapped_fields must be of the same type.
161
+ # 5. All mapped_fields must share the same granularity.
162
+ # 6. All mapped_fields must share the same semantic SearchConfig match
163
+ # options.
164
+ # For property-specific rules, please reference the comments for
165
+ # FacetProperty and SearchCriteriaProperty.
166
+ rpc :UpdateSearchConfig, ::Google::Cloud::VisionAI::V1::UpdateSearchConfigRequest, ::Google::Cloud::VisionAI::V1::SearchConfig
167
+ # Gets a search configuration inside a corpus.
168
+ rpc :GetSearchConfig, ::Google::Cloud::VisionAI::V1::GetSearchConfigRequest, ::Google::Cloud::VisionAI::V1::SearchConfig
169
+ # Deletes a search configuration inside a corpus.
170
+ #
171
+ # For a DeleteSearchConfigRequest to be valid,
172
+ # Request.search_configuration.name must already exist.
173
+ rpc :DeleteSearchConfig, ::Google::Cloud::VisionAI::V1::DeleteSearchConfigRequest, ::Google::Protobuf::Empty
174
+ # Lists all search configurations inside a corpus.
175
+ rpc :ListSearchConfigs, ::Google::Cloud::VisionAI::V1::ListSearchConfigsRequest, ::Google::Cloud::VisionAI::V1::ListSearchConfigsResponse
176
+ # Creates a SearchHypernym inside a corpus.
177
+ rpc :CreateSearchHypernym, ::Google::Cloud::VisionAI::V1::CreateSearchHypernymRequest, ::Google::Cloud::VisionAI::V1::SearchHypernym
178
+ # Updates a SearchHypernym inside a corpus.
179
+ rpc :UpdateSearchHypernym, ::Google::Cloud::VisionAI::V1::UpdateSearchHypernymRequest, ::Google::Cloud::VisionAI::V1::SearchHypernym
180
+ # Gets a SearchHypernym inside a corpus.
181
+ rpc :GetSearchHypernym, ::Google::Cloud::VisionAI::V1::GetSearchHypernymRequest, ::Google::Cloud::VisionAI::V1::SearchHypernym
182
+ # Deletes a SearchHypernym inside a corpus.
183
+ rpc :DeleteSearchHypernym, ::Google::Cloud::VisionAI::V1::DeleteSearchHypernymRequest, ::Google::Protobuf::Empty
184
+ # Lists SearchHypernyms inside a corpus.
185
+ rpc :ListSearchHypernyms, ::Google::Cloud::VisionAI::V1::ListSearchHypernymsRequest, ::Google::Cloud::VisionAI::V1::ListSearchHypernymsResponse
186
+ # Search media asset.
187
+ rpc :SearchAssets, ::Google::Cloud::VisionAI::V1::SearchAssetsRequest, ::Google::Cloud::VisionAI::V1::SearchAssetsResponse
188
+ # Search a deployed index endpoint (IMAGE corpus type only).
189
+ rpc :SearchIndexEndpoint, ::Google::Cloud::VisionAI::V1::SearchIndexEndpointRequest, ::Google::Cloud::VisionAI::V1::SearchIndexEndpointResponse
190
+ # Creates an IndexEndpoint.
191
+ rpc :CreateIndexEndpoint, ::Google::Cloud::VisionAI::V1::CreateIndexEndpointRequest, ::Google::Longrunning::Operation
192
+ # Gets an IndexEndpoint.
193
+ rpc :GetIndexEndpoint, ::Google::Cloud::VisionAI::V1::GetIndexEndpointRequest, ::Google::Cloud::VisionAI::V1::IndexEndpoint
194
+ # Lists all IndexEndpoints in a project.
195
+ rpc :ListIndexEndpoints, ::Google::Cloud::VisionAI::V1::ListIndexEndpointsRequest, ::Google::Cloud::VisionAI::V1::ListIndexEndpointsResponse
196
+ # Updates an IndexEndpoint.
197
+ rpc :UpdateIndexEndpoint, ::Google::Cloud::VisionAI::V1::UpdateIndexEndpointRequest, ::Google::Longrunning::Operation
198
+ # Deletes an IndexEndpoint.
199
+ rpc :DeleteIndexEndpoint, ::Google::Cloud::VisionAI::V1::DeleteIndexEndpointRequest, ::Google::Longrunning::Operation
200
+ # Deploys an Index to IndexEndpoint.
201
+ rpc :DeployIndex, ::Google::Cloud::VisionAI::V1::DeployIndexRequest, ::Google::Longrunning::Operation
202
+ # Undeploys an Index from IndexEndpoint.
203
+ rpc :UndeployIndex, ::Google::Cloud::VisionAI::V1::UndeployIndexRequest, ::Google::Longrunning::Operation
204
+ # Creates a collection.
205
+ rpc :CreateCollection, ::Google::Cloud::VisionAI::V1::CreateCollectionRequest, ::Google::Longrunning::Operation
206
+ # Deletes a collection.
207
+ rpc :DeleteCollection, ::Google::Cloud::VisionAI::V1::DeleteCollectionRequest, ::Google::Longrunning::Operation
208
+ # Gets a collection.
209
+ rpc :GetCollection, ::Google::Cloud::VisionAI::V1::GetCollectionRequest, ::Google::Cloud::VisionAI::V1::Collection
210
+ # Updates a collection.
211
+ rpc :UpdateCollection, ::Google::Cloud::VisionAI::V1::UpdateCollectionRequest, ::Google::Cloud::VisionAI::V1::Collection
212
+ # Lists collections inside a corpus.
213
+ rpc :ListCollections, ::Google::Cloud::VisionAI::V1::ListCollectionsRequest, ::Google::Cloud::VisionAI::V1::ListCollectionsResponse
214
+ # Adds an item into a Collection.
215
+ rpc :AddCollectionItem, ::Google::Cloud::VisionAI::V1::AddCollectionItemRequest, ::Google::Cloud::VisionAI::V1::AddCollectionItemResponse
216
+ # Removes an item from a collection.
217
+ rpc :RemoveCollectionItem, ::Google::Cloud::VisionAI::V1::RemoveCollectionItemRequest, ::Google::Cloud::VisionAI::V1::RemoveCollectionItemResponse
218
+ # View items inside a collection.
219
+ rpc :ViewCollectionItems, ::Google::Cloud::VisionAI::V1::ViewCollectionItemsRequest, ::Google::Cloud::VisionAI::V1::ViewCollectionItemsResponse
220
+ end
221
+
222
+ Stub = Service.rpc_stub_class
223
+ end
224
+ end
225
+ end
226
+ end
227
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/cloud/vision_ai/v1"
@@ -0,0 +1,4 @@
1
+ # Vision AI V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,403 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
25
+ # @return [::String]
26
+ # Link to automatically generated reference documentation. Example:
27
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
28
+ # @!attribute [rw] destinations
29
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
+ # The destination where API teams want this client library to be published.
31
+ class CommonLanguageSettings
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+ end
35
+
36
+ # Details about how and where to publish client libraries.
37
+ # @!attribute [rw] version
38
+ # @return [::String]
39
+ # Version of the API to apply these settings to. This is the full protobuf
40
+ # package for the API, ending in the version element.
41
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
42
+ # @!attribute [rw] launch_stage
43
+ # @return [::Google::Api::LaunchStage]
44
+ # Launch stage of this version of the API.
45
+ # @!attribute [rw] rest_numeric_enums
46
+ # @return [::Boolean]
47
+ # When using transport=rest, the client request will encode enums as
48
+ # numbers rather than strings.
49
+ # @!attribute [rw] java_settings
50
+ # @return [::Google::Api::JavaSettings]
51
+ # Settings for legacy Java features, supported in the Service YAML.
52
+ # @!attribute [rw] cpp_settings
53
+ # @return [::Google::Api::CppSettings]
54
+ # Settings for C++ client libraries.
55
+ # @!attribute [rw] php_settings
56
+ # @return [::Google::Api::PhpSettings]
57
+ # Settings for PHP client libraries.
58
+ # @!attribute [rw] python_settings
59
+ # @return [::Google::Api::PythonSettings]
60
+ # Settings for Python client libraries.
61
+ # @!attribute [rw] node_settings
62
+ # @return [::Google::Api::NodeSettings]
63
+ # Settings for Node client libraries.
64
+ # @!attribute [rw] dotnet_settings
65
+ # @return [::Google::Api::DotnetSettings]
66
+ # Settings for .NET client libraries.
67
+ # @!attribute [rw] ruby_settings
68
+ # @return [::Google::Api::RubySettings]
69
+ # Settings for Ruby client libraries.
70
+ # @!attribute [rw] go_settings
71
+ # @return [::Google::Api::GoSettings]
72
+ # Settings for Go client libraries.
73
+ class ClientLibrarySettings
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+
78
+ # This message configures the settings for publishing [Google Cloud Client
79
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
80
+ # generated from the service config.
81
+ # @!attribute [rw] method_settings
82
+ # @return [::Array<::Google::Api::MethodSettings>]
83
+ # A list of API method settings, e.g. the behavior for methods that use the
84
+ # long-running operation pattern.
85
+ # @!attribute [rw] new_issue_uri
86
+ # @return [::String]
87
+ # Link to a *public* URI where users can report issues. Example:
88
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
89
+ # @!attribute [rw] documentation_uri
90
+ # @return [::String]
91
+ # Link to product home page. Example:
92
+ # https://cloud.google.com/asset-inventory/docs/overview
93
+ # @!attribute [rw] api_short_name
94
+ # @return [::String]
95
+ # Used as a tracking tag when collecting data about the APIs developer
96
+ # relations artifacts like docs, packages delivered to package managers,
97
+ # etc. Example: "speech".
98
+ # @!attribute [rw] github_label
99
+ # @return [::String]
100
+ # GitHub label to apply to issues and pull requests opened for this API.
101
+ # @!attribute [rw] codeowner_github_teams
102
+ # @return [::Array<::String>]
103
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
104
+ # containing source code for the client libraries for this API.
105
+ # @!attribute [rw] doc_tag_prefix
106
+ # @return [::String]
107
+ # A prefix used in sample code when demarking regions to be included in
108
+ # documentation.
109
+ # @!attribute [rw] organization
110
+ # @return [::Google::Api::ClientLibraryOrganization]
111
+ # For whom the client library is being published.
112
+ # @!attribute [rw] library_settings
113
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
114
+ # Client library settings. If the same version string appears multiple
115
+ # times in this list, then the last one wins. Settings from earlier
116
+ # settings with the same version string are discarded.
117
+ # @!attribute [rw] proto_reference_documentation_uri
118
+ # @return [::String]
119
+ # Optional link to proto reference documentation. Example:
120
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
121
+ # @!attribute [rw] rest_reference_documentation_uri
122
+ # @return [::String]
123
+ # Optional link to REST reference documentation. Example:
124
+ # https://cloud.google.com/pubsub/lite/docs/reference/rest
125
+ class Publishing
126
+ include ::Google::Protobuf::MessageExts
127
+ extend ::Google::Protobuf::MessageExts::ClassMethods
128
+ end
129
+
130
+ # Settings for Java client libraries.
131
+ # @!attribute [rw] library_package
132
+ # @return [::String]
133
+ # The package name to use in Java. Clobbers the java_package option
134
+ # set in the protobuf. This should be used **only** by APIs
135
+ # who have already set the language_settings.java.package_name" field
136
+ # in gapic.yaml. API teams should use the protobuf java_package option
137
+ # where possible.
138
+ #
139
+ # Example of a YAML configuration::
140
+ #
141
+ # publishing:
142
+ # java_settings:
143
+ # library_package: com.google.cloud.pubsub.v1
144
+ # @!attribute [rw] service_class_names
145
+ # @return [::Google::Protobuf::Map{::String => ::String}]
146
+ # Configure the Java class name to use instead of the service's for its
147
+ # corresponding generated GAPIC client. Keys are fully-qualified
148
+ # service names as they appear in the protobuf (including the full
149
+ # the language_settings.java.interface_names" field in gapic.yaml. API
150
+ # teams should otherwise use the service name as it appears in the
151
+ # protobuf.
152
+ #
153
+ # Example of a YAML configuration::
154
+ #
155
+ # publishing:
156
+ # java_settings:
157
+ # service_class_names:
158
+ # - google.pubsub.v1.Publisher: TopicAdmin
159
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
160
+ # @!attribute [rw] common
161
+ # @return [::Google::Api::CommonLanguageSettings]
162
+ # Some settings.
163
+ class JavaSettings
164
+ include ::Google::Protobuf::MessageExts
165
+ extend ::Google::Protobuf::MessageExts::ClassMethods
166
+
167
+ # @!attribute [rw] key
168
+ # @return [::String]
169
+ # @!attribute [rw] value
170
+ # @return [::String]
171
+ class ServiceClassNamesEntry
172
+ include ::Google::Protobuf::MessageExts
173
+ extend ::Google::Protobuf::MessageExts::ClassMethods
174
+ end
175
+ end
176
+
177
+ # Settings for C++ client libraries.
178
+ # @!attribute [rw] common
179
+ # @return [::Google::Api::CommonLanguageSettings]
180
+ # Some settings.
181
+ class CppSettings
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
+ end
185
+
186
+ # Settings for Php client libraries.
187
+ # @!attribute [rw] common
188
+ # @return [::Google::Api::CommonLanguageSettings]
189
+ # Some settings.
190
+ class PhpSettings
191
+ include ::Google::Protobuf::MessageExts
192
+ extend ::Google::Protobuf::MessageExts::ClassMethods
193
+ end
194
+
195
+ # Settings for Python client libraries.
196
+ # @!attribute [rw] common
197
+ # @return [::Google::Api::CommonLanguageSettings]
198
+ # Some settings.
199
+ class PythonSettings
200
+ include ::Google::Protobuf::MessageExts
201
+ extend ::Google::Protobuf::MessageExts::ClassMethods
202
+ end
203
+
204
+ # Settings for Node client libraries.
205
+ # @!attribute [rw] common
206
+ # @return [::Google::Api::CommonLanguageSettings]
207
+ # Some settings.
208
+ class NodeSettings
209
+ include ::Google::Protobuf::MessageExts
210
+ extend ::Google::Protobuf::MessageExts::ClassMethods
211
+ end
212
+
213
+ # Settings for Dotnet client libraries.
214
+ # @!attribute [rw] common
215
+ # @return [::Google::Api::CommonLanguageSettings]
216
+ # Some settings.
217
+ # @!attribute [rw] renamed_services
218
+ # @return [::Google::Protobuf::Map{::String => ::String}]
219
+ # Map from original service names to renamed versions.
220
+ # This is used when the default generated types
221
+ # would cause a naming conflict. (Neither name is
222
+ # fully-qualified.)
223
+ # Example: Subscriber to SubscriberServiceApi.
224
+ # @!attribute [rw] renamed_resources
225
+ # @return [::Google::Protobuf::Map{::String => ::String}]
226
+ # Map from full resource types to the effective short name
227
+ # for the resource. This is used when otherwise resource
228
+ # named from different services would cause naming collisions.
229
+ # Example entry:
230
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
231
+ # @!attribute [rw] ignored_resources
232
+ # @return [::Array<::String>]
233
+ # List of full resource types to ignore during generation.
234
+ # This is typically used for API-specific Location resources,
235
+ # which should be handled by the generator as if they were actually
236
+ # the common Location resources.
237
+ # Example entry: "documentai.googleapis.com/Location"
238
+ # @!attribute [rw] forced_namespace_aliases
239
+ # @return [::Array<::String>]
240
+ # Namespaces which must be aliased in snippets due to
241
+ # a known (but non-generator-predictable) naming collision
242
+ # @!attribute [rw] handwritten_signatures
243
+ # @return [::Array<::String>]
244
+ # Method signatures (in the form "service.method(signature)")
245
+ # which are provided separately, so shouldn't be generated.
246
+ # Snippets *calling* these methods are still generated, however.
247
+ class DotnetSettings
248
+ include ::Google::Protobuf::MessageExts
249
+ extend ::Google::Protobuf::MessageExts::ClassMethods
250
+
251
+ # @!attribute [rw] key
252
+ # @return [::String]
253
+ # @!attribute [rw] value
254
+ # @return [::String]
255
+ class RenamedServicesEntry
256
+ include ::Google::Protobuf::MessageExts
257
+ extend ::Google::Protobuf::MessageExts::ClassMethods
258
+ end
259
+
260
+ # @!attribute [rw] key
261
+ # @return [::String]
262
+ # @!attribute [rw] value
263
+ # @return [::String]
264
+ class RenamedResourcesEntry
265
+ include ::Google::Protobuf::MessageExts
266
+ extend ::Google::Protobuf::MessageExts::ClassMethods
267
+ end
268
+ end
269
+
270
+ # Settings for Ruby client libraries.
271
+ # @!attribute [rw] common
272
+ # @return [::Google::Api::CommonLanguageSettings]
273
+ # Some settings.
274
+ class RubySettings
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
+ end
278
+
279
+ # Settings for Go client libraries.
280
+ # @!attribute [rw] common
281
+ # @return [::Google::Api::CommonLanguageSettings]
282
+ # Some settings.
283
+ class GoSettings
284
+ include ::Google::Protobuf::MessageExts
285
+ extend ::Google::Protobuf::MessageExts::ClassMethods
286
+ end
287
+
288
+ # Describes the generator configuration for a method.
289
+ # @!attribute [rw] selector
290
+ # @return [::String]
291
+ # The fully qualified name of the method, for which the options below apply.
292
+ # This is used to find the method to apply the options.
293
+ #
294
+ # Example:
295
+ #
296
+ # publishing:
297
+ # method_settings:
298
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
299
+ # # method settings for CreateFolder...
300
+ # @!attribute [rw] long_running
301
+ # @return [::Google::Api::MethodSettings::LongRunning]
302
+ # Describes settings to use for long-running operations when generating
303
+ # API methods for RPCs. Complements RPCs that use the annotations in
304
+ # google/longrunning/operations.proto.
305
+ #
306
+ # Example of a YAML configuration::
307
+ #
308
+ # publishing:
309
+ # method_settings:
310
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
311
+ # long_running:
312
+ # initial_poll_delay: 60s # 1 minute
313
+ # poll_delay_multiplier: 1.5
314
+ # max_poll_delay: 360s # 6 minutes
315
+ # total_poll_timeout: 54000s # 90 minutes
316
+ # @!attribute [rw] auto_populated_fields
317
+ # @return [::Array<::String>]
318
+ # List of top-level fields of the request message, that should be
319
+ # automatically populated by the client libraries based on their
320
+ # (google.api.field_info).format. Currently supported format: UUID4.
321
+ #
322
+ # Example of a YAML configuration:
323
+ #
324
+ # publishing:
325
+ # method_settings:
326
+ # - selector: google.example.v1.ExampleService.CreateExample
327
+ # auto_populated_fields:
328
+ # - request_id
329
+ class MethodSettings
330
+ include ::Google::Protobuf::MessageExts
331
+ extend ::Google::Protobuf::MessageExts::ClassMethods
332
+
333
+ # Describes settings to use when generating API methods that use the
334
+ # long-running operation pattern.
335
+ # All default values below are from those used in the client library
336
+ # generators (e.g.
337
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
338
+ # @!attribute [rw] initial_poll_delay
339
+ # @return [::Google::Protobuf::Duration]
340
+ # Initial delay after which the first poll request will be made.
341
+ # Default value: 5 seconds.
342
+ # @!attribute [rw] poll_delay_multiplier
343
+ # @return [::Float]
344
+ # Multiplier to gradually increase delay between subsequent polls until it
345
+ # reaches max_poll_delay.
346
+ # Default value: 1.5.
347
+ # @!attribute [rw] max_poll_delay
348
+ # @return [::Google::Protobuf::Duration]
349
+ # Maximum time between two subsequent poll requests.
350
+ # Default value: 45 seconds.
351
+ # @!attribute [rw] total_poll_timeout
352
+ # @return [::Google::Protobuf::Duration]
353
+ # Total polling timeout.
354
+ # Default value: 5 minutes.
355
+ class LongRunning
356
+ include ::Google::Protobuf::MessageExts
357
+ extend ::Google::Protobuf::MessageExts::ClassMethods
358
+ end
359
+ end
360
+
361
+ # The organization for which the client libraries are being published.
362
+ # Affects the url where generated docs are published, etc.
363
+ module ClientLibraryOrganization
364
+ # Not useful.
365
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
366
+
367
+ # Google Cloud Platform Org.
368
+ CLOUD = 1
369
+
370
+ # Ads (Advertising) Org.
371
+ ADS = 2
372
+
373
+ # Photos Org.
374
+ PHOTOS = 3
375
+
376
+ # Street View Org.
377
+ STREET_VIEW = 4
378
+
379
+ # Shopping Org.
380
+ SHOPPING = 5
381
+
382
+ # Geo Org.
383
+ GEO = 6
384
+
385
+ # Generative AI - https://developers.generativeai.google
386
+ GENERATIVE_AI = 7
387
+ end
388
+
389
+ # To where should client libraries be published?
390
+ module ClientLibraryDestination
391
+ # Client libraries will neither be generated nor published to package
392
+ # managers.
393
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
394
+
395
+ # Generate the client library in a repo under github.com/googleapis,
396
+ # but don't publish it to package managers.
397
+ GITHUB = 10
398
+
399
+ # Publish the library to package managers like nuget.org and npmjs.com.
400
+ PACKAGE_MANAGER = 20
401
+ end
402
+ end
403
+ end