google-cloud-ai_platform-v1 0.16.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +10 -7
  3. data/lib/google/cloud/ai_platform/v1/dataset_service.rb +1 -1
  4. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +28 -21
  5. data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +1 -1
  6. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +10 -9
  7. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +1 -1
  8. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +53 -50
  9. data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +1 -1
  10. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +18 -14
  11. data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +1 -1
  12. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +8 -4
  13. data/lib/google/cloud/ai_platform/v1/index_service.rb +1 -1
  14. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +53 -36
  15. data/lib/google/cloud/ai_platform/v1/job_service.rb +1 -1
  16. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +33 -36
  17. data/lib/google/cloud/ai_platform/v1/metadata_service.rb +1 -1
  18. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +3 -4
  19. data/lib/google/cloud/ai_platform/v1/migration_service.rb +1 -1
  20. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +44 -22
  21. data/lib/google/cloud/ai_platform/v1/model_service.rb +1 -1
  22. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +28 -17
  23. data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +1 -1
  24. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +28 -19
  25. data/lib/google/cloud/ai_platform/v1/prediction_service.rb +1 -1
  26. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +5 -3
  27. data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +1 -1
  28. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +165 -71
  29. data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +1 -1
  30. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  31. data/lib/google/cloud/ai_platform/v1/vizier_service.rb +1 -1
  32. data/lib/google/cloud/ai_platform/v1.rb +2 -2
  33. data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +8 -0
  34. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +2 -0
  35. data/lib/google/cloud/aiplatform/v1/index_service_services_pb.rb +2 -1
  36. data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +24 -14
  37. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +1 -0
  38. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +10 -5
  39. data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb +16 -9
  40. data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +10 -6
  41. data/lib/google/cloud/aiplatform/v1/study_pb.rb +1 -0
  42. data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +17 -0
  43. data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb +8 -8
  44. data/proto_docs/google/cloud/aiplatform/v1/annotation.rb +9 -6
  45. data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +2 -2
  46. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +183 -50
  47. data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +8 -7
  48. data/proto_docs/google/cloud/aiplatform/v1/context.rb +2 -2
  49. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +22 -17
  50. data/proto_docs/google/cloud/aiplatform/v1/data_item.rb +6 -5
  51. data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +16 -16
  52. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +33 -17
  53. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +59 -32
  54. data/proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb +2 -2
  55. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +38 -23
  56. data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +57 -35
  57. data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb +8 -6
  58. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +111 -75
  59. data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +58 -38
  60. data/proto_docs/google/cloud/aiplatform/v1/feature.rb +9 -6
  61. data/proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb +2 -1
  62. data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +12 -11
  63. data/proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb +6 -2
  64. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +27 -19
  65. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +138 -99
  66. data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +9 -7
  67. data/proto_docs/google/cloud/aiplatform/v1/index.rb +18 -17
  68. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +36 -24
  69. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb +49 -29
  70. data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +35 -17
  71. data/proto_docs/google/cloud/aiplatform/v1/io.rb +2 -1
  72. data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +94 -57
  73. data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +53 -43
  74. data/proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb +5 -5
  75. data/proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb +3 -3
  76. data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +141 -91
  77. data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +3 -3
  78. data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +18 -15
  79. data/proto_docs/google/cloud/aiplatform/v1/model.rb +179 -132
  80. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +21 -17
  81. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +7 -6
  82. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +11 -7
  83. data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +4 -2
  84. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +110 -54
  85. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +56 -42
  86. data/proto_docs/google/cloud/aiplatform/v1/pipeline_service.rb +42 -22
  87. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +42 -28
  88. data/proto_docs/google/cloud/aiplatform/v1/saved_query.rb +2 -2
  89. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool_service.rb +19 -11
  90. data/proto_docs/google/cloud/aiplatform/v1/study.rb +42 -25
  91. data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +2 -2
  92. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +8 -7
  93. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb +2 -1
  94. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +203 -109
  95. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_time_series.rb +8 -6
  96. data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +84 -59
  97. data/proto_docs/google/cloud/aiplatform/v1/unmanaged_container_model.rb +2 -2
  98. data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb +40 -20
  99. data/proto_docs/google/rpc/status.rb +4 -2
  100. metadata +5 -5
@@ -21,7 +21,8 @@ module Google
21
21
  module Cloud
22
22
  module AIPlatform
23
23
  module V1
24
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#create_featurestore FeaturestoreService.CreateFeaturestore}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#create_featurestore FeaturestoreService.CreateFeaturestore}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location to create Featurestores.
@@ -32,8 +33,8 @@ module Google
32
33
  # Required. The Featurestore to create.
33
34
  # @!attribute [rw] featurestore_id
34
35
  # @return [::String]
35
- # Required. The ID to use for this Featurestore, which will become the final component
36
- # of the Featurestore's resource name.
36
+ # Required. The ID to use for this Featurestore, which will become the final
37
+ # component of the Featurestore's resource name.
37
38
  #
38
39
  # This value may be up to 60 characters, and valid characters are
39
40
  # `[a-z0-9_]`. The first character cannot be a number.
@@ -44,7 +45,8 @@ module Google
44
45
  extend ::Google::Protobuf::MessageExts::ClassMethods
45
46
  end
46
47
 
47
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#get_featurestore FeaturestoreService.GetFeaturestore}.
48
+ # Request message for
49
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#get_featurestore FeaturestoreService.GetFeaturestore}.
48
50
  # @!attribute [rw] name
49
51
  # @return [::String]
50
52
  # Required. The name of the Featurestore resource.
@@ -53,7 +55,8 @@ module Google
53
55
  extend ::Google::Protobuf::MessageExts::ClassMethods
54
56
  end
55
57
 
56
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores}.
58
+ # Request message for
59
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores}.
57
60
  # @!attribute [rw] parent
58
61
  # @return [::String]
59
62
  # Required. The resource name of the Location to list Featurestores.
@@ -89,12 +92,12 @@ module Google
89
92
  # @!attribute [rw] page_token
90
93
  # @return [::String]
91
94
  # A page token, received from a previous
92
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores} call.
93
- # Provide this to retrieve the subsequent page.
95
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores}
96
+ # call. Provide this to retrieve the subsequent page.
94
97
  #
95
98
  # When paginating, all other parameters provided to
96
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores} must
97
- # match the call that provided the page token.
99
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores}
100
+ # must match the call that provided the page token.
98
101
  # @!attribute [rw] order_by
99
102
  # @return [::String]
100
103
  # A comma-separated list of fields to order by, sorted in ascending order.
@@ -112,26 +115,28 @@ module Google
112
115
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
116
  end
114
117
 
115
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores}.
118
+ # Response message for
119
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores}.
116
120
  # @!attribute [rw] featurestores
117
121
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Featurestore>]
118
122
  # The Featurestores matching the request.
119
123
  # @!attribute [rw] next_page_token
120
124
  # @return [::String]
121
- # A token, which can be sent as {::Google::Cloud::AIPlatform::V1::ListFeaturestoresRequest#page_token ListFeaturestoresRequest.page_token} to
122
- # retrieve the next page.
123
- # If this field is omitted, there are no subsequent pages.
125
+ # A token, which can be sent as
126
+ # {::Google::Cloud::AIPlatform::V1::ListFeaturestoresRequest#page_token ListFeaturestoresRequest.page_token}
127
+ # to retrieve the next page. If this field is omitted, there are no
128
+ # subsequent pages.
124
129
  class ListFeaturestoresResponse
125
130
  include ::Google::Protobuf::MessageExts
126
131
  extend ::Google::Protobuf::MessageExts::ClassMethods
127
132
  end
128
133
 
129
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#update_featurestore FeaturestoreService.UpdateFeaturestore}.
134
+ # Request message for
135
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#update_featurestore FeaturestoreService.UpdateFeaturestore}.
130
136
  # @!attribute [rw] featurestore
131
137
  # @return [::Google::Cloud::AIPlatform::V1::Featurestore]
132
- # Required. The Featurestore's `name` field is used to identify the Featurestore to be
133
- # updated.
134
- # Format:
138
+ # Required. The Featurestore's `name` field is used to identify the
139
+ # Featurestore to be updated. Format:
135
140
  # `projects/{project}/locations/{location}/featurestores/{featurestore}`
136
141
  # @!attribute [rw] update_mask
137
142
  # @return [::Google::Protobuf::FieldMask]
@@ -148,12 +153,14 @@ module Google
148
153
  # * `labels`
149
154
  # * `online_serving_config.fixed_node_count`
150
155
  # * `online_serving_config.scaling`
156
+ # * `online_storage_ttl_days` (available in Preview)
151
157
  class UpdateFeaturestoreRequest
152
158
  include ::Google::Protobuf::MessageExts
153
159
  extend ::Google::Protobuf::MessageExts::ClassMethods
154
160
  end
155
161
 
156
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#delete_featurestore FeaturestoreService.DeleteFeaturestore}.
162
+ # Request message for
163
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#delete_featurestore FeaturestoreService.DeleteFeaturestore}.
157
164
  # @!attribute [rw] name
158
165
  # @return [::String]
159
166
  # Required. The name of the Featurestore to be deleted.
@@ -169,7 +176,8 @@ module Google
169
176
  extend ::Google::Protobuf::MessageExts::ClassMethods
170
177
  end
171
178
 
172
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#import_feature_values FeaturestoreService.ImportFeatureValues}.
179
+ # Request message for
180
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#import_feature_values FeaturestoreService.ImportFeatureValues}.
173
181
  # @!attribute [rw] avro_source
174
182
  # @return [::Google::Cloud::AIPlatform::V1::AvroSource]
175
183
  # @!attribute [rw] bigquery_source
@@ -186,8 +194,8 @@ module Google
186
194
  # timestamp must not have higher than millisecond precision.
187
195
  # @!attribute [rw] entity_type
188
196
  # @return [::String]
189
- # Required. The resource name of the EntityType grouping the Features for which values
190
- # are being imported. Format:
197
+ # Required. The resource name of the EntityType grouping the Features for
198
+ # which values are being imported. Format:
191
199
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
192
200
  # @!attribute [rw] entity_id_field
193
201
  # @return [::String]
@@ -195,9 +203,9 @@ module Google
195
203
  # extracted from the column named `entity_id`.
196
204
  # @!attribute [rw] feature_specs
197
205
  # @return [::Array<::Google::Cloud::AIPlatform::V1::ImportFeatureValuesRequest::FeatureSpec>]
198
- # Required. Specifications defining which Feature values to import from the entity. The
199
- # request fails if no feature_specs are provided, and having multiple
200
- # feature_specs for one Feature is not allowed.
206
+ # Required. Specifications defining which Feature values to import from the
207
+ # entity. The request fails if no feature_specs are provided, and having
208
+ # multiple feature_specs for one Feature is not allowed.
201
209
  # @!attribute [rw] disable_online_serving
202
210
  # @return [::Boolean]
203
211
  # If set, data will not be imported for online serving. This
@@ -221,8 +229,8 @@ module Google
221
229
  # Defines the Feature value(s) to import.
222
230
  # @!attribute [rw] id
223
231
  # @return [::String]
224
- # Required. ID of the Feature to import values of. This Feature must exist in the
225
- # target EntityType, or the request will fail.
232
+ # Required. ID of the Feature to import values of. This Feature must exist
233
+ # in the target EntityType, or the request will fail.
226
234
  # @!attribute [rw] source_field
227
235
  # @return [::String]
228
236
  # Source column to get the Feature values from. If not set, uses the column
@@ -233,7 +241,8 @@ module Google
233
241
  end
234
242
  end
235
243
 
236
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#import_feature_values FeaturestoreService.ImportFeatureValues}.
244
+ # Response message for
245
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#import_feature_values FeaturestoreService.ImportFeatureValues}.
237
246
  # @!attribute [rw] imported_entity_count
238
247
  # @return [::Integer]
239
248
  # Number of entities that have been imported by the operation.
@@ -256,7 +265,8 @@ module Google
256
265
  extend ::Google::Protobuf::MessageExts::ClassMethods
257
266
  end
258
267
 
259
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#batch_read_feature_values FeaturestoreService.BatchReadFeatureValues}.
268
+ # Request message for
269
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#batch_read_feature_values FeaturestoreService.BatchReadFeatureValues}.
260
270
  # @!attribute [rw] csv_read_instances
261
271
  # @return [::Google::Cloud::AIPlatform::V1::CsvSource]
262
272
  # Each read instance consists of exactly one read timestamp and one or more
@@ -288,8 +298,8 @@ module Google
288
298
  # Similar to csv_read_instances, but from BigQuery source.
289
299
  # @!attribute [rw] featurestore
290
300
  # @return [::String]
291
- # Required. The resource name of the Featurestore from which to query Feature values.
292
- # Format:
301
+ # Required. The resource name of the Featurestore from which to query Feature
302
+ # values. Format:
293
303
  # `projects/{project}/locations/{location}/featurestores/{featurestore}`
294
304
  # @!attribute [rw] destination
295
305
  # @return [::Google::Cloud::AIPlatform::V1::FeatureValueDestination]
@@ -305,15 +315,15 @@ module Google
305
315
  # passed as opaque bytes.
306
316
  # @!attribute [rw] entity_type_specs
307
317
  # @return [::Array<::Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest::EntityTypeSpec>]
308
- # Required. Specifies EntityType grouping Features to read values of and settings.
309
- # Each EntityType referenced in
318
+ # Required. Specifies EntityType grouping Features to read values of and
319
+ # settings. Each EntityType referenced in
310
320
  # [BatchReadFeatureValuesRequest.entity_type_specs] must have a column
311
321
  # specifying entity IDs in the EntityType in
312
322
  # [BatchReadFeatureValuesRequest.request][] .
313
323
  # @!attribute [rw] start_time
314
324
  # @return [::Google::Protobuf::Timestamp]
315
- # Optional. Excludes Feature values with feature generation timestamp before this
316
- # timestamp. If not set, retrieve oldest values kept in Feature Store.
325
+ # Optional. Excludes Feature values with feature generation timestamp before
326
+ # this timestamp. If not set, retrieve oldest values kept in Feature Store.
317
327
  # Timestamp, if present, must not have higher than millisecond precision.
318
328
  class BatchReadFeatureValuesRequest
319
329
  include ::Google::Protobuf::MessageExts
@@ -322,8 +332,9 @@ module Google
322
332
  # Describe pass-through fields in read_instance source.
323
333
  # @!attribute [rw] field_name
324
334
  # @return [::String]
325
- # Required. The name of the field in the CSV header or the name of the column in
326
- # BigQuery table. The naming restriction is the same as {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
335
+ # Required. The name of the field in the CSV header or the name of the
336
+ # column in BigQuery table. The naming restriction is the same as
337
+ # {::Google::Cloud::AIPlatform::V1::Feature#name Feature.name}.
327
338
  class PassThroughField
328
339
  include ::Google::Protobuf::MessageExts
329
340
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -333,12 +344,14 @@ module Google
333
344
  # settings.
334
345
  # @!attribute [rw] entity_type_id
335
346
  # @return [::String]
336
- # Required. ID of the EntityType to select Features. The EntityType id is the
337
- # {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id} specified
338
- # during EntityType creation.
347
+ # Required. ID of the EntityType to select Features. The EntityType id is
348
+ # the
349
+ # {::Google::Cloud::AIPlatform::V1::CreateEntityTypeRequest#entity_type_id entity_type_id}
350
+ # specified during EntityType creation.
339
351
  # @!attribute [rw] feature_selector
340
352
  # @return [::Google::Cloud::AIPlatform::V1::FeatureSelector]
341
- # Required. Selectors choosing which Feature values to read from the EntityType.
353
+ # Required. Selectors choosing which Feature values to read from the
354
+ # EntityType.
342
355
  # @!attribute [rw] settings
343
356
  # @return [::Array<::Google::Cloud::AIPlatform::V1::DestinationFeatureSetting>]
344
357
  # Per-Feature settings for the batch read.
@@ -348,7 +361,8 @@ module Google
348
361
  end
349
362
  end
350
363
 
351
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#export_feature_values FeaturestoreService.ExportFeatureValues}.
364
+ # Request message for
365
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#export_feature_values FeaturestoreService.ExportFeatureValues}.
352
366
  # @!attribute [rw] snapshot_export
353
367
  # @return [::Google::Cloud::AIPlatform::V1::ExportFeatureValuesRequest::SnapshotExport]
354
368
  # Exports the latest Feature values of all entities of the EntityType
@@ -359,8 +373,8 @@ module Google
359
373
  # time range
360
374
  # @!attribute [rw] entity_type
361
375
  # @return [::String]
362
- # Required. The resource name of the EntityType from which to export Feature values.
363
- # Format:
376
+ # Required. The resource name of the EntityType from which to export Feature
377
+ # values. Format:
364
378
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
365
379
  # @!attribute [rw] destination
366
380
  # @return [::Google::Cloud::AIPlatform::V1::FeatureValueDestination]
@@ -426,8 +440,10 @@ module Google
426
440
  # @!attribute [rw] bigquery_destination
427
441
  # @return [::Google::Cloud::AIPlatform::V1::BigQueryDestination]
428
442
  # Output in BigQuery format.
429
- # {::Google::Cloud::AIPlatform::V1::BigQueryDestination#output_uri BigQueryDestination.output_uri} in
430
- # {::Google::Cloud::AIPlatform::V1::FeatureValueDestination#bigquery_destination FeatureValueDestination.bigquery_destination} must refer to a table.
443
+ # {::Google::Cloud::AIPlatform::V1::BigQueryDestination#output_uri BigQueryDestination.output_uri}
444
+ # in
445
+ # {::Google::Cloud::AIPlatform::V1::FeatureValueDestination#bigquery_destination FeatureValueDestination.bigquery_destination}
446
+ # must refer to a table.
431
447
  # @!attribute [rw] tfrecord_destination
432
448
  # @return [::Google::Cloud::AIPlatform::V1::TFRecordDestination]
433
449
  # Output in TFRecord format.
@@ -450,19 +466,22 @@ module Google
450
466
  extend ::Google::Protobuf::MessageExts::ClassMethods
451
467
  end
452
468
 
453
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#export_feature_values FeaturestoreService.ExportFeatureValues}.
469
+ # Response message for
470
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#export_feature_values FeaturestoreService.ExportFeatureValues}.
454
471
  class ExportFeatureValuesResponse
455
472
  include ::Google::Protobuf::MessageExts
456
473
  extend ::Google::Protobuf::MessageExts::ClassMethods
457
474
  end
458
475
 
459
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#batch_read_feature_values FeaturestoreService.BatchReadFeatureValues}.
476
+ # Response message for
477
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#batch_read_feature_values FeaturestoreService.BatchReadFeatureValues}.
460
478
  class BatchReadFeatureValuesResponse
461
479
  include ::Google::Protobuf::MessageExts
462
480
  extend ::Google::Protobuf::MessageExts::ClassMethods
463
481
  end
464
482
 
465
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#create_entity_type FeaturestoreService.CreateEntityType}.
483
+ # Request message for
484
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#create_entity_type FeaturestoreService.CreateEntityType}.
466
485
  # @!attribute [rw] parent
467
486
  # @return [::String]
468
487
  # Required. The resource name of the Featurestore to create EntityTypes.
@@ -473,8 +492,8 @@ module Google
473
492
  # The EntityType to create.
474
493
  # @!attribute [rw] entity_type_id
475
494
  # @return [::String]
476
- # Required. The ID to use for the EntityType, which will become the final component of
477
- # the EntityType's resource name.
495
+ # Required. The ID to use for the EntityType, which will become the final
496
+ # component of the EntityType's resource name.
478
497
  #
479
498
  # This value may be up to 60 characters, and valid characters are
480
499
  # `[a-z0-9_]`. The first character cannot be a number.
@@ -485,7 +504,8 @@ module Google
485
504
  extend ::Google::Protobuf::MessageExts::ClassMethods
486
505
  end
487
506
 
488
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#get_entity_type FeaturestoreService.GetEntityType}.
507
+ # Request message for
508
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#get_entity_type FeaturestoreService.GetEntityType}.
489
509
  # @!attribute [rw] name
490
510
  # @return [::String]
491
511
  # Required. The name of the EntityType resource.
@@ -496,7 +516,8 @@ module Google
496
516
  extend ::Google::Protobuf::MessageExts::ClassMethods
497
517
  end
498
518
 
499
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes}.
519
+ # Request message for
520
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes}.
500
521
  # @!attribute [rw] parent
501
522
  # @return [::String]
502
523
  # Required. The resource name of the Featurestore to list EntityTypes.
@@ -531,12 +552,12 @@ module Google
531
552
  # @!attribute [rw] page_token
532
553
  # @return [::String]
533
554
  # A page token, received from a previous
534
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes} call.
535
- # Provide this to retrieve the subsequent page.
555
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes}
556
+ # call. Provide this to retrieve the subsequent page.
536
557
  #
537
558
  # When paginating, all other parameters provided to
538
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes} must
539
- # match the call that provided the page token.
559
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes}
560
+ # must match the call that provided the page token.
540
561
  # @!attribute [rw] order_by
541
562
  # @return [::String]
542
563
  # A comma-separated list of fields to order by, sorted in ascending order.
@@ -555,26 +576,28 @@ module Google
555
576
  extend ::Google::Protobuf::MessageExts::ClassMethods
556
577
  end
557
578
 
558
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes}.
579
+ # Response message for
580
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes}.
559
581
  # @!attribute [rw] entity_types
560
582
  # @return [::Array<::Google::Cloud::AIPlatform::V1::EntityType>]
561
583
  # The EntityTypes matching the request.
562
584
  # @!attribute [rw] next_page_token
563
585
  # @return [::String]
564
- # A token, which can be sent as {::Google::Cloud::AIPlatform::V1::ListEntityTypesRequest#page_token ListEntityTypesRequest.page_token} to
565
- # retrieve the next page.
566
- # If this field is omitted, there are no subsequent pages.
586
+ # A token, which can be sent as
587
+ # {::Google::Cloud::AIPlatform::V1::ListEntityTypesRequest#page_token ListEntityTypesRequest.page_token}
588
+ # to retrieve the next page. If this field is omitted, there are no
589
+ # subsequent pages.
567
590
  class ListEntityTypesResponse
568
591
  include ::Google::Protobuf::MessageExts
569
592
  extend ::Google::Protobuf::MessageExts::ClassMethods
570
593
  end
571
594
 
572
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#update_entity_type FeaturestoreService.UpdateEntityType}.
595
+ # Request message for
596
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#update_entity_type FeaturestoreService.UpdateEntityType}.
573
597
  # @!attribute [rw] entity_type
574
598
  # @return [::Google::Cloud::AIPlatform::V1::EntityType]
575
- # Required. The EntityType's `name` field is used to identify the EntityType to be
576
- # updated.
577
- # Format:
599
+ # Required. The EntityType's `name` field is used to identify the EntityType
600
+ # to be updated. Format:
578
601
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
579
602
  # @!attribute [rw] update_mask
580
603
  # @return [::Google::Protobuf::FieldMask]
@@ -597,6 +620,7 @@ module Google
597
620
  # * `monitoring_config.import_features_analysis.anomaly_detection_baseline`
598
621
  # * `monitoring_config.numerical_threshold_config.value`
599
622
  # * `monitoring_config.categorical_threshold_config.value`
623
+ # * `offline_storage_ttl_days` (available in Preview)
600
624
  class UpdateEntityTypeRequest
601
625
  include ::Google::Protobuf::MessageExts
602
626
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -617,7 +641,8 @@ module Google
617
641
  extend ::Google::Protobuf::MessageExts::ClassMethods
618
642
  end
619
643
 
620
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#create_feature FeaturestoreService.CreateFeature}.
644
+ # Request message for
645
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#create_feature FeaturestoreService.CreateFeature}.
621
646
  # @!attribute [rw] parent
622
647
  # @return [::String]
623
648
  # Required. The resource name of the EntityType to create a Feature.
@@ -628,8 +653,8 @@ module Google
628
653
  # Required. The Feature to create.
629
654
  # @!attribute [rw] feature_id
630
655
  # @return [::String]
631
- # Required. The ID to use for the Feature, which will become the final component of
632
- # the Feature's resource name.
656
+ # Required. The ID to use for the Feature, which will become the final
657
+ # component of the Feature's resource name.
633
658
  #
634
659
  # This value may be up to 128 characters, and valid characters are
635
660
  # `[a-z0-9_]`. The first character cannot be a number.
@@ -640,24 +665,27 @@ module Google
640
665
  extend ::Google::Protobuf::MessageExts::ClassMethods
641
666
  end
642
667
 
643
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#batch_create_features FeaturestoreService.BatchCreateFeatures}.
668
+ # Request message for
669
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#batch_create_features FeaturestoreService.BatchCreateFeatures}.
644
670
  # @!attribute [rw] parent
645
671
  # @return [::String]
646
- # Required. The resource name of the EntityType to create the batch of Features under.
647
- # Format:
672
+ # Required. The resource name of the EntityType to create the batch of
673
+ # Features under. Format:
648
674
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
649
675
  # @!attribute [rw] requests
650
676
  # @return [::Array<::Google::Cloud::AIPlatform::V1::CreateFeatureRequest>]
651
- # Required. The request message specifying the Features to create. All Features must be
652
- # created under the same parent EntityType. The `parent` field in each child
653
- # request message can be omitted. If `parent` is set in a child request, then
654
- # the value must match the `parent` value in this request message.
677
+ # Required. The request message specifying the Features to create. All
678
+ # Features must be created under the same parent EntityType. The `parent`
679
+ # field in each child request message can be omitted. If `parent` is set in a
680
+ # child request, then the value must match the `parent` value in this request
681
+ # message.
655
682
  class BatchCreateFeaturesRequest
656
683
  include ::Google::Protobuf::MessageExts
657
684
  extend ::Google::Protobuf::MessageExts::ClassMethods
658
685
  end
659
686
 
660
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#batch_create_features FeaturestoreService.BatchCreateFeatures}.
687
+ # Response message for
688
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#batch_create_features FeaturestoreService.BatchCreateFeatures}.
661
689
  # @!attribute [rw] features
662
690
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Feature>]
663
691
  # The Features created.
@@ -666,7 +694,8 @@ module Google
666
694
  extend ::Google::Protobuf::MessageExts::ClassMethods
667
695
  end
668
696
 
669
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#get_feature FeaturestoreService.GetFeature}.
697
+ # Request message for
698
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#get_feature FeaturestoreService.GetFeature}.
670
699
  # @!attribute [rw] name
671
700
  # @return [::String]
672
701
  # Required. The name of the Feature resource.
@@ -677,7 +706,8 @@ module Google
677
706
  extend ::Google::Protobuf::MessageExts::ClassMethods
678
707
  end
679
708
 
680
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures}.
709
+ # Request message for
710
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures}.
681
711
  # @!attribute [rw] parent
682
712
  # @return [::String]
683
713
  # Required. The resource name of the Location to list Features.
@@ -714,12 +744,12 @@ module Google
714
744
  # @!attribute [rw] page_token
715
745
  # @return [::String]
716
746
  # A page token, received from a previous
717
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures} call.
718
- # Provide this to retrieve the subsequent page.
747
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures}
748
+ # call. Provide this to retrieve the subsequent page.
719
749
  #
720
750
  # When paginating, all other parameters provided to
721
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures} must
722
- # match the call that provided the page token.
751
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures}
752
+ # must match the call that provided the page token.
723
753
  # @!attribute [rw] order_by
724
754
  # @return [::String]
725
755
  # A comma-separated list of fields to order by, sorted in ascending order.
@@ -735,30 +765,35 @@ module Google
735
765
  # Mask specifying which fields to read.
736
766
  # @!attribute [rw] latest_stats_count
737
767
  # @return [::Integer]
738
- # If set, return the most recent {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#latest_stats_count ListFeaturesRequest.latest_stats_count}
768
+ # If set, return the most recent
769
+ # {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#latest_stats_count ListFeaturesRequest.latest_stats_count}
739
770
  # of stats for each Feature in response. Valid value is [0, 10]. If number of
740
- # stats exists < {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#latest_stats_count ListFeaturesRequest.latest_stats_count}, return all
741
- # existing stats.
771
+ # stats exists <
772
+ # {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#latest_stats_count ListFeaturesRequest.latest_stats_count},
773
+ # return all existing stats.
742
774
  class ListFeaturesRequest
743
775
  include ::Google::Protobuf::MessageExts
744
776
  extend ::Google::Protobuf::MessageExts::ClassMethods
745
777
  end
746
778
 
747
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures}.
779
+ # Response message for
780
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures}.
748
781
  # @!attribute [rw] features
749
782
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Feature>]
750
783
  # The Features matching the request.
751
784
  # @!attribute [rw] next_page_token
752
785
  # @return [::String]
753
- # A token, which can be sent as {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#page_token ListFeaturesRequest.page_token} to
754
- # retrieve the next page.
755
- # If this field is omitted, there are no subsequent pages.
786
+ # A token, which can be sent as
787
+ # {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#page_token ListFeaturesRequest.page_token}
788
+ # to retrieve the next page. If this field is omitted, there are no
789
+ # subsequent pages.
756
790
  class ListFeaturesResponse
757
791
  include ::Google::Protobuf::MessageExts
758
792
  extend ::Google::Protobuf::MessageExts::ClassMethods
759
793
  end
760
794
 
761
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures}.
795
+ # Request message for
796
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures}.
762
797
  # @!attribute [rw] location
763
798
  # @return [::String]
764
799
  # Required. The resource name of the Location to search Features.
@@ -834,18 +869,19 @@ module Google
834
869
  # @!attribute [rw] page_token
835
870
  # @return [::String]
836
871
  # A page token, received from a previous
837
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures} call.
838
- # Provide this to retrieve the subsequent page.
872
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures}
873
+ # call. Provide this to retrieve the subsequent page.
839
874
  #
840
875
  # When paginating, all other parameters provided to
841
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures}, except `page_size`, must
842
- # match the call that provided the page token.
876
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures},
877
+ # except `page_size`, must match the call that provided the page token.
843
878
  class SearchFeaturesRequest
844
879
  include ::Google::Protobuf::MessageExts
845
880
  extend ::Google::Protobuf::MessageExts::ClassMethods
846
881
  end
847
882
 
848
- # Response message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures}.
883
+ # Response message for
884
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures}.
849
885
  # @!attribute [rw] features
850
886
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Feature>]
851
887
  # The Features matching the request.
@@ -859,15 +895,17 @@ module Google
859
895
  # * `update_time`
860
896
  # @!attribute [rw] next_page_token
861
897
  # @return [::String]
862
- # A token, which can be sent as {::Google::Cloud::AIPlatform::V1::SearchFeaturesRequest#page_token SearchFeaturesRequest.page_token} to
863
- # retrieve the next page.
864
- # If this field is omitted, there are no subsequent pages.
898
+ # A token, which can be sent as
899
+ # {::Google::Cloud::AIPlatform::V1::SearchFeaturesRequest#page_token SearchFeaturesRequest.page_token}
900
+ # to retrieve the next page. If this field is omitted, there are no
901
+ # subsequent pages.
865
902
  class SearchFeaturesResponse
866
903
  include ::Google::Protobuf::MessageExts
867
904
  extend ::Google::Protobuf::MessageExts::ClassMethods
868
905
  end
869
906
 
870
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#update_feature FeaturestoreService.UpdateFeature}.
907
+ # Request message for
908
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#update_feature FeaturestoreService.UpdateFeature}.
871
909
  # @!attribute [rw] feature
872
910
  # @return [::Google::Cloud::AIPlatform::V1::Feature]
873
911
  # Required. The Feature's `name` field is used to identify the Feature to be
@@ -894,7 +932,8 @@ module Google
894
932
  extend ::Google::Protobuf::MessageExts::ClassMethods
895
933
  end
896
934
 
897
- # Request message for {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#delete_feature FeaturestoreService.DeleteFeature}.
935
+ # Request message for
936
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#delete_feature FeaturestoreService.DeleteFeature}.
898
937
  # @!attribute [rw] name
899
938
  # @return [::String]
900
939
  # Required. The name of the Features to be deleted.
@@ -50,8 +50,8 @@ module Google
50
50
  # before the whole job fails.
51
51
  # @!attribute [rw] trial_job_spec
52
52
  # @return [::Google::Cloud::AIPlatform::V1::CustomJobSpec]
53
- # Required. The spec of a trial job. The same spec applies to the CustomJobs created
54
- # in all the trials.
53
+ # Required. The spec of a trial job. The same spec applies to the CustomJobs
54
+ # created in all the trials.
55
55
  # @!attribute [r] trials
56
56
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Trial>]
57
57
  # Output only. Trials of the HyperparameterTuningJob.
@@ -63,15 +63,17 @@ module Google
63
63
  # Output only. Time when the HyperparameterTuningJob was created.
64
64
  # @!attribute [r] start_time
65
65
  # @return [::Google::Protobuf::Timestamp]
66
- # Output only. Time when the HyperparameterTuningJob for the first time entered the
67
- # `JOB_STATE_RUNNING` state.
66
+ # Output only. Time when the HyperparameterTuningJob for the first time
67
+ # entered the `JOB_STATE_RUNNING` state.
68
68
  # @!attribute [r] end_time
69
69
  # @return [::Google::Protobuf::Timestamp]
70
- # Output only. Time when the HyperparameterTuningJob entered any of the following states:
71
- # `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
70
+ # Output only. Time when the HyperparameterTuningJob entered any of the
71
+ # following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`,
72
+ # `JOB_STATE_CANCELLED`.
72
73
  # @!attribute [r] update_time
73
74
  # @return [::Google::Protobuf::Timestamp]
74
- # Output only. Time when the HyperparameterTuningJob was most recently updated.
75
+ # Output only. Time when the HyperparameterTuningJob was most recently
76
+ # updated.
75
77
  # @!attribute [r] error
76
78
  # @return [::Google::Rpc::Status]
77
79
  # Output only. Only populated when job's state is JOB_STATE_FAILED or