google-cloud-ai_platform-v1 0.14.0 → 0.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +157 -0
  4. data/lib/google/cloud/ai_platform/v1/dataset_service/paths.rb +21 -0
  5. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +103 -0
  6. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +9 -1
  7. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  8. data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +1 -0
  9. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +1 -0
  10. data/lib/google/cloud/aiplatform/v1/dataset_service_pb.rb +34 -0
  11. data/lib/google/cloud/aiplatform/v1/dataset_service_services_pb.rb +2 -0
  12. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb +13 -0
  13. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_services_pb.rb +6 -0
  14. data/lib/google/cloud/aiplatform/v1/featurestore_service_pb.rb +1 -0
  15. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +1 -0
  16. data/proto_docs/google/api/client.rb +318 -0
  17. data/proto_docs/google/api/launch_stage.rb +71 -0
  18. data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +1 -1
  19. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +10 -1
  20. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +1 -1
  21. data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +1 -1
  22. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +7 -2
  23. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +129 -0
  24. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +1 -1
  25. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +47 -0
  26. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +3 -0
  27. data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +1 -1
  28. data/proto_docs/google/cloud/aiplatform/v1/index.rb +1 -1
  29. data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +1 -1
  30. data/proto_docs/google/cloud/aiplatform/v1/model.rb +1 -1
  31. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +1 -1
  32. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +9 -0
  33. data/proto_docs/google/cloud/aiplatform/v1/operation.rb +1 -1
  34. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +3 -3
  35. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool.rb +1 -1
  36. data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +1 -1
  37. metadata +4 -2
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -28,7 +28,7 @@ module Google
28
28
  # @!attribute [rw] display_name
29
29
  # @return [::String]
30
30
  # Required. The user-defined name of the AnnotationSpec.
31
- # The name can be up to 128 characters long and can be consist of any UTF-8
31
+ # The name can be up to 128 characters long and can consist of any UTF-8
32
32
  # characters.
33
33
  # @!attribute [r] create_time
34
34
  # @return [::Google::Protobuf::Timestamp]
@@ -79,6 +79,15 @@ module Google
79
79
  # DEDICATED_RESOURCES this config may be provided (and the job will use these
80
80
  # resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config
81
81
  # must be provided.
82
+ # @!attribute [rw] service_account
83
+ # @return [::String]
84
+ # The service account that the DeployedModel's container runs as. If not
85
+ # specified, a system generated one will be used, which
86
+ # has minimal permissions and the custom container, if used, may not have
87
+ # enough permission to access other Google Cloud resources.
88
+ #
89
+ # Users deploying the Model must have the `iam.serviceAccounts.actAs`
90
+ # permission on this service account.
82
91
  # @!attribute [rw] manual_batch_tuning_parameters
83
92
  # @return [::Google::Cloud::AIPlatform::V1::ManualBatchTuningParameters]
84
93
  # Immutable. Parameters configuring the batch behavior. Currently only applicable when
@@ -125,7 +134,7 @@ module Google
125
134
  # Output only. Partial failures encountered.
126
135
  # For example, single files that can't be read.
127
136
  # This field never exceeds 20 entries.
128
- # Status details fields contain standard GCP error details.
137
+ # Status details fields contain standard Google Cloud error details.
129
138
  # @!attribute [r] resources_consumed
130
139
  # @return [::Google::Cloud::AIPlatform::V1::ResourcesConsumed]
131
140
  # Output only. Information about resources that had been consumed by this job.
@@ -31,7 +31,7 @@ module Google
31
31
  # @!attribute [rw] display_name
32
32
  # @return [::String]
33
33
  # Required. The display name of the CustomJob.
34
- # The name can be up to 128 characters long and can be consist of any UTF-8
34
+ # The name can be up to 128 characters long and can consist of any UTF-8
35
35
  # characters.
36
36
  # @!attribute [rw] job_spec
37
37
  # @return [::Google::Cloud::AIPlatform::V1::CustomJobSpec]
@@ -29,7 +29,7 @@ module Google
29
29
  # @!attribute [rw] display_name
30
30
  # @return [::String]
31
31
  # Required. The user-defined name of the DataLabelingJob.
32
- # The name can be up to 128 characters long and can be consist of any UTF-8
32
+ # The name can be up to 128 characters long and can consist of any UTF-8
33
33
  # characters.
34
34
  # Display name of a DataLabelingJob.
35
35
  # @!attribute [rw] datasets
@@ -28,11 +28,11 @@ module Google
28
28
  # @!attribute [rw] display_name
29
29
  # @return [::String]
30
30
  # Required. The user-defined name of the Dataset.
31
- # The name can be up to 128 characters long and can be consist of any UTF-8
31
+ # The name can be up to 128 characters long and can consist of any UTF-8
32
32
  # characters.
33
33
  # @!attribute [rw] description
34
34
  # @return [::String]
35
- # Optional. The description of the Dataset.
35
+ # The description of the Dataset.
36
36
  # @!attribute [rw] metadata_schema_uri
37
37
  # @return [::String]
38
38
  # Required. Points to a YAML file stored on Google Cloud Storage describing additional
@@ -73,6 +73,11 @@ module Google
73
73
  # @return [::Google::Cloud::AIPlatform::V1::EncryptionSpec]
74
74
  # Customer-managed encryption key spec for a Dataset. If set, this Dataset
75
75
  # and all sub-resources of this Dataset will be secured by this key.
76
+ # @!attribute [r] metadata_artifact
77
+ # @return [::String]
78
+ # Output only. The resource name of the Artifact that was created in MetadataStore when
79
+ # creating the Dataset. The Artifact resource name pattern is
80
+ # `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
76
81
  class Dataset
77
82
  include ::Google::Protobuf::MessageExts
78
83
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -245,6 +245,135 @@ module Google
245
245
  extend ::Google::Protobuf::MessageExts::ClassMethods
246
246
  end
247
247
 
248
+ # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}.
249
+ # @!attribute [rw] order_by_data_item
250
+ # @return [::String]
251
+ # A comma-separated list of data item fields to order by, sorted in
252
+ # ascending order. Use "desc" after a field name for descending.
253
+ # @!attribute [rw] order_by_annotation
254
+ # @return [::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation]
255
+ # Expression that allows ranking results based on annotation's property.
256
+ # @!attribute [rw] dataset
257
+ # @return [::String]
258
+ # Required. The resource name of the Dataset from which to search DataItems.
259
+ # Format:
260
+ # `projects/{project}/locations/{location}/datasets/{dataset}`
261
+ # @!attribute [rw] saved_query
262
+ # @return [::String]
263
+ # The resource name of a SavedQuery(annotation set in UI).
264
+ # Format:
265
+ # `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
266
+ # All of the search will be done in the context of this SavedQuery.
267
+ # @!attribute [rw] data_labeling_job
268
+ # @return [::String]
269
+ # The resource name of a DataLabelingJob.
270
+ # Format:
271
+ # `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
272
+ # If this field is set, all of the search will be done in the context of
273
+ # this DataLabelingJob.
274
+ # @!attribute [rw] data_item_filter
275
+ # @return [::String]
276
+ # An expression for filtering the DataItem that will be returned.
277
+ #
278
+ # * `data_item_id` - for = or !=.
279
+ # * `labeled` - for = or !=.
280
+ # * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that
281
+ # have at least one annotation with annotation_spec_id =
282
+ # `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob.
283
+ #
284
+ # For example:
285
+ #
286
+ # * `data_item=1`
287
+ # * `has_annotation(5)`
288
+ # @!attribute [rw] annotations_filter
289
+ # @return [::String]
290
+ # An expression for filtering the Annotations that will be returned per
291
+ # DataItem.
292
+ # * `annotation_spec_id` - for = or !=.
293
+ # @!attribute [rw] annotation_filters
294
+ # @return [::Array<::String>]
295
+ # An expression that specifies what Annotations will be returned per
296
+ # DataItem. Annotations satisfied either of the conditions will be returned.
297
+ # * `annotation_spec_id` - for = or !=.
298
+ # Must specify `saved_query_id=` - saved query id that annotations should
299
+ # belong to.
300
+ # @!attribute [rw] field_mask
301
+ # @return [::Google::Protobuf::FieldMask]
302
+ # Mask specifying which fields of {::Google::Cloud::AIPlatform::V1::DataItemView DataItemView} to read.
303
+ # @!attribute [rw] annotations_limit
304
+ # @return [::Integer]
305
+ # If set, only up to this many of Annotations will be returned per
306
+ # DataItemView. The maximum value is 1000. If not set, the maximum value will
307
+ # be used.
308
+ # @!attribute [rw] page_size
309
+ # @return [::Integer]
310
+ # Requested page size. Server may return fewer results than requested.
311
+ # Default and maximum page size is 100.
312
+ # @!attribute [rw] order_by
313
+ # @return [::String]
314
+ # A comma-separated list of fields to order by, sorted in ascending order.
315
+ # Use "desc" after a field name for descending.
316
+ # @!attribute [rw] page_token
317
+ # @return [::String]
318
+ # A token identifying a page of results for the server to return
319
+ # Typically obtained via
320
+ # {::Google::Cloud::AIPlatform::V1::SearchDataItemsResponse#next_page_token SearchDataItemsResponse.next_page_token} of the previous
321
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems} call.
322
+ class SearchDataItemsRequest
323
+ include ::Google::Protobuf::MessageExts
324
+ extend ::Google::Protobuf::MessageExts::ClassMethods
325
+
326
+ # Expression that allows ranking results based on annotation's property.
327
+ # @!attribute [rw] saved_query
328
+ # @return [::String]
329
+ # Required. Saved query of the Annotation. Only Annotations belong to this saved
330
+ # query will be considered for ordering.
331
+ # @!attribute [rw] order_by
332
+ # @return [::String]
333
+ # A comma-separated list of annotation fields to order by, sorted in
334
+ # ascending order. Use "desc" after a field name for descending. Must also
335
+ # specify saved_query.
336
+ class OrderByAnnotation
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+ end
340
+ end
341
+
342
+ # Response message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}.
343
+ # @!attribute [rw] data_item_views
344
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::DataItemView>]
345
+ # The DataItemViews read.
346
+ # @!attribute [rw] next_page_token
347
+ # @return [::String]
348
+ # A token to retrieve next page of results.
349
+ # Pass to {::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest#page_token SearchDataItemsRequest.page_token} to obtain that page.
350
+ class SearchDataItemsResponse
351
+ include ::Google::Protobuf::MessageExts
352
+ extend ::Google::Protobuf::MessageExts::ClassMethods
353
+ end
354
+
355
+ # A container for a single DataItem and Annotations on it.
356
+ # @!attribute [rw] data_item
357
+ # @return [::Google::Cloud::AIPlatform::V1::DataItem]
358
+ # The DataItem.
359
+ # @!attribute [rw] annotations
360
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::Annotation>]
361
+ # The Annotations on the DataItem. If too many Annotations should be returned
362
+ # for the DataItem, this field will be truncated per annotations_limit in
363
+ # request. If it was, then the has_truncated_annotations will be set to true.
364
+ # @!attribute [rw] has_truncated_annotations
365
+ # @return [::Boolean]
366
+ # True if and only if the Annotations field has been truncated. It happens if
367
+ # more Annotations for this DataItem met the request's annotation_filter than
368
+ # are allowed to be returned by annotations_limit.
369
+ # Note that if Annotations field is not being returned due to field mask,
370
+ # then this field will not be set to true no matter how many Annotations are
371
+ # there.
372
+ class DataItemView
373
+ include ::Google::Protobuf::MessageExts
374
+ extend ::Google::Protobuf::MessageExts::ClassMethods
375
+ end
376
+
248
377
  # Request message for {::Google::Cloud::AIPlatform::V1::DatasetService::Client#list_saved_queries DatasetService.ListSavedQueries}.
249
378
  # @!attribute [rw] parent
250
379
  # @return [::String]
@@ -29,7 +29,7 @@ module Google
29
29
  # @!attribute [rw] display_name
30
30
  # @return [::String]
31
31
  # Required. The display name of the Endpoint.
32
- # The name can be up to 128 characters long and can be consist of any UTF-8
32
+ # The name can be up to 128 characters long and can consist of any UTF-8
33
33
  # characters.
34
34
  # @!attribute [rw] description
35
35
  # @return [::String]
@@ -21,6 +21,53 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
+ # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#write_feature_values FeaturestoreOnlineServingService.WriteFeatureValues}.
25
+ # @!attribute [rw] entity_type
26
+ # @return [::String]
27
+ # Required. The resource name of the EntityType for the entities being written.
28
+ # Value format: `projects/{project}/locations/{location}/featurestores/
29
+ # \\{featurestore}/entityTypes/\\{entityType}`. For example,
30
+ # for a machine learning model predicting user clicks on a website, an
31
+ # EntityType ID could be `user`.
32
+ # @!attribute [rw] payloads
33
+ # @return [::Array<::Google::Cloud::AIPlatform::V1::WriteFeatureValuesPayload>]
34
+ # Required. The entities to be written. Up to 100,000 feature values can be written
35
+ # across all `payloads`.
36
+ class WriteFeatureValuesRequest
37
+ include ::Google::Protobuf::MessageExts
38
+ extend ::Google::Protobuf::MessageExts::ClassMethods
39
+ end
40
+
41
+ # Contains Feature values to be written for a specific entity.
42
+ # @!attribute [rw] entity_id
43
+ # @return [::String]
44
+ # Required. The ID of the entity.
45
+ # @!attribute [rw] feature_values
46
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::FeatureValue}]
47
+ # Required. Feature values to be written, mapping from Feature ID to value. Up to
48
+ # 100,000 `feature_values` entries may be written across all payloads. The
49
+ # feature generation time, aligned by days, must be no older than five
50
+ # years (1825 days) and no later than one year (366 days) in the future.
51
+ class WriteFeatureValuesPayload
52
+ include ::Google::Protobuf::MessageExts
53
+ extend ::Google::Protobuf::MessageExts::ClassMethods
54
+
55
+ # @!attribute [rw] key
56
+ # @return [::String]
57
+ # @!attribute [rw] value
58
+ # @return [::Google::Cloud::AIPlatform::V1::FeatureValue]
59
+ class FeatureValuesEntry
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+ end
64
+
65
+ # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#write_feature_values FeaturestoreOnlineServingService.WriteFeatureValues}.
66
+ class WriteFeatureValuesResponse
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+
24
71
  # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client#read_feature_values FeaturestoreOnlineServingService.ReadFeatureValues}.
25
72
  # @!attribute [rw] entity_type
26
73
  # @return [::String]