google-cloud-ai_platform-v1 0.16.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 804093fd89318fcc105ad9179cf3543f501fd7f084ab3b3e5ea3547925670c6f
4
- data.tar.gz: b23fe659b2c2f041c25108eaba4b4c5208829d5934a4deaf49cb3fc4e1583606
3
+ metadata.gz: b03faddc60324762295b33bd0a97fdcb1a1f252d978741e797a7342d46757003
4
+ data.tar.gz: cf31ffbb71ffcb19b75ff58d414e5e9310818fc9926db92e62d853b708d27894
5
5
  SHA512:
6
- metadata.gz: c5bcf56c96f0d879dddff0e2de4cd6525a100d54d9e752933bf114ebd706ea23ce7d788a1a4529234495cab6b6796391ccb16d4aee1d34bb69d1e789b7090e63
7
- data.tar.gz: e3f80e129635eda2f455c1a405ae255573edf069ed84cf96109cb5b5cc3b47b2a5ba3daa680e5289789d73015a4f2ffd4d5ed93a4bef5ddf8d998201f8147b49
6
+ metadata.gz: f6ca374c53304c94b2f7deee5a6c1dc5b3e9a64d943859e7bfb170d4578ab245926ec37f145fa3d8e5811558fe29a099d42333abd9be3673c0c549de4f23853d
7
+ data.tar.gz: 34be80ff99785d227656aaa604c9128e89c9f92cfce15553b6e936146194c4366b4ec2e98f85246d42b09312de5f495e020672a727d4fca0956585bee6e2075c
@@ -391,8 +391,8 @@ module Google
391
391
  # Required. The Dataset which replaces the resource on the server.
392
392
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
393
393
  # Required. The update mask applies to the resource.
394
- # For the `FieldMask` definition, see {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
395
- # Updatable fields:
394
+ # For the `FieldMask` definition, see
395
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}. Updatable fields:
396
396
  #
397
397
  # * `display_name`
398
398
  # * `description`
@@ -702,8 +702,8 @@ module Google
702
702
  # Format:
703
703
  # `projects/{project}/locations/{location}/datasets/{dataset}`
704
704
  # @param import_configs [::Array<::Google::Cloud::AIPlatform::V1::ImportDataConfig, ::Hash>]
705
- # Required. The desired input locations. The contents of all input locations will be
706
- # imported in one batch.
705
+ # Required. The desired input locations. The contents of all input locations
706
+ # will be imported in one batch.
707
707
  #
708
708
  # @yield [response, operation] Access the result along with the RPC operation
709
709
  # @yieldparam response [::Gapic::Operation]
@@ -1041,7 +1041,8 @@ module Google
1041
1041
  # Must specify `saved_query_id=` - saved query id that annotations should
1042
1042
  # belong to.
1043
1043
  # @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
1044
- # Mask specifying which fields of {::Google::Cloud::AIPlatform::V1::DataItemView DataItemView} to read.
1044
+ # Mask specifying which fields of
1045
+ # {::Google::Cloud::AIPlatform::V1::DataItemView DataItemView} to read.
1045
1046
  # @param annotations_limit [::Integer]
1046
1047
  # If set, only up to this many of Annotations will be returned per
1047
1048
  # DataItemView. The maximum value is 1000. If not set, the maximum value will
@@ -1055,8 +1056,10 @@ module Google
1055
1056
  # @param page_token [::String]
1056
1057
  # A token identifying a page of results for the server to return
1057
1058
  # Typically obtained via
1058
- # {::Google::Cloud::AIPlatform::V1::SearchDataItemsResponse#next_page_token SearchDataItemsResponse.next_page_token} of the previous
1059
- # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems} call.
1059
+ # {::Google::Cloud::AIPlatform::V1::SearchDataItemsResponse#next_page_token SearchDataItemsResponse.next_page_token}
1060
+ # of the previous
1061
+ # {::Google::Cloud::AIPlatform::V1::DatasetService::Client#search_data_items DatasetService.SearchDataItems}
1062
+ # call.
1060
1063
  #
1061
1064
  # @yield [response, operation] Access the result along with the RPC operation
1062
1065
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItemView>]
@@ -35,7 +35,7 @@ module Google
35
35
  # The service that handles the CRUD of Vertex AI Dataset and its child
36
36
  # resources.
37
37
  #
38
- # To load this service and instantiate a client:
38
+ # @example Load this service and instantiate a gRPC client
39
39
  #
40
40
  # require "google/cloud/ai_platform/v1/dataset_service"
41
41
  # client = ::Google::Cloud::AIPlatform::V1::DatasetService::Client.new
@@ -396,14 +396,15 @@ module Google
396
396
  # the default parameter values, pass an empty Hash as a request object (see above).
397
397
  #
398
398
  # @param parent [::String]
399
- # Required. The resource name of the Location from which to list the Endpoints.
400
- # Format: `projects/{project}/locations/{location}`
399
+ # Required. The resource name of the Location from which to list the
400
+ # Endpoints. Format: `projects/{project}/locations/{location}`
401
401
  # @param filter [::String]
402
- # Optional. An expression for filtering the results of the request. For field names
403
- # both snake_case and camelCase are supported.
402
+ # Optional. An expression for filtering the results of the request. For field
403
+ # names both snake_case and camelCase are supported.
404
404
  #
405
405
  # * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID,
406
- # i.e. the last segment of the Endpoint's {::Google::Cloud::AIPlatform::V1::Endpoint#name resource name}.
406
+ # i.e. the last segment of the Endpoint's [resource
407
+ # name][google.cloud.aiplatform.v1.Endpoint.name].
407
408
  # * `display_name` supports = and, !=
408
409
  # * `labels` supports general map functions that is:
409
410
  # * `labels.key=value` - key:value equality
@@ -419,8 +420,10 @@ module Google
419
420
  # @param page_token [::String]
420
421
  # Optional. The standard list page token.
421
422
  # Typically obtained via
422
- # {::Google::Cloud::AIPlatform::V1::ListEndpointsResponse#next_page_token ListEndpointsResponse.next_page_token} of the previous
423
- # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints} call.
423
+ # {::Google::Cloud::AIPlatform::V1::ListEndpointsResponse#next_page_token ListEndpointsResponse.next_page_token}
424
+ # of the previous
425
+ # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}
426
+ # call.
424
427
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
425
428
  # Optional. Mask specifying which fields to read.
426
429
  # @param order_by [::String]
@@ -525,7 +528,8 @@ module Google
525
528
  # @param endpoint [::Google::Cloud::AIPlatform::V1::Endpoint, ::Hash]
526
529
  # Required. The Endpoint which replaces the resource on the server.
527
530
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
528
- # Required. The update mask applies to the resource. See {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
531
+ # Required. The update mask applies to the resource. See
532
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
529
533
  #
530
534
  # @yield [response, operation] Access the result along with the RPC operation
531
535
  # @yieldparam response [::Google::Cloud::AIPlatform::V1::Endpoint]
@@ -710,21 +714,24 @@ module Google
710
714
  # `projects/{project}/locations/{location}/endpoints/{endpoint}`
711
715
  # @param deployed_model [::Google::Cloud::AIPlatform::V1::DeployedModel, ::Hash]
712
716
  # Required. The DeployedModel to be created within the Endpoint. Note that
713
- # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split Endpoint.traffic_split} must be updated for the DeployedModel to start
714
- # receiving traffic, either as part of this call, or via
717
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split Endpoint.traffic_split}
718
+ # must be updated for the DeployedModel to start receiving traffic, either as
719
+ # part of this call, or via
715
720
  # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint EndpointService.UpdateEndpoint}.
716
721
  # @param traffic_split [::Hash{::String => ::Integer}]
717
722
  # A map from a DeployedModel's ID to the percentage of this Endpoint's
718
723
  # traffic that should be forwarded to that DeployedModel.
719
724
  #
720
725
  # If this field is non-empty, then the Endpoint's
721
- # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be overwritten with it.
722
- # To refer to the ID of the just being deployed Model, a "0" should be used,
723
- # and the actual ID of the new DeployedModel will be filled in its place by
724
- # this method. The traffic percentage values must add up to 100.
726
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be
727
+ # overwritten with it. To refer to the ID of the just being deployed Model, a
728
+ # "0" should be used, and the actual ID of the new DeployedModel will be
729
+ # filled in its place by this method. The traffic percentage values must add
730
+ # up to 100.
725
731
  #
726
732
  # If this field is empty, then the Endpoint's
727
- # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} is not updated.
733
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} is not
734
+ # updated.
728
735
  #
729
736
  # @yield [response, operation] Access the result along with the RPC operation
730
737
  # @yieldparam response [::Gapic::Operation]
@@ -825,12 +832,12 @@ module Google
825
832
  # Required. The ID of the DeployedModel to be undeployed from the Endpoint.
826
833
  # @param traffic_split [::Hash{::String => ::Integer}]
827
834
  # If this field is provided, then the Endpoint's
828
- # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be overwritten with it. If
829
- # last DeployedModel is being undeployed from the Endpoint, the
830
- # [Endpoint.traffic_split] will always end up empty when this call returns.
831
- # A DeployedModel will be successfully undeployed only if it doesn't have
832
- # any traffic assigned to it when this method executes, or if this field
833
- # unassigns any traffic to it.
835
+ # {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be
836
+ # overwritten with it. If last DeployedModel is being undeployed from the
837
+ # Endpoint, the [Endpoint.traffic_split] will always end up empty when this
838
+ # call returns. A DeployedModel will be successfully undeployed only if it
839
+ # doesn't have any traffic assigned to it when this method executes, or if
840
+ # this field unassigns any traffic to it.
834
841
  #
835
842
  # @yield [response, operation] Access the result along with the RPC operation
836
843
  # @yieldparam response [::Gapic::Operation]
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # A service for managing Vertex AI's Endpoints.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/ai_platform/v1/endpoint_service"
40
40
  # client = ::Google::Cloud::AIPlatform::V1::EndpointService::Client.new
@@ -297,12 +297,12 @@ module Google
297
297
  # for a machine learning model predicting user clicks on a website, an
298
298
  # EntityType ID could be `user`.
299
299
  # @param entity_ids [::Array<::String>]
300
- # Required. IDs of entities to read Feature values of. The maximum number of IDs is
301
- # 100. For example, for a machine learning model predicting user clicks on a
302
- # website, an entity ID could be `user_123`.
300
+ # Required. IDs of entities to read Feature values of. The maximum number of
301
+ # IDs is 100. For example, for a machine learning model predicting user
302
+ # clicks on a website, an entity ID could be `user_123`.
303
303
  # @param feature_selector [::Google::Cloud::AIPlatform::V1::FeatureSelector, ::Hash]
304
- # Required. Selector choosing Features of the target EntityType. Feature IDs will be
305
- # deduplicated.
304
+ # Required. Selector choosing Features of the target EntityType. Feature IDs
305
+ # will be deduplicated.
306
306
  #
307
307
  # @yield [response, operation] Access the result along with the RPC operation
308
308
  # @yieldparam response [::Enumerable<::Google::Cloud::AIPlatform::V1::ReadFeatureValuesResponse>]
@@ -394,14 +394,15 @@ module Google
394
394
  # the default parameter values, pass an empty Hash as a request object (see above).
395
395
  #
396
396
  # @param entity_type [::String]
397
- # Required. The resource name of the EntityType for the entities being written.
398
- # Value format: `projects/{project}/locations/{location}/featurestores/
397
+ # Required. The resource name of the EntityType for the entities being
398
+ # written. Value format:
399
+ # `projects/{project}/locations/{location}/featurestores/
399
400
  # \\{featurestore}/entityTypes/\\{entityType}`. For example,
400
401
  # for a machine learning model predicting user clicks on a website, an
401
402
  # EntityType ID could be `user`.
402
403
  # @param payloads [::Array<::Google::Cloud::AIPlatform::V1::WriteFeatureValuesPayload, ::Hash>]
403
- # Required. The entities to be written. Up to 100,000 feature values can be written
404
- # across all `payloads`.
404
+ # Required. The entities to be written. Up to 100,000 feature values can be
405
+ # written across all `payloads`.
405
406
  #
406
407
  # @yield [response, operation] Access the result along with the RPC operation
407
408
  # @yieldparam response [::Google::Cloud::AIPlatform::V1::WriteFeatureValuesResponse]
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # A service for serving online feature values.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/ai_platform/v1/featurestore_online_serving_service"
39
39
  # client = ::Google::Cloud::AIPlatform::V1::FeaturestoreOnlineServingService::Client.new
@@ -210,8 +210,8 @@ module Google
210
210
  # @param featurestore [::Google::Cloud::AIPlatform::V1::Featurestore, ::Hash]
211
211
  # Required. The Featurestore to create.
212
212
  # @param featurestore_id [::String]
213
- # Required. The ID to use for this Featurestore, which will become the final component
214
- # of the Featurestore's resource name.
213
+ # Required. The ID to use for this Featurestore, which will become the final
214
+ # component of the Featurestore's resource name.
215
215
  #
216
216
  # This value may be up to 60 characters, and valid characters are
217
217
  # `[a-z0-9_]`. The first character cannot be a number.
@@ -424,12 +424,12 @@ module Google
424
424
  # coerced to 100.
425
425
  # @param page_token [::String]
426
426
  # A page token, received from a previous
427
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores} call.
428
- # Provide this to retrieve the subsequent page.
427
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores}
428
+ # call. Provide this to retrieve the subsequent page.
429
429
  #
430
430
  # When paginating, all other parameters provided to
431
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores} must
432
- # match the call that provided the page token.
431
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_featurestores FeaturestoreService.ListFeaturestores}
432
+ # must match the call that provided the page token.
433
433
  # @param order_by [::String]
434
434
  # A comma-separated list of fields to order by, sorted in ascending order.
435
435
  # Use "desc" after a field name for descending.
@@ -531,9 +531,8 @@ module Google
531
531
  # the default parameter values, pass an empty Hash as a request object (see above).
532
532
  #
533
533
  # @param featurestore [::Google::Cloud::AIPlatform::V1::Featurestore, ::Hash]
534
- # Required. The Featurestore's `name` field is used to identify the Featurestore to be
535
- # updated.
536
- # Format:
534
+ # Required. The Featurestore's `name` field is used to identify the
535
+ # Featurestore to be updated. Format:
537
536
  # `projects/{project}/locations/{location}/featurestores/{featurestore}`
538
537
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
539
538
  # Field mask is used to specify the fields to be overwritten in the
@@ -549,6 +548,7 @@ module Google
549
548
  # * `labels`
550
549
  # * `online_serving_config.fixed_node_count`
551
550
  # * `online_serving_config.scaling`
551
+ # * `online_storage_ttl_days` (available in Preview)
552
552
  #
553
553
  # @yield [response, operation] Access the result along with the RPC operation
554
554
  # @yieldparam response [::Gapic::Operation]
@@ -747,8 +747,8 @@ module Google
747
747
  # @param entity_type [::Google::Cloud::AIPlatform::V1::EntityType, ::Hash]
748
748
  # The EntityType to create.
749
749
  # @param entity_type_id [::String]
750
- # Required. The ID to use for the EntityType, which will become the final component of
751
- # the EntityType's resource name.
750
+ # Required. The ID to use for the EntityType, which will become the final
751
+ # component of the EntityType's resource name.
752
752
  #
753
753
  # This value may be up to 60 characters, and valid characters are
754
754
  # `[a-z0-9_]`. The first character cannot be a number.
@@ -962,12 +962,12 @@ module Google
962
962
  # 1000.
963
963
  # @param page_token [::String]
964
964
  # A page token, received from a previous
965
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes} call.
966
- # Provide this to retrieve the subsequent page.
965
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes}
966
+ # call. Provide this to retrieve the subsequent page.
967
967
  #
968
968
  # When paginating, all other parameters provided to
969
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes} must
970
- # match the call that provided the page token.
969
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_entity_types FeaturestoreService.ListEntityTypes}
970
+ # must match the call that provided the page token.
971
971
  # @param order_by [::String]
972
972
  # A comma-separated list of fields to order by, sorted in ascending order.
973
973
  # Use "desc" after a field name for descending.
@@ -1070,9 +1070,8 @@ module Google
1070
1070
  # the default parameter values, pass an empty Hash as a request object (see above).
1071
1071
  #
1072
1072
  # @param entity_type [::Google::Cloud::AIPlatform::V1::EntityType, ::Hash]
1073
- # Required. The EntityType's `name` field is used to identify the EntityType to be
1074
- # updated.
1075
- # Format:
1073
+ # Required. The EntityType's `name` field is used to identify the EntityType
1074
+ # to be updated. Format:
1076
1075
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
1077
1076
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1078
1077
  # Field mask is used to specify the fields to be overwritten in the
@@ -1094,6 +1093,7 @@ module Google
1094
1093
  # * `monitoring_config.import_features_analysis.anomaly_detection_baseline`
1095
1094
  # * `monitoring_config.numerical_threshold_config.value`
1096
1095
  # * `monitoring_config.categorical_threshold_config.value`
1096
+ # * `offline_storage_ttl_days` (available in Preview)
1097
1097
  #
1098
1098
  # @yield [response, operation] Access the result along with the RPC operation
1099
1099
  # @yieldparam response [::Google::Cloud::AIPlatform::V1::EntityType]
@@ -1283,8 +1283,8 @@ module Google
1283
1283
  # @param feature [::Google::Cloud::AIPlatform::V1::Feature, ::Hash]
1284
1284
  # Required. The Feature to create.
1285
1285
  # @param feature_id [::String]
1286
- # Required. The ID to use for the Feature, which will become the final component of
1287
- # the Feature's resource name.
1286
+ # Required. The ID to use for the Feature, which will become the final
1287
+ # component of the Feature's resource name.
1288
1288
  #
1289
1289
  # This value may be up to 128 characters, and valid characters are
1290
1290
  # `[a-z0-9_]`. The first character cannot be a number.
@@ -1382,14 +1382,15 @@ module Google
1382
1382
  # the default parameter values, pass an empty Hash as a request object (see above).
1383
1383
  #
1384
1384
  # @param parent [::String]
1385
- # Required. The resource name of the EntityType to create the batch of Features under.
1386
- # Format:
1385
+ # Required. The resource name of the EntityType to create the batch of
1386
+ # Features under. Format:
1387
1387
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
1388
1388
  # @param requests [::Array<::Google::Cloud::AIPlatform::V1::CreateFeatureRequest, ::Hash>]
1389
- # Required. The request message specifying the Features to create. All Features must be
1390
- # created under the same parent EntityType. The `parent` field in each child
1391
- # request message can be omitted. If `parent` is set in a child request, then
1392
- # the value must match the `parent` value in this request message.
1389
+ # Required. The request message specifying the Features to create. All
1390
+ # Features must be created under the same parent EntityType. The `parent`
1391
+ # field in each child request message can be omitted. If `parent` is set in a
1392
+ # child request, then the value must match the `parent` value in this request
1393
+ # message.
1393
1394
  #
1394
1395
  # @yield [response, operation] Access the result along with the RPC operation
1395
1396
  # @yieldparam response [::Gapic::Operation]
@@ -1600,12 +1601,12 @@ module Google
1600
1601
  # 1000.
1601
1602
  # @param page_token [::String]
1602
1603
  # A page token, received from a previous
1603
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures} call.
1604
- # Provide this to retrieve the subsequent page.
1604
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures}
1605
+ # call. Provide this to retrieve the subsequent page.
1605
1606
  #
1606
1607
  # When paginating, all other parameters provided to
1607
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures} must
1608
- # match the call that provided the page token.
1608
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#list_features FeaturestoreService.ListFeatures}
1609
+ # must match the call that provided the page token.
1609
1610
  # @param order_by [::String]
1610
1611
  # A comma-separated list of fields to order by, sorted in ascending order.
1611
1612
  # Use "desc" after a field name for descending.
@@ -1618,10 +1619,12 @@ module Google
1618
1619
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
1619
1620
  # Mask specifying which fields to read.
1620
1621
  # @param latest_stats_count [::Integer]
1621
- # If set, return the most recent {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#latest_stats_count ListFeaturesRequest.latest_stats_count}
1622
+ # If set, return the most recent
1623
+ # {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#latest_stats_count ListFeaturesRequest.latest_stats_count}
1622
1624
  # of stats for each Feature in response. Valid value is [0, 10]. If number of
1623
- # stats exists < {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#latest_stats_count ListFeaturesRequest.latest_stats_count}, return all
1624
- # existing stats.
1625
+ # stats exists <
1626
+ # {::Google::Cloud::AIPlatform::V1::ListFeaturesRequest#latest_stats_count ListFeaturesRequest.latest_stats_count},
1627
+ # return all existing stats.
1625
1628
  #
1626
1629
  # @yield [response, operation] Access the result along with the RPC operation
1627
1630
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Feature>]
@@ -1938,16 +1941,16 @@ module Google
1938
1941
  # Single Feature timestamp for all entities being imported. The
1939
1942
  # timestamp must not have higher than millisecond precision.
1940
1943
  # @param entity_type [::String]
1941
- # Required. The resource name of the EntityType grouping the Features for which values
1942
- # are being imported. Format:
1944
+ # Required. The resource name of the EntityType grouping the Features for
1945
+ # which values are being imported. Format:
1943
1946
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
1944
1947
  # @param entity_id_field [::String]
1945
1948
  # Source column that holds entity IDs. If not provided, entity IDs are
1946
1949
  # extracted from the column named `entity_id`.
1947
1950
  # @param feature_specs [::Array<::Google::Cloud::AIPlatform::V1::ImportFeatureValuesRequest::FeatureSpec, ::Hash>]
1948
- # Required. Specifications defining which Feature values to import from the entity. The
1949
- # request fails if no feature_specs are provided, and having multiple
1950
- # feature_specs for one Feature is not allowed.
1951
+ # Required. Specifications defining which Feature values to import from the
1952
+ # entity. The request fails if no feature_specs are provided, and having
1953
+ # multiple feature_specs for one Feature is not allowed.
1951
1954
  # @param disable_online_serving [::Boolean]
1952
1955
  # If set, data will not be imported for online serving. This
1953
1956
  # is typically used for backfilling, where Feature generation timestamps are
@@ -2085,8 +2088,8 @@ module Google
2085
2088
  # @param bigquery_read_instances [::Google::Cloud::AIPlatform::V1::BigQuerySource, ::Hash]
2086
2089
  # Similar to csv_read_instances, but from BigQuery source.
2087
2090
  # @param featurestore [::String]
2088
- # Required. The resource name of the Featurestore from which to query Feature values.
2089
- # Format:
2091
+ # Required. The resource name of the Featurestore from which to query Feature
2092
+ # values. Format:
2090
2093
  # `projects/{project}/locations/{location}/featurestores/{featurestore}`
2091
2094
  # @param destination [::Google::Cloud::AIPlatform::V1::FeatureValueDestination, ::Hash]
2092
2095
  # Required. Specifies output location and format.
@@ -2099,14 +2102,14 @@ module Google
2099
2102
  # automatically inferred. For CSV source, the pass-through values will be
2100
2103
  # passed as opaque bytes.
2101
2104
  # @param entity_type_specs [::Array<::Google::Cloud::AIPlatform::V1::BatchReadFeatureValuesRequest::EntityTypeSpec, ::Hash>]
2102
- # Required. Specifies EntityType grouping Features to read values of and settings.
2103
- # Each EntityType referenced in
2105
+ # Required. Specifies EntityType grouping Features to read values of and
2106
+ # settings. Each EntityType referenced in
2104
2107
  # [BatchReadFeatureValuesRequest.entity_type_specs] must have a column
2105
2108
  # specifying entity IDs in the EntityType in
2106
2109
  # [BatchReadFeatureValuesRequest.request][] .
2107
2110
  # @param start_time [::Google::Protobuf::Timestamp, ::Hash]
2108
- # Optional. Excludes Feature values with feature generation timestamp before this
2109
- # timestamp. If not set, retrieve oldest values kept in Feature Store.
2111
+ # Optional. Excludes Feature values with feature generation timestamp before
2112
+ # this timestamp. If not set, retrieve oldest values kept in Feature Store.
2110
2113
  # Timestamp, if present, must not have higher than millisecond precision.
2111
2114
  #
2112
2115
  # @yield [response, operation] Access the result along with the RPC operation
@@ -2206,8 +2209,8 @@ module Google
2206
2209
  # Exports all historical values of all entities of the EntityType within a
2207
2210
  # time range
2208
2211
  # @param entity_type [::String]
2209
- # Required. The resource name of the EntityType from which to export Feature values.
2210
- # Format:
2212
+ # Required. The resource name of the EntityType from which to export Feature
2213
+ # values. Format:
2211
2214
  # `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
2212
2215
  # @param destination [::Google::Cloud::AIPlatform::V1::FeatureValueDestination, ::Hash]
2213
2216
  # Required. Specifies destination location and format.
@@ -2377,12 +2380,12 @@ module Google
2377
2380
  # 100.
2378
2381
  # @param page_token [::String]
2379
2382
  # A page token, received from a previous
2380
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures} call.
2381
- # Provide this to retrieve the subsequent page.
2383
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures}
2384
+ # call. Provide this to retrieve the subsequent page.
2382
2385
  #
2383
2386
  # When paginating, all other parameters provided to
2384
- # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures}, except `page_size`, must
2385
- # match the call that provided the page token.
2387
+ # {::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client#search_features FeaturestoreService.SearchFeatures},
2388
+ # except `page_size`, must match the call that provided the page token.
2386
2389
  #
2387
2390
  # @yield [response, operation] Access the result along with the RPC operation
2388
2391
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Feature>]
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # The service that handles CRUD and List for resources for Featurestore.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/ai_platform/v1/featurestore_service"
40
40
  # client = ::Google::Cloud::AIPlatform::V1::FeaturestoreService::Client.new
@@ -387,11 +387,11 @@ module Google
387
387
  # the default parameter values, pass an empty Hash as a request object (see above).
388
388
  #
389
389
  # @param parent [::String]
390
- # Required. The resource name of the Location from which to list the IndexEndpoints.
391
- # Format: `projects/{project}/locations/{location}`
390
+ # Required. The resource name of the Location from which to list the
391
+ # IndexEndpoints. Format: `projects/{project}/locations/{location}`
392
392
  # @param filter [::String]
393
- # Optional. An expression for filtering the results of the request. For field names
394
- # both snake_case and camelCase are supported.
393
+ # Optional. An expression for filtering the results of the request. For field
394
+ # names both snake_case and camelCase are supported.
395
395
  #
396
396
  # * `index_endpoint` supports = and !=. `index_endpoint` represents the
397
397
  # IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
@@ -413,8 +413,10 @@ module Google
413
413
  # @param page_token [::String]
414
414
  # Optional. The standard list page token.
415
415
  # Typically obtained via
416
- # {::Google::Cloud::AIPlatform::V1::ListIndexEndpointsResponse#next_page_token ListIndexEndpointsResponse.next_page_token} of the previous
417
- # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints} call.
416
+ # {::Google::Cloud::AIPlatform::V1::ListIndexEndpointsResponse#next_page_token ListIndexEndpointsResponse.next_page_token}
417
+ # of the previous
418
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints}
419
+ # call.
418
420
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
419
421
  # Optional. Mask specifying which fields to read.
420
422
  #
@@ -510,7 +512,8 @@ module Google
510
512
  # @param index_endpoint [::Google::Cloud::AIPlatform::V1::IndexEndpoint, ::Hash]
511
513
  # Required. The IndexEndpoint which replaces the resource on the server.
512
514
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
513
- # Required. The update mask applies to the resource. See {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
515
+ # Required. The update mask applies to the resource. See
516
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
514
517
  #
515
518
  # @yield [response, operation] Access the result along with the RPC operation
516
519
  # @yieldparam response [::Google::Cloud::AIPlatform::V1::IndexEndpoint]
@@ -692,8 +695,8 @@ module Google
692
695
  # the default parameter values, pass an empty Hash as a request object (see above).
693
696
  #
694
697
  # @param index_endpoint [::String]
695
- # Required. The name of the IndexEndpoint resource into which to deploy an Index.
696
- # Format:
698
+ # Required. The name of the IndexEndpoint resource into which to deploy an
699
+ # Index. Format:
697
700
  # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
698
701
  # @param deployed_index [::Google::Cloud::AIPlatform::V1::DeployedIndex, ::Hash]
699
702
  # Required. The DeployedIndex to be created within the IndexEndpoint.
@@ -790,11 +793,12 @@ module Google
790
793
  # the default parameter values, pass an empty Hash as a request object (see above).
791
794
  #
792
795
  # @param index_endpoint [::String]
793
- # Required. The name of the IndexEndpoint resource from which to undeploy an Index.
794
- # Format:
796
+ # Required. The name of the IndexEndpoint resource from which to undeploy an
797
+ # Index. Format:
795
798
  # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
796
799
  # @param deployed_index_id [::String]
797
- # Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
800
+ # Required. The ID of the DeployedIndex to be undeployed from the
801
+ # IndexEndpoint.
798
802
  #
799
803
  # @yield [response, operation] Access the result along with the RPC operation
800
804
  # @yieldparam response [::Gapic::Operation]
@@ -887,8 +891,8 @@ module Google
887
891
  # the default parameter values, pass an empty Hash as a request object (see above).
888
892
  #
889
893
  # @param index_endpoint [::String]
890
- # Required. The name of the IndexEndpoint resource into which to deploy an Index.
891
- # Format:
894
+ # Required. The name of the IndexEndpoint resource into which to deploy an
895
+ # Index. Format:
892
896
  # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
893
897
  # @param deployed_index [::Google::Cloud::AIPlatform::V1::DeployedIndex, ::Hash]
894
898
  # Required. The DeployedIndex to be updated within the IndexEndpoint.
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # A service for managing Vertex AI's IndexEndpoints.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/ai_platform/v1/index_endpoint_service"
40
40
  # client = ::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client.new
@@ -396,8 +396,10 @@ module Google
396
396
  # @param page_token [::String]
397
397
  # The standard list page token.
398
398
  # Typically obtained via
399
- # {::Google::Cloud::AIPlatform::V1::ListIndexesResponse#next_page_token ListIndexesResponse.next_page_token} of the previous
400
- # {::Google::Cloud::AIPlatform::V1::IndexService::Client#list_indexes IndexService.ListIndexes} call.
399
+ # {::Google::Cloud::AIPlatform::V1::ListIndexesResponse#next_page_token ListIndexesResponse.next_page_token}
400
+ # of the previous
401
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#list_indexes IndexService.ListIndexes}
402
+ # call.
401
403
  # @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
402
404
  # Mask specifying which fields to read.
403
405
  #
@@ -494,7 +496,8 @@ module Google
494
496
  # Required. The Index which updates the resource on the server.
495
497
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
496
498
  # The update mask applies to the resource.
497
- # For the `FieldMask` definition, see {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
499
+ # For the `FieldMask` definition, see
500
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
498
501
  #
499
502
  # @yield [response, operation] Access the result along with the RPC operation
500
503
  # @yieldparam response [::Gapic::Operation]
@@ -571,7 +574,8 @@ module Google
571
574
  ##
572
575
  # Deletes an Index.
573
576
  # An Index can only be deleted when all its
574
- # {::Google::Cloud::AIPlatform::V1::Index#deployed_indexes DeployedIndexes} had been undeployed.
577
+ # {::Google::Cloud::AIPlatform::V1::Index#deployed_indexes DeployedIndexes} had
578
+ # been undeployed.
575
579
  #
576
580
  # @overload delete_index(request, options = nil)
577
581
  # Pass arguments to `delete_index` via a request object, either of type
@@ -34,7 +34,7 @@ module Google
34
34
  ##
35
35
  # A service for creating and managing Vertex AI's Index resources.
36
36
  #
37
- # To load this service and instantiate a client:
37
+ # @example Load this service and instantiate a gRPC client
38
38
  #
39
39
  # require "google/cloud/ai_platform/v1/index_service"
40
40
  # client = ::Google::Cloud::AIPlatform::V1::IndexService::Client.new