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::JobService::Client#create_custom_job JobService.CreateCustomJob}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#create_custom_job JobService.CreateCustomJob}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location to create the CustomJob in.
@@ -34,7 +35,8 @@ module Google
34
35
  extend ::Google::Protobuf::MessageExts::ClassMethods
35
36
  end
36
37
 
37
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#get_custom_job JobService.GetCustomJob}.
38
+ # Request message for
39
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#get_custom_job JobService.GetCustomJob}.
38
40
  # @!attribute [rw] name
39
41
  # @return [::String]
40
42
  # Required. The name of the CustomJob resource.
@@ -45,7 +47,8 @@ module Google
45
47
  extend ::Google::Protobuf::MessageExts::ClassMethods
46
48
  end
47
49
 
48
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#list_custom_jobs JobService.ListCustomJobs}.
50
+ # Request message for
51
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_custom_jobs JobService.ListCustomJobs}.
49
52
  # @!attribute [rw] parent
50
53
  # @return [::String]
51
54
  # Required. The resource name of the Location to list the CustomJobs from.
@@ -79,8 +82,10 @@ module Google
79
82
  # @return [::String]
80
83
  # The standard list page token.
81
84
  # Typically obtained via
82
- # {::Google::Cloud::AIPlatform::V1::ListCustomJobsResponse#next_page_token ListCustomJobsResponse.next_page_token} of the previous
83
- # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_custom_jobs JobService.ListCustomJobs} call.
85
+ # {::Google::Cloud::AIPlatform::V1::ListCustomJobsResponse#next_page_token ListCustomJobsResponse.next_page_token}
86
+ # of the previous
87
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_custom_jobs JobService.ListCustomJobs}
88
+ # call.
84
89
  # @!attribute [rw] read_mask
85
90
  # @return [::Google::Protobuf::FieldMask]
86
91
  # Mask specifying which fields to read.
@@ -89,20 +94,24 @@ module Google
89
94
  extend ::Google::Protobuf::MessageExts::ClassMethods
90
95
  end
91
96
 
92
- # Response message for {::Google::Cloud::AIPlatform::V1::JobService::Client#list_custom_jobs JobService.ListCustomJobs}
97
+ # Response message for
98
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_custom_jobs JobService.ListCustomJobs}
93
99
  # @!attribute [rw] custom_jobs
94
100
  # @return [::Array<::Google::Cloud::AIPlatform::V1::CustomJob>]
95
101
  # List of CustomJobs in the requested page.
96
102
  # @!attribute [rw] next_page_token
97
103
  # @return [::String]
98
104
  # A token to retrieve the next page of results.
99
- # Pass to {::Google::Cloud::AIPlatform::V1::ListCustomJobsRequest#page_token ListCustomJobsRequest.page_token} to obtain that page.
105
+ # Pass to
106
+ # {::Google::Cloud::AIPlatform::V1::ListCustomJobsRequest#page_token ListCustomJobsRequest.page_token}
107
+ # to obtain that page.
100
108
  class ListCustomJobsResponse
101
109
  include ::Google::Protobuf::MessageExts
102
110
  extend ::Google::Protobuf::MessageExts::ClassMethods
103
111
  end
104
112
 
105
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_custom_job JobService.DeleteCustomJob}.
113
+ # Request message for
114
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_custom_job JobService.DeleteCustomJob}.
106
115
  # @!attribute [rw] name
107
116
  # @return [::String]
108
117
  # Required. The name of the CustomJob resource to be deleted.
@@ -113,7 +122,8 @@ module Google
113
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
114
123
  end
115
124
 
116
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_custom_job JobService.CancelCustomJob}.
125
+ # Request message for
126
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_custom_job JobService.CancelCustomJob}.
117
127
  # @!attribute [rw] name
118
128
  # @return [::String]
119
129
  # Required. The name of the CustomJob to cancel.
@@ -124,7 +134,8 @@ module Google
124
134
  extend ::Google::Protobuf::MessageExts::ClassMethods
125
135
  end
126
136
 
127
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#create_data_labeling_job JobService.CreateDataLabelingJob}.
137
+ # Request message for
138
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#create_data_labeling_job JobService.CreateDataLabelingJob}.
128
139
  # @!attribute [rw] parent
129
140
  # @return [::String]
130
141
  # Required. The parent of the DataLabelingJob.
@@ -137,7 +148,8 @@ module Google
137
148
  extend ::Google::Protobuf::MessageExts::ClassMethods
138
149
  end
139
150
 
140
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#get_data_labeling_job JobService.GetDataLabelingJob}.
151
+ # Request message for
152
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#get_data_labeling_job JobService.GetDataLabelingJob}.
141
153
  # @!attribute [rw] name
142
154
  # @return [::String]
143
155
  # Required. The name of the DataLabelingJob.
@@ -148,7 +160,8 @@ module Google
148
160
  extend ::Google::Protobuf::MessageExts::ClassMethods
149
161
  end
150
162
 
151
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#list_data_labeling_jobs JobService.ListDataLabelingJobs}.
163
+ # Request message for
164
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_data_labeling_jobs JobService.ListDataLabelingJobs}.
152
165
  # @!attribute [rw] parent
153
166
  # @return [::String]
154
167
  # Required. The parent of the DataLabelingJob.
@@ -197,7 +210,8 @@ module Google
197
210
  extend ::Google::Protobuf::MessageExts::ClassMethods
198
211
  end
199
212
 
200
- # Response message for {::Google::Cloud::AIPlatform::V1::JobService::Client#list_data_labeling_jobs JobService.ListDataLabelingJobs}.
213
+ # Response message for
214
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_data_labeling_jobs JobService.ListDataLabelingJobs}.
201
215
  # @!attribute [rw] data_labeling_jobs
202
216
  # @return [::Array<::Google::Cloud::AIPlatform::V1::DataLabelingJob>]
203
217
  # A list of DataLabelingJobs that matches the specified filter in the
@@ -210,7 +224,8 @@ module Google
210
224
  extend ::Google::Protobuf::MessageExts::ClassMethods
211
225
  end
212
226
 
213
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_data_labeling_job JobService.DeleteDataLabelingJob}.
227
+ # Request message for
228
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_data_labeling_job JobService.DeleteDataLabelingJob}.
214
229
  # @!attribute [rw] name
215
230
  # @return [::String]
216
231
  # Required. The name of the DataLabelingJob to be deleted.
@@ -221,7 +236,8 @@ module Google
221
236
  extend ::Google::Protobuf::MessageExts::ClassMethods
222
237
  end
223
238
 
224
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_data_labeling_job JobService.CancelDataLabelingJob}.
239
+ # Request message for
240
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_data_labeling_job JobService.CancelDataLabelingJob}.
225
241
  # @!attribute [rw] name
226
242
  # @return [::String]
227
243
  # Required. The name of the DataLabelingJob.
@@ -232,11 +248,13 @@ module Google
232
248
  extend ::Google::Protobuf::MessageExts::ClassMethods
233
249
  end
234
250
 
235
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#create_hyperparameter_tuning_job JobService.CreateHyperparameterTuningJob}.
251
+ # Request message for
252
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#create_hyperparameter_tuning_job JobService.CreateHyperparameterTuningJob}.
236
253
  # @!attribute [rw] parent
237
254
  # @return [::String]
238
- # Required. The resource name of the Location to create the HyperparameterTuningJob in.
239
- # Format: `projects/{project}/locations/{location}`
255
+ # Required. The resource name of the Location to create the
256
+ # HyperparameterTuningJob in. Format:
257
+ # `projects/{project}/locations/{location}`
240
258
  # @!attribute [rw] hyperparameter_tuning_job
241
259
  # @return [::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob]
242
260
  # Required. The HyperparameterTuningJob to create.
@@ -245,7 +263,8 @@ module Google
245
263
  extend ::Google::Protobuf::MessageExts::ClassMethods
246
264
  end
247
265
 
248
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#get_hyperparameter_tuning_job JobService.GetHyperparameterTuningJob}.
266
+ # Request message for
267
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#get_hyperparameter_tuning_job JobService.GetHyperparameterTuningJob}.
249
268
  # @!attribute [rw] name
250
269
  # @return [::String]
251
270
  # Required. The name of the HyperparameterTuningJob resource.
@@ -256,11 +275,13 @@ module Google
256
275
  extend ::Google::Protobuf::MessageExts::ClassMethods
257
276
  end
258
277
 
259
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#list_hyperparameter_tuning_jobs JobService.ListHyperparameterTuningJobs}.
278
+ # Request message for
279
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_hyperparameter_tuning_jobs JobService.ListHyperparameterTuningJobs}.
260
280
  # @!attribute [rw] parent
261
281
  # @return [::String]
262
- # Required. The resource name of the Location to list the HyperparameterTuningJobs
263
- # from. Format: `projects/{project}/locations/{location}`
282
+ # Required. The resource name of the Location to list the
283
+ # HyperparameterTuningJobs from. Format:
284
+ # `projects/{project}/locations/{location}`
264
285
  # @!attribute [rw] filter
265
286
  # @return [::String]
266
287
  # The standard list filter.
@@ -290,8 +311,10 @@ module Google
290
311
  # @return [::String]
291
312
  # The standard list page token.
292
313
  # Typically obtained via
293
- # {::Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsResponse#next_page_token ListHyperparameterTuningJobsResponse.next_page_token} of the previous
294
- # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_hyperparameter_tuning_jobs JobService.ListHyperparameterTuningJobs} call.
314
+ # {::Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsResponse#next_page_token ListHyperparameterTuningJobsResponse.next_page_token}
315
+ # of the previous
316
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_hyperparameter_tuning_jobs JobService.ListHyperparameterTuningJobs}
317
+ # call.
295
318
  # @!attribute [rw] read_mask
296
319
  # @return [::Google::Protobuf::FieldMask]
297
320
  # Mask specifying which fields to read.
@@ -300,22 +323,26 @@ module Google
300
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
301
324
  end
302
325
 
303
- # Response message for {::Google::Cloud::AIPlatform::V1::JobService::Client#list_hyperparameter_tuning_jobs JobService.ListHyperparameterTuningJobs}
326
+ # Response message for
327
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_hyperparameter_tuning_jobs JobService.ListHyperparameterTuningJobs}
304
328
  # @!attribute [rw] hyperparameter_tuning_jobs
305
329
  # @return [::Array<::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob>]
306
330
  # List of HyperparameterTuningJobs in the requested page.
307
- # {::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob#trials HyperparameterTuningJob.trials} of the jobs will be not be returned.
331
+ # {::Google::Cloud::AIPlatform::V1::HyperparameterTuningJob#trials HyperparameterTuningJob.trials}
332
+ # of the jobs will be not be returned.
308
333
  # @!attribute [rw] next_page_token
309
334
  # @return [::String]
310
335
  # A token to retrieve the next page of results.
311
- # Pass to {::Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsRequest#page_token ListHyperparameterTuningJobsRequest.page_token} to obtain that
312
- # page.
336
+ # Pass to
337
+ # {::Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsRequest#page_token ListHyperparameterTuningJobsRequest.page_token}
338
+ # to obtain that page.
313
339
  class ListHyperparameterTuningJobsResponse
314
340
  include ::Google::Protobuf::MessageExts
315
341
  extend ::Google::Protobuf::MessageExts::ClassMethods
316
342
  end
317
343
 
318
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_hyperparameter_tuning_job JobService.DeleteHyperparameterTuningJob}.
344
+ # Request message for
345
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_hyperparameter_tuning_job JobService.DeleteHyperparameterTuningJob}.
319
346
  # @!attribute [rw] name
320
347
  # @return [::String]
321
348
  # Required. The name of the HyperparameterTuningJob resource to be deleted.
@@ -326,7 +353,8 @@ module Google
326
353
  extend ::Google::Protobuf::MessageExts::ClassMethods
327
354
  end
328
355
 
329
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_hyperparameter_tuning_job JobService.CancelHyperparameterTuningJob}.
356
+ # Request message for
357
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_hyperparameter_tuning_job JobService.CancelHyperparameterTuningJob}.
330
358
  # @!attribute [rw] name
331
359
  # @return [::String]
332
360
  # Required. The name of the HyperparameterTuningJob to cancel.
@@ -337,11 +365,12 @@ module Google
337
365
  extend ::Google::Protobuf::MessageExts::ClassMethods
338
366
  end
339
367
 
340
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#create_batch_prediction_job JobService.CreateBatchPredictionJob}.
368
+ # Request message for
369
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#create_batch_prediction_job JobService.CreateBatchPredictionJob}.
341
370
  # @!attribute [rw] parent
342
371
  # @return [::String]
343
- # Required. The resource name of the Location to create the BatchPredictionJob in.
344
- # Format: `projects/{project}/locations/{location}`
372
+ # Required. The resource name of the Location to create the
373
+ # BatchPredictionJob in. Format: `projects/{project}/locations/{location}`
345
374
  # @!attribute [rw] batch_prediction_job
346
375
  # @return [::Google::Cloud::AIPlatform::V1::BatchPredictionJob]
347
376
  # Required. The BatchPredictionJob to create.
@@ -350,7 +379,8 @@ module Google
350
379
  extend ::Google::Protobuf::MessageExts::ClassMethods
351
380
  end
352
381
 
353
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#get_batch_prediction_job JobService.GetBatchPredictionJob}.
382
+ # Request message for
383
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#get_batch_prediction_job JobService.GetBatchPredictionJob}.
354
384
  # @!attribute [rw] name
355
385
  # @return [::String]
356
386
  # Required. The name of the BatchPredictionJob resource.
@@ -361,7 +391,8 @@ module Google
361
391
  extend ::Google::Protobuf::MessageExts::ClassMethods
362
392
  end
363
393
 
364
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#list_batch_prediction_jobs JobService.ListBatchPredictionJobs}.
394
+ # Request message for
395
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_batch_prediction_jobs JobService.ListBatchPredictionJobs}.
365
396
  # @!attribute [rw] parent
366
397
  # @return [::String]
367
398
  # Required. The resource name of the Location to list the BatchPredictionJobs
@@ -396,8 +427,10 @@ module Google
396
427
  # @return [::String]
397
428
  # The standard list page token.
398
429
  # Typically obtained via
399
- # {::Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsResponse#next_page_token ListBatchPredictionJobsResponse.next_page_token} of the previous
400
- # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_batch_prediction_jobs JobService.ListBatchPredictionJobs} call.
430
+ # {::Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsResponse#next_page_token ListBatchPredictionJobsResponse.next_page_token}
431
+ # of the previous
432
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_batch_prediction_jobs JobService.ListBatchPredictionJobs}
433
+ # call.
401
434
  # @!attribute [rw] read_mask
402
435
  # @return [::Google::Protobuf::FieldMask]
403
436
  # Mask specifying which fields to read.
@@ -406,21 +439,24 @@ module Google
406
439
  extend ::Google::Protobuf::MessageExts::ClassMethods
407
440
  end
408
441
 
409
- # Response message for {::Google::Cloud::AIPlatform::V1::JobService::Client#list_batch_prediction_jobs JobService.ListBatchPredictionJobs}
442
+ # Response message for
443
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#list_batch_prediction_jobs JobService.ListBatchPredictionJobs}
410
444
  # @!attribute [rw] batch_prediction_jobs
411
445
  # @return [::Array<::Google::Cloud::AIPlatform::V1::BatchPredictionJob>]
412
446
  # List of BatchPredictionJobs in the requested page.
413
447
  # @!attribute [rw] next_page_token
414
448
  # @return [::String]
415
449
  # A token to retrieve the next page of results.
416
- # Pass to {::Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsRequest#page_token ListBatchPredictionJobsRequest.page_token} to obtain that
417
- # page.
450
+ # Pass to
451
+ # {::Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsRequest#page_token ListBatchPredictionJobsRequest.page_token}
452
+ # to obtain that page.
418
453
  class ListBatchPredictionJobsResponse
419
454
  include ::Google::Protobuf::MessageExts
420
455
  extend ::Google::Protobuf::MessageExts::ClassMethods
421
456
  end
422
457
 
423
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_batch_prediction_job JobService.DeleteBatchPredictionJob}.
458
+ # Request message for
459
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#delete_batch_prediction_job JobService.DeleteBatchPredictionJob}.
424
460
  # @!attribute [rw] name
425
461
  # @return [::String]
426
462
  # Required. The name of the BatchPredictionJob resource to be deleted.
@@ -431,7 +467,8 @@ module Google
431
467
  extend ::Google::Protobuf::MessageExts::ClassMethods
432
468
  end
433
469
 
434
- # Request message for {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_batch_prediction_job JobService.CancelBatchPredictionJob}.
470
+ # Request message for
471
+ # {::Google::Cloud::AIPlatform::V1::JobService::Client#cancel_batch_prediction_job JobService.CancelBatchPredictionJob}.
435
472
  # @!attribute [rw] name
436
473
  # @return [::String]
437
474
  # Required. The name of the BatchPredictionJob to cancel.
@@ -502,11 +539,12 @@ module Google
502
539
  # @!attribute [rw] top_feature_count
503
540
  # @return [::Integer]
504
541
  # If set, all attribution scores between
505
- # {::Google::Cloud::AIPlatform::V1::SearchModelDeploymentMonitoringStatsAnomaliesRequest#start_time SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time} and
506
- # {::Google::Cloud::AIPlatform::V1::SearchModelDeploymentMonitoringStatsAnomaliesRequest#end_time SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time} are
507
- # fetched, and page token doesn't take effect in this case.
508
- # Only used to retrieve attribution score for the top Features which has
509
- # the highest attribution score in the latest monitoring run.
542
+ # {::Google::Cloud::AIPlatform::V1::SearchModelDeploymentMonitoringStatsAnomaliesRequest#start_time SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time}
543
+ # and
544
+ # {::Google::Cloud::AIPlatform::V1::SearchModelDeploymentMonitoringStatsAnomaliesRequest#end_time SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time}
545
+ # are fetched, and page token doesn't take effect in this case. Only used
546
+ # to retrieve attribution score for the top Features which has the highest
547
+ # attribution score in the latest monitoring run.
510
548
  class StatsAnomaliesObjective
511
549
  include ::Google::Protobuf::MessageExts
512
550
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -603,18 +641,17 @@ module Google
603
641
  # {::Google::Cloud::AIPlatform::V1::JobService::Client#update_model_deployment_monitoring_job JobService.UpdateModelDeploymentMonitoringJob}.
604
642
  # @!attribute [rw] model_deployment_monitoring_job
605
643
  # @return [::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob]
606
- # Required. The model monitoring configuration which replaces the resource on the
607
- # server.
644
+ # Required. The model monitoring configuration which replaces the resource on
645
+ # the server.
608
646
  # @!attribute [rw] update_mask
609
647
  # @return [::Google::Protobuf::FieldMask]
610
- # Required. The update mask is used to specify the fields to be overwritten in the
611
- # ModelDeploymentMonitoringJob resource by the update.
612
- # The fields specified in the update_mask are relative to the resource, not
613
- # the full request. A field will be overwritten if it is in the mask. If the
614
- # user does not provide a mask then only the non-empty fields present in the
615
- # request will be overwritten. Set the update_mask to `*` to override all
616
- # fields.
617
- # For the objective config, the user can either provide the update mask for
648
+ # Required. The update mask is used to specify the fields to be overwritten
649
+ # in the ModelDeploymentMonitoringJob resource by the update. The fields
650
+ # specified in the update_mask are relative to the resource, not the full
651
+ # request. A field will be overwritten if it is in the mask. If the user does
652
+ # not provide a mask then only the non-empty fields present in the request
653
+ # will be overwritten. Set the update_mask to `*` to override all fields. For
654
+ # the objective config, the user can either provide the update mask for
618
655
  # model_deployment_monitoring_objective_configs or any combination of its
619
656
  # nested fields, such as:
620
657
  # model_deployment_monitoring_objective_configs.objective_config.training_dataset.
@@ -32,12 +32,15 @@ module Google
32
32
  # See the [list of machine types supported for custom
33
33
  # training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types).
34
34
  #
35
- # For {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel} this field is optional, and the default
36
- # value is `n1-standard-2`. For {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob} or as part of
37
- # {::Google::Cloud::AIPlatform::V1::WorkerPoolSpec WorkerPoolSpec} this field is required.
35
+ # For {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel} this field is
36
+ # optional, and the default value is `n1-standard-2`. For
37
+ # {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob} or as
38
+ # part of {::Google::Cloud::AIPlatform::V1::WorkerPoolSpec WorkerPoolSpec} this
39
+ # field is required.
38
40
  # @!attribute [rw] accelerator_type
39
41
  # @return [::Google::Cloud::AIPlatform::V1::AcceleratorType]
40
- # Immutable. The type of accelerator(s) that may be attached to the machine as per
42
+ # Immutable. The type of accelerator(s) that may be attached to the machine
43
+ # as per
41
44
  # {::Google::Cloud::AIPlatform::V1::MachineSpec#accelerator_count accelerator_count}.
42
45
  # @!attribute [rw] accelerator_count
43
46
  # @return [::Integer]
@@ -51,25 +54,28 @@ module Google
51
54
  # that need a higher degree of manual configuration.
52
55
  # @!attribute [rw] machine_spec
53
56
  # @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
54
- # Required. Immutable. The specification of a single machine used by the prediction.
57
+ # Required. Immutable. The specification of a single machine used by the
58
+ # prediction.
55
59
  # @!attribute [rw] min_replica_count
56
60
  # @return [::Integer]
57
- # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always
58
- # deployed on. This value must be greater than or equal to 1.
61
+ # Required. Immutable. The minimum number of machine replicas this
62
+ # DeployedModel will be always deployed on. This value must be greater than
63
+ # or equal to 1.
59
64
  #
60
65
  # If traffic against the DeployedModel increases, it may dynamically be
61
66
  # deployed onto more replicas, and as traffic decreases, some of these extra
62
67
  # replicas may be freed.
63
68
  # @!attribute [rw] max_replica_count
64
69
  # @return [::Integer]
65
- # Immutable. The maximum number of replicas this DeployedModel may be deployed on when
66
- # the traffic against it increases. If the requested value is too large,
67
- # the deployment will error, but if deployment succeeds then the ability
68
- # to scale the model to that many replicas is guaranteed (barring service
69
- # outages). If traffic against the DeployedModel increases beyond what its
70
- # replicas at maximum may handle, a portion of the traffic will be dropped.
71
- # If this value is not provided, will use {::Google::Cloud::AIPlatform::V1::DedicatedResources#min_replica_count min_replica_count} as the
72
- # default value.
70
+ # Immutable. The maximum number of replicas this DeployedModel may be
71
+ # deployed on when the traffic against it increases. If the requested value
72
+ # is too large, the deployment will error, but if deployment succeeds then
73
+ # the ability to scale the model to that many replicas is guaranteed (barring
74
+ # service outages). If traffic against the DeployedModel increases beyond
75
+ # what its replicas at maximum may handle, a portion of the traffic will be
76
+ # dropped. If this value is not provided, will use
77
+ # {::Google::Cloud::AIPlatform::V1::DedicatedResources#min_replica_count min_replica_count}
78
+ # as the default value.
73
79
  #
74
80
  # The value of this field impacts the charge against Vertex CPU and GPU
75
81
  # quotas. Specifically, you will be charged for (max_replica_count *
@@ -82,21 +88,24 @@ module Google
82
88
  # target value (default to 60 if not set). At most one entry is allowed per
83
89
  # metric.
84
90
  #
85
- # If {::Google::Cloud::AIPlatform::V1::MachineSpec#accelerator_count machine_spec.accelerator_count} is
86
- # above 0, the autoscaling will be based on both CPU utilization and
91
+ # If
92
+ # {::Google::Cloud::AIPlatform::V1::MachineSpec#accelerator_count machine_spec.accelerator_count}
93
+ # is above 0, the autoscaling will be based on both CPU utilization and
87
94
  # accelerator's duty cycle metrics and scale up when either metrics exceeds
88
95
  # its target value while scale down if both metrics are under their target
89
96
  # value. The default target value is 60 for both metrics.
90
97
  #
91
- # If {::Google::Cloud::AIPlatform::V1::MachineSpec#accelerator_count machine_spec.accelerator_count} is
92
- # 0, the autoscaling will be based on CPU utilization metric only with
98
+ # If
99
+ # {::Google::Cloud::AIPlatform::V1::MachineSpec#accelerator_count machine_spec.accelerator_count}
100
+ # is 0, the autoscaling will be based on CPU utilization metric only with
93
101
  # default target value 60 if not explicitly set.
94
102
  #
95
103
  # For example, in the case of Online Prediction, if you want to override
96
104
  # target CPU utilization to 80, you should set
97
105
  # {::Google::Cloud::AIPlatform::V1::AutoscalingMetricSpec#metric_name autoscaling_metric_specs.metric_name}
98
106
  # to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and
99
- # {::Google::Cloud::AIPlatform::V1::AutoscalingMetricSpec#target autoscaling_metric_specs.target} to `80`.
107
+ # {::Google::Cloud::AIPlatform::V1::AutoscalingMetricSpec#target autoscaling_metric_specs.target}
108
+ # to `80`.
100
109
  class DedicatedResources
101
110
  include ::Google::Protobuf::MessageExts
102
111
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -107,22 +116,23 @@ module Google
107
116
  # Each Model supporting these resources documents its specific guidelines.
108
117
  # @!attribute [rw] min_replica_count
109
118
  # @return [::Integer]
110
- # Immutable. The minimum number of replicas this DeployedModel will be always deployed
111
- # on. If traffic against it increases, it may dynamically be deployed onto
112
- # more replicas up to {::Google::Cloud::AIPlatform::V1::AutomaticResources#max_replica_count max_replica_count}, and as traffic decreases, some
113
- # of these extra replicas may be freed.
114
- # If the requested value is too large, the deployment will error.
119
+ # Immutable. The minimum number of replicas this DeployedModel will be always
120
+ # deployed on. If traffic against it increases, it may dynamically be
121
+ # deployed onto more replicas up to
122
+ # {::Google::Cloud::AIPlatform::V1::AutomaticResources#max_replica_count max_replica_count},
123
+ # and as traffic decreases, some of these extra replicas may be freed. If the
124
+ # requested value is too large, the deployment will error.
115
125
  # @!attribute [rw] max_replica_count
116
126
  # @return [::Integer]
117
- # Immutable. The maximum number of replicas this DeployedModel may be deployed on when
118
- # the traffic against it increases. If the requested value is too large,
119
- # the deployment will error, but if deployment succeeds then the ability
120
- # to scale the model to that many replicas is guaranteed (barring service
121
- # outages). If traffic against the DeployedModel increases beyond what its
122
- # replicas at maximum may handle, a portion of the traffic will be dropped.
123
- # If this value is not provided, a no upper bound for scaling under heavy
124
- # traffic will be assume, though Vertex AI may be unable to scale beyond
125
- # certain replica number.
127
+ # Immutable. The maximum number of replicas this DeployedModel may be
128
+ # deployed on when the traffic against it increases. If the requested value
129
+ # is too large, the deployment will error, but if deployment succeeds then
130
+ # the ability to scale the model to that many replicas is guaranteed (barring
131
+ # service outages). If traffic against the DeployedModel increases beyond
132
+ # what its replicas at maximum may handle, a portion of the traffic will be
133
+ # dropped. If this value is not provided, a no upper bound for scaling under
134
+ # heavy traffic will be assume, though Vertex AI may be unable to scale
135
+ # beyond certain replica number.
126
136
  class AutomaticResources
127
137
  include ::Google::Protobuf::MessageExts
128
138
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -135,13 +145,13 @@ module Google
135
145
  # Required. Immutable. The specification of a single machine.
136
146
  # @!attribute [rw] starting_replica_count
137
147
  # @return [::Integer]
138
- # Immutable. The number of machine replicas used at the start of the batch operation.
139
- # If not set, Vertex AI decides starting number, not greater than
148
+ # Immutable. The number of machine replicas used at the start of the batch
149
+ # operation. If not set, Vertex AI decides starting number, not greater than
140
150
  # {::Google::Cloud::AIPlatform::V1::BatchDedicatedResources#max_replica_count max_replica_count}
141
151
  # @!attribute [rw] max_replica_count
142
152
  # @return [::Integer]
143
- # Immutable. The maximum number of machine replicas the batch operation may be scaled
144
- # to. The default value is 10.
153
+ # Immutable. The maximum number of machine replicas the batch operation may
154
+ # be scaled to. The default value is 10.
145
155
  class BatchDedicatedResources
146
156
  include ::Google::Protobuf::MessageExts
147
157
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -150,9 +160,9 @@ module Google
150
160
  # Statistics information about resource consumption.
151
161
  # @!attribute [r] replica_hours
152
162
  # @return [::Float]
153
- # Output only. The number of replica hours used. Note that many replicas may run in
154
- # parallel, and additionally any given work may be queued for some time.
155
- # Therefore this value is not strictly related to wall time.
163
+ # Output only. The number of replica hours used. Note that many replicas may
164
+ # run in parallel, and additionally any given work may be queued for some
165
+ # time. Therefore this value is not strictly related to wall time.
156
166
  class ResourcesConsumed
157
167
  include ::Google::Protobuf::MessageExts
158
168
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -183,8 +193,8 @@ module Google
183
193
  # the source mount path in the form of `server:path`
184
194
  # @!attribute [rw] mount_point
185
195
  # @return [::String]
186
- # Required. Destination mount path. The NFS will be mounted for the user under
187
- # /mnt/nfs/<mount_point>
196
+ # Required. Destination mount path. The NFS will be mounted for the user
197
+ # under /mnt/nfs/<mount_point>
188
198
  class NfsMount
189
199
  include ::Google::Protobuf::MessageExts
190
200
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -24,11 +24,11 @@ module Google
24
24
  # Manual batch tuning parameters.
25
25
  # @!attribute [rw] batch_size
26
26
  # @return [::Integer]
27
- # Immutable. The number of the records (e.g. instances) of the operation given in
28
- # each batch to a machine replica. Machine type, and size of a single
29
- # record should be considered when setting this parameter, higher value
30
- # speeds up the batch operation's execution, but too high value will result
31
- # in a whole batch not fitting in a machine's memory, and the whole
27
+ # Immutable. The number of the records (e.g. instances) of the operation
28
+ # given in each batch to a machine replica. Machine type, and size of a
29
+ # single record should be considered when setting this parameter, higher
30
+ # value speeds up the batch operation's execution, but too high value will
31
+ # result in a whole batch not fitting in a machine's memory, and the whole
32
32
  # operation will fail.
33
33
  # The default value is 64.
34
34
  class ManualBatchTuningParameters
@@ -32,9 +32,9 @@ module Google
32
32
  # allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
33
33
  # @!attribute [rw] schema
34
34
  # @return [::String]
35
- # Required. The raw YAML string representation of the MetadataSchema. The combination
36
- # of [MetadataSchema.version] and the schema name given by `title` in
37
- # [MetadataSchema.schema] must be unique within a MetadataStore.
35
+ # Required. The raw YAML string representation of the MetadataSchema. The
36
+ # combination of [MetadataSchema.version] and the schema name given by
37
+ # `title` in [MetadataSchema.schema] must be unique within a MetadataStore.
38
38
  #
39
39
  # The schema is defined as an OpenAPI 3.0.2
40
40
  # [MetadataSchema