google-cloud-ai_platform-v1 0.15.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/ai_platform/v1/dataset_service/client.rb +164 -4
  4. data/lib/google/cloud/ai_platform/v1/dataset_service/paths.rb +21 -0
  5. data/lib/google/cloud/ai_platform/v1/dataset_service.rb +1 -1
  6. data/lib/google/cloud/ai_platform/v1/endpoint_service/client.rb +28 -21
  7. data/lib/google/cloud/ai_platform/v1/endpoint_service.rb +1 -1
  8. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service/client.rb +109 -5
  9. data/lib/google/cloud/ai_platform/v1/featurestore_online_serving_service.rb +1 -1
  10. data/lib/google/cloud/ai_platform/v1/featurestore_service/client.rb +53 -50
  11. data/lib/google/cloud/ai_platform/v1/featurestore_service.rb +1 -1
  12. data/lib/google/cloud/ai_platform/v1/index_endpoint_service/client.rb +18 -14
  13. data/lib/google/cloud/ai_platform/v1/index_endpoint_service.rb +1 -1
  14. data/lib/google/cloud/ai_platform/v1/index_service/client.rb +8 -4
  15. data/lib/google/cloud/ai_platform/v1/index_service.rb +1 -1
  16. data/lib/google/cloud/ai_platform/v1/job_service/client.rb +53 -36
  17. data/lib/google/cloud/ai_platform/v1/job_service.rb +1 -1
  18. data/lib/google/cloud/ai_platform/v1/metadata_service/client.rb +33 -36
  19. data/lib/google/cloud/ai_platform/v1/metadata_service.rb +1 -1
  20. data/lib/google/cloud/ai_platform/v1/migration_service/client.rb +3 -4
  21. data/lib/google/cloud/ai_platform/v1/migration_service.rb +1 -1
  22. data/lib/google/cloud/ai_platform/v1/model_service/client.rb +53 -23
  23. data/lib/google/cloud/ai_platform/v1/model_service.rb +1 -1
  24. data/lib/google/cloud/ai_platform/v1/pipeline_service/client.rb +28 -17
  25. data/lib/google/cloud/ai_platform/v1/pipeline_service.rb +1 -1
  26. data/lib/google/cloud/ai_platform/v1/prediction_service/client.rb +28 -19
  27. data/lib/google/cloud/ai_platform/v1/prediction_service.rb +1 -1
  28. data/lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb +5 -3
  29. data/lib/google/cloud/ai_platform/v1/specialist_pool_service.rb +1 -1
  30. data/lib/google/cloud/ai_platform/v1/tensorboard_service/client.rb +165 -71
  31. data/lib/google/cloud/ai_platform/v1/tensorboard_service.rb +1 -1
  32. data/lib/google/cloud/ai_platform/v1/version.rb +1 -1
  33. data/lib/google/cloud/ai_platform/v1/vizier_service.rb +1 -1
  34. data/lib/google/cloud/ai_platform/v1.rb +2 -2
  35. data/lib/google/cloud/aiplatform/v1/batch_prediction_job_pb.rb +8 -0
  36. data/lib/google/cloud/aiplatform/v1/dataset_pb.rb +3 -0
  37. data/lib/google/cloud/aiplatform/v1/dataset_service_pb.rb +34 -0
  38. data/lib/google/cloud/aiplatform/v1/dataset_service_services_pb.rb +2 -0
  39. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_pb.rb +13 -0
  40. data/lib/google/cloud/aiplatform/v1/featurestore_online_service_services_pb.rb +6 -0
  41. data/lib/google/cloud/aiplatform/v1/featurestore_service_pb.rb +1 -0
  42. data/lib/google/cloud/aiplatform/v1/index_service_services_pb.rb +2 -1
  43. data/lib/google/cloud/aiplatform/v1/job_service_services_pb.rb +24 -14
  44. data/lib/google/cloud/aiplatform/v1/model_service_pb.rb +2 -0
  45. data/lib/google/cloud/aiplatform/v1/model_service_services_pb.rb +10 -5
  46. data/lib/google/cloud/aiplatform/v1/pipeline_service_services_pb.rb +16 -9
  47. data/lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb +10 -6
  48. data/lib/google/cloud/aiplatform/v1/study_pb.rb +1 -0
  49. data/lib/google/cloud/aiplatform/v1/tensorboard_service_pb.rb +17 -0
  50. data/lib/google/cloud/aiplatform/v1/tensorboard_service_services_pb.rb +8 -8
  51. data/proto_docs/google/cloud/aiplatform/v1/annotation.rb +9 -6
  52. data/proto_docs/google/cloud/aiplatform/v1/annotation_spec.rb +3 -3
  53. data/proto_docs/google/cloud/aiplatform/v1/batch_prediction_job.rb +185 -52
  54. data/proto_docs/google/cloud/aiplatform/v1/completion_stats.rb +8 -7
  55. data/proto_docs/google/cloud/aiplatform/v1/context.rb +2 -2
  56. data/proto_docs/google/cloud/aiplatform/v1/custom_job.rb +23 -18
  57. data/proto_docs/google/cloud/aiplatform/v1/data_item.rb +6 -5
  58. data/proto_docs/google/cloud/aiplatform/v1/data_labeling_job.rb +17 -17
  59. data/proto_docs/google/cloud/aiplatform/v1/dataset.rb +38 -17
  60. data/proto_docs/google/cloud/aiplatform/v1/dataset_service.rb +180 -24
  61. data/proto_docs/google/cloud/aiplatform/v1/encryption_spec.rb +2 -2
  62. data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb +39 -24
  63. data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb +57 -35
  64. data/proto_docs/google/cloud/aiplatform/v1/entity_type.rb +8 -6
  65. data/proto_docs/google/cloud/aiplatform/v1/explanation.rb +111 -75
  66. data/proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb +58 -38
  67. data/proto_docs/google/cloud/aiplatform/v1/feature.rb +9 -6
  68. data/proto_docs/google/cloud/aiplatform/v1/feature_monitoring_stats.rb +2 -1
  69. data/proto_docs/google/cloud/aiplatform/v1/featurestore.rb +12 -11
  70. data/proto_docs/google/cloud/aiplatform/v1/featurestore_monitoring.rb +6 -2
  71. data/proto_docs/google/cloud/aiplatform/v1/featurestore_online_service.rb +65 -10
  72. data/proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb +141 -99
  73. data/proto_docs/google/cloud/aiplatform/v1/hyperparameter_tuning_job.rb +10 -8
  74. data/proto_docs/google/cloud/aiplatform/v1/index.rb +19 -18
  75. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint.rb +36 -24
  76. data/proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb +49 -29
  77. data/proto_docs/google/cloud/aiplatform/v1/index_service.rb +35 -17
  78. data/proto_docs/google/cloud/aiplatform/v1/io.rb +2 -1
  79. data/proto_docs/google/cloud/aiplatform/v1/job_service.rb +94 -57
  80. data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb +53 -43
  81. data/proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb +5 -5
  82. data/proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb +3 -3
  83. data/proto_docs/google/cloud/aiplatform/v1/metadata_service.rb +141 -91
  84. data/proto_docs/google/cloud/aiplatform/v1/migratable_resource.rb +3 -3
  85. data/proto_docs/google/cloud/aiplatform/v1/migration_service.rb +18 -15
  86. data/proto_docs/google/cloud/aiplatform/v1/model.rb +180 -133
  87. data/proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb +22 -18
  88. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation.rb +7 -6
  89. data/proto_docs/google/cloud/aiplatform/v1/model_evaluation_slice.rb +11 -7
  90. data/proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb +4 -2
  91. data/proto_docs/google/cloud/aiplatform/v1/model_service.rb +119 -54
  92. data/proto_docs/google/cloud/aiplatform/v1/operation.rb +1 -1
  93. data/proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb +59 -45
  94. data/proto_docs/google/cloud/aiplatform/v1/pipeline_service.rb +42 -22
  95. data/proto_docs/google/cloud/aiplatform/v1/prediction_service.rb +42 -28
  96. data/proto_docs/google/cloud/aiplatform/v1/saved_query.rb +2 -2
  97. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool.rb +1 -1
  98. data/proto_docs/google/cloud/aiplatform/v1/specialist_pool_service.rb +19 -11
  99. data/proto_docs/google/cloud/aiplatform/v1/study.rb +42 -25
  100. data/proto_docs/google/cloud/aiplatform/v1/tensorboard.rb +3 -3
  101. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_data.rb +8 -7
  102. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb +2 -1
  103. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_service.rb +203 -109
  104. data/proto_docs/google/cloud/aiplatform/v1/tensorboard_time_series.rb +8 -6
  105. data/proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb +84 -59
  106. data/proto_docs/google/cloud/aiplatform/v1/unmanaged_container_model.rb +2 -2
  107. data/proto_docs/google/cloud/aiplatform/v1/vizier_service.rb +40 -20
  108. data/proto_docs/google/rpc/status.rb +4 -2
  109. metadata +5 -5
@@ -29,17 +29,17 @@ module Google
29
29
  # @!attribute [rw] display_name
30
30
  # @return [::String]
31
31
  # Required. The display name of the Index.
32
- # The name can be up to 128 characters long and can be consist of any UTF-8
32
+ # The name can be up to 128 characters long and can consist of any UTF-8
33
33
  # characters.
34
34
  # @!attribute [rw] description
35
35
  # @return [::String]
36
36
  # The description of the Index.
37
37
  # @!attribute [rw] metadata_schema_uri
38
38
  # @return [::String]
39
- # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
40
- # information about the Index, that is specific to it. Unset if the Index
41
- # does not have any additional information.
42
- # The schema is defined as an OpenAPI 3.0.2 [Schema
39
+ # Immutable. Points to a YAML file stored on Google Cloud Storage describing
40
+ # additional information about the Index, that is specific to it. Unset if
41
+ # the Index does not have any additional information. The schema is defined
42
+ # as an OpenAPI 3.0.2 [Schema
43
43
  # Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
44
44
  # Note: The URI given on output will be immutable and probably different,
45
45
  # including the URI scheme, than the one given on input. The output URI will
@@ -47,7 +47,8 @@ module Google
47
47
  # @!attribute [rw] metadata
48
48
  # @return [::Google::Protobuf::Value]
49
49
  # An additional information about the Index; the schema of the metadata can
50
- # be found in {::Google::Cloud::AIPlatform::V1::Index#metadata_schema_uri metadata_schema}.
50
+ # be found in
51
+ # {::Google::Cloud::AIPlatform::V1::Index#metadata_schema_uri metadata_schema}.
51
52
  # @!attribute [r] deployed_indexes
52
53
  # @return [::Array<::Google::Cloud::AIPlatform::V1::DeployedIndexRef>]
53
54
  # Output only. The pointers to DeployedIndexes created from this Index.
@@ -75,17 +76,17 @@ module Google
75
76
  # This also includes any update to the contents of the Index.
76
77
  # Note that Operations working on this Index may have their
77
78
  # [Operations.metadata.generic_metadata.update_time]
78
- # [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this
79
- # timestamp, yet that does not mean their results are not already reflected
80
- # in the Index. Result of any successfully completed Operation on the Index
81
- # is reflected in it.
79
+ # [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little
80
+ # after the value of this timestamp, yet that does not mean their results are
81
+ # not already reflected in the Index. Result of any successfully completed
82
+ # Operation on the Index is reflected in it.
82
83
  # @!attribute [r] index_stats
83
84
  # @return [::Google::Cloud::AIPlatform::V1::IndexStats]
84
85
  # Output only. Stats of the index resource.
85
86
  # @!attribute [rw] index_update_method
86
87
  # @return [::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod]
87
- # Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be
88
- # used by default.
88
+ # Immutable. The update method to use with this Index. If not set,
89
+ # BATCH_UPDATE will be used by default.
89
90
  class Index
90
91
  include ::Google::Protobuf::MessageExts
91
92
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -125,14 +126,14 @@ module Google
125
126
  # [NearestNeighborSearchConfig.dimensions].
126
127
  # @!attribute [rw] restricts
127
128
  # @return [::Array<::Google::Cloud::AIPlatform::V1::IndexDatapoint::Restriction>]
128
- # Optional. List of Restrict of the datapoint, used to perform "restricted searches"
129
- # where boolean rule are used to filter the subset of the database eligible
130
- # for matching.
131
- # See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
129
+ # Optional. List of Restrict of the datapoint, used to perform "restricted
130
+ # searches" where boolean rule are used to filter the subset of the database
131
+ # eligible for matching. See:
132
+ # https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
132
133
  # @!attribute [rw] crowding_tag
133
134
  # @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint::CrowdingTag]
134
- # Optional. CrowdingTag of the datapoint, the number of neighbors to return in each
135
- # crowding can be configured during query.
135
+ # Optional. CrowdingTag of the datapoint, the number of neighbors to return
136
+ # in each crowding can be configured during query.
136
137
  class IndexDatapoint
137
138
  include ::Google::Protobuf::MessageExts
138
139
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -78,9 +78,11 @@ module Google
78
78
  # network name.
79
79
  # @!attribute [rw] enable_private_service_connect
80
80
  # @return [::Boolean]
81
- # Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.
81
+ # Optional. Deprecated: If true, expose the IndexEndpoint via private service
82
+ # connect.
82
83
  #
83
- # Only one of the fields, {::Google::Cloud::AIPlatform::V1::IndexEndpoint#network network} or
84
+ # Only one of the fields,
85
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpoint#network network} or
84
86
  # {::Google::Cloud::AIPlatform::V1::IndexEndpoint#enable_private_service_connect enable_private_service_connect},
85
87
  # can be set.
86
88
  class IndexEndpoint
@@ -117,16 +119,18 @@ module Google
117
119
  # Output only. Timestamp when the DeployedIndex was created.
118
120
  # @!attribute [r] private_endpoints
119
121
  # @return [::Google::Cloud::AIPlatform::V1::IndexPrivateEndpoints]
120
- # Output only. Provides paths for users to send requests directly to the deployed index
121
- # services running on Cloud via private services access. This field is
122
- # populated if {::Google::Cloud::AIPlatform::V1::IndexEndpoint#network network} is configured.
122
+ # Output only. Provides paths for users to send requests directly to the
123
+ # deployed index services running on Cloud via private services access. This
124
+ # field is populated if
125
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpoint#network network} is configured.
123
126
  # @!attribute [r] index_sync_time
124
127
  # @return [::Google::Protobuf::Timestamp]
125
- # Output only. The DeployedIndex may depend on various data on its original Index.
126
- # Additionally when certain changes to the original Index are being done
127
- # (e.g. when what the Index contains is being changed) the DeployedIndex may
128
- # be asynchronously updated in the background to reflect this changes.
129
- # If this timestamp's value is at least the {::Google::Cloud::AIPlatform::V1::Index#update_time Index.update_time} of the
128
+ # Output only. The DeployedIndex may depend on various data on its original
129
+ # Index. Additionally when certain changes to the original Index are being
130
+ # done (e.g. when what the Index contains is being changed) the DeployedIndex
131
+ # may be asynchronously updated in the background to reflect this changes. If
132
+ # this timestamp's value is at least the
133
+ # {::Google::Cloud::AIPlatform::V1::Index#update_time Index.update_time} of the
130
134
  # original Index, it means that this DeployedIndex and the original Index are
131
135
  # in sync. If this timestamp is older, then to see which updates this
132
136
  # DeployedIndex already contains (and which not), one must
@@ -138,8 +142,8 @@ module Google
138
142
  # equal or before this sync time are contained in this DeployedIndex.
139
143
  # @!attribute [rw] automatic_resources
140
144
  # @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
141
- # Optional. A description of resources that the DeployedIndex uses, which to large
142
- # degree are decided by Vertex AI, and optionally allows only a modest
145
+ # Optional. A description of resources that the DeployedIndex uses, which to
146
+ # large degree are decided by Vertex AI, and optionally allows only a modest
143
147
  # additional configuration.
144
148
  # If min_replica_count is not set, the default value is 2 (we don't provide
145
149
  # SLA when min_replica_count=1). If max_replica_count is not set, the
@@ -147,19 +151,27 @@ module Google
147
151
  # 1000.
148
152
  # @!attribute [rw] dedicated_resources
149
153
  # @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
150
- # Optional. A description of resources that are dedicated to the DeployedIndex, and
151
- # that need a higher degree of manual configuration.
152
- # If min_replica_count is not set, the default value is 2 (we don't provide
153
- # SLA when min_replica_count=1). If max_replica_count is not set, the
154
- # default value is min_replica_count. The max allowed replica count is
155
- # 1000.
154
+ # Optional. A description of resources that are dedicated to the
155
+ # DeployedIndex, and that need a higher degree of manual configuration. If
156
+ # min_replica_count is not set, the default value is 2 (we don't provide SLA
157
+ # when min_replica_count=1). If max_replica_count is not set, the default
158
+ # value is min_replica_count. The max allowed replica count is 1000.
159
+ #
160
+ # Available machine types for SMALL shard:
161
+ # e2-standard-2 and all machine types available for MEDIUM and LARGE shard.
162
+ #
163
+ # Available machine types for MEDIUM shard:
164
+ # e2-standard-16 and all machine types available for LARGE shard.
165
+ #
166
+ # Available machine types for LARGE shard:
167
+ # e2-standard-32, e2-highmem-16, n2d-standard-32.
156
168
  #
157
- # Available machine types:
158
- # n1-standard-16
159
- # n1-standard-32
169
+ # n1-standard-16 and n1-standard-32 are still available, but we recommend
170
+ # e2-standard-16 and e2-standard-32 for cost efficiency.
160
171
  # @!attribute [rw] enable_access_logging
161
172
  # @return [::Boolean]
162
- # Optional. If true, private endpoint's access logs are sent to StackDriver Logging.
173
+ # Optional. If true, private endpoint's access logs are sent to StackDriver
174
+ # Logging.
163
175
  #
164
176
  # These logs are like standard server access logs, containing
165
177
  # information like timestamp and latency for each MatchRequest.
@@ -240,8 +252,8 @@ module Google
240
252
  # Output only. The ip address used to send match gRPC requests.
241
253
  # @!attribute [r] service_attachment
242
254
  # @return [::String]
243
- # Output only. The name of the service attachment resource. Populated if private service
244
- # connect is enabled.
255
+ # Output only. The name of the service attachment resource. Populated if
256
+ # private service connect is enabled.
245
257
  class IndexPrivateEndpoints
246
258
  include ::Google::Protobuf::MessageExts
247
259
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -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::IndexEndpointService::Client#create_index_endpoint IndexEndpointService.CreateIndexEndpoint}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#create_index_endpoint IndexEndpointService.CreateIndexEndpoint}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location to create the IndexEndpoint in.
@@ -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::IndexEndpointService::Client#get_index_endpoint IndexEndpointService.GetIndexEndpoint}
48
+ # Request message for
49
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#get_index_endpoint IndexEndpointService.GetIndexEndpoint}
48
50
  # @!attribute [rw] name
49
51
  # @return [::String]
50
52
  # Required. The name of the IndexEndpoint resource.
@@ -55,15 +57,16 @@ module Google
55
57
  extend ::Google::Protobuf::MessageExts::ClassMethods
56
58
  end
57
59
 
58
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints}.
60
+ # Request message for
61
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints}.
59
62
  # @!attribute [rw] parent
60
63
  # @return [::String]
61
- # Required. The resource name of the Location from which to list the IndexEndpoints.
62
- # Format: `projects/{project}/locations/{location}`
64
+ # Required. The resource name of the Location from which to list the
65
+ # IndexEndpoints. Format: `projects/{project}/locations/{location}`
63
66
  # @!attribute [rw] filter
64
67
  # @return [::String]
65
- # Optional. An expression for filtering the results of the request. For field names
66
- # both snake_case and camelCase are supported.
68
+ # Optional. An expression for filtering the results of the request. For field
69
+ # names both snake_case and camelCase are supported.
67
70
  #
68
71
  # * `index_endpoint` supports = and !=. `index_endpoint` represents the
69
72
  # IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
@@ -87,8 +90,10 @@ module Google
87
90
  # @return [::String]
88
91
  # Optional. The standard list page token.
89
92
  # Typically obtained via
90
- # {::Google::Cloud::AIPlatform::V1::ListIndexEndpointsResponse#next_page_token ListIndexEndpointsResponse.next_page_token} of the previous
91
- # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints} call.
93
+ # {::Google::Cloud::AIPlatform::V1::ListIndexEndpointsResponse#next_page_token ListIndexEndpointsResponse.next_page_token}
94
+ # of the previous
95
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints}
96
+ # call.
92
97
  # @!attribute [rw] read_mask
93
98
  # @return [::Google::Protobuf::FieldMask]
94
99
  # Optional. Mask specifying which fields to read.
@@ -97,32 +102,38 @@ module Google
97
102
  extend ::Google::Protobuf::MessageExts::ClassMethods
98
103
  end
99
104
 
100
- # Response message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints}.
105
+ # Response message for
106
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#list_index_endpoints IndexEndpointService.ListIndexEndpoints}.
101
107
  # @!attribute [rw] index_endpoints
102
108
  # @return [::Array<::Google::Cloud::AIPlatform::V1::IndexEndpoint>]
103
109
  # List of IndexEndpoints in the requested page.
104
110
  # @!attribute [rw] next_page_token
105
111
  # @return [::String]
106
112
  # A token to retrieve next page of results.
107
- # Pass to {::Google::Cloud::AIPlatform::V1::ListIndexEndpointsRequest#page_token ListIndexEndpointsRequest.page_token} to obtain that page.
113
+ # Pass to
114
+ # {::Google::Cloud::AIPlatform::V1::ListIndexEndpointsRequest#page_token ListIndexEndpointsRequest.page_token}
115
+ # to obtain that page.
108
116
  class ListIndexEndpointsResponse
109
117
  include ::Google::Protobuf::MessageExts
110
118
  extend ::Google::Protobuf::MessageExts::ClassMethods
111
119
  end
112
120
 
113
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#update_index_endpoint IndexEndpointService.UpdateIndexEndpoint}.
121
+ # Request message for
122
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#update_index_endpoint IndexEndpointService.UpdateIndexEndpoint}.
114
123
  # @!attribute [rw] index_endpoint
115
124
  # @return [::Google::Cloud::AIPlatform::V1::IndexEndpoint]
116
125
  # Required. The IndexEndpoint which replaces the resource on the server.
117
126
  # @!attribute [rw] update_mask
118
127
  # @return [::Google::Protobuf::FieldMask]
119
- # Required. The update mask applies to the resource. See {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
128
+ # Required. The update mask applies to the resource. See
129
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
120
130
  class UpdateIndexEndpointRequest
121
131
  include ::Google::Protobuf::MessageExts
122
132
  extend ::Google::Protobuf::MessageExts::ClassMethods
123
133
  end
124
134
 
125
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#delete_index_endpoint IndexEndpointService.DeleteIndexEndpoint}.
135
+ # Request message for
136
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#delete_index_endpoint IndexEndpointService.DeleteIndexEndpoint}.
126
137
  # @!attribute [rw] name
127
138
  # @return [::String]
128
139
  # Required. The name of the IndexEndpoint resource to be deleted.
@@ -133,11 +144,12 @@ module Google
133
144
  extend ::Google::Protobuf::MessageExts::ClassMethods
134
145
  end
135
146
 
136
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#deploy_index IndexEndpointService.DeployIndex}.
147
+ # Request message for
148
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#deploy_index IndexEndpointService.DeployIndex}.
137
149
  # @!attribute [rw] index_endpoint
138
150
  # @return [::String]
139
- # Required. The name of the IndexEndpoint resource into which to deploy an Index.
140
- # Format:
151
+ # Required. The name of the IndexEndpoint resource into which to deploy an
152
+ # Index. Format:
141
153
  # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
142
154
  # @!attribute [rw] deployed_index
143
155
  # @return [::Google::Cloud::AIPlatform::V1::DeployedIndex]
@@ -147,7 +159,8 @@ module Google
147
159
  extend ::Google::Protobuf::MessageExts::ClassMethods
148
160
  end
149
161
 
150
- # Response message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#deploy_index IndexEndpointService.DeployIndex}.
162
+ # Response message for
163
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#deploy_index IndexEndpointService.DeployIndex}.
151
164
  # @!attribute [rw] deployed_index
152
165
  # @return [::Google::Cloud::AIPlatform::V1::DeployedIndex]
153
166
  # The DeployedIndex that had been deployed in the IndexEndpoint.
@@ -156,7 +169,8 @@ module Google
156
169
  extend ::Google::Protobuf::MessageExts::ClassMethods
157
170
  end
158
171
 
159
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#deploy_index IndexEndpointService.DeployIndex}.
172
+ # Runtime operation information for
173
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#deploy_index IndexEndpointService.DeployIndex}.
160
174
  # @!attribute [rw] generic_metadata
161
175
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
162
176
  # The operation generic information.
@@ -168,27 +182,31 @@ module Google
168
182
  extend ::Google::Protobuf::MessageExts::ClassMethods
169
183
  end
170
184
 
171
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#undeploy_index IndexEndpointService.UndeployIndex}.
185
+ # Request message for
186
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#undeploy_index IndexEndpointService.UndeployIndex}.
172
187
  # @!attribute [rw] index_endpoint
173
188
  # @return [::String]
174
- # Required. The name of the IndexEndpoint resource from which to undeploy an Index.
175
- # Format:
189
+ # Required. The name of the IndexEndpoint resource from which to undeploy an
190
+ # Index. Format:
176
191
  # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
177
192
  # @!attribute [rw] deployed_index_id
178
193
  # @return [::String]
179
- # Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
194
+ # Required. The ID of the DeployedIndex to be undeployed from the
195
+ # IndexEndpoint.
180
196
  class UndeployIndexRequest
181
197
  include ::Google::Protobuf::MessageExts
182
198
  extend ::Google::Protobuf::MessageExts::ClassMethods
183
199
  end
184
200
 
185
- # Response message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#undeploy_index IndexEndpointService.UndeployIndex}.
201
+ # Response message for
202
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#undeploy_index IndexEndpointService.UndeployIndex}.
186
203
  class UndeployIndexResponse
187
204
  include ::Google::Protobuf::MessageExts
188
205
  extend ::Google::Protobuf::MessageExts::ClassMethods
189
206
  end
190
207
 
191
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#undeploy_index IndexEndpointService.UndeployIndex}.
208
+ # Runtime operation information for
209
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#undeploy_index IndexEndpointService.UndeployIndex}.
192
210
  # @!attribute [rw] generic_metadata
193
211
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
194
212
  # The operation generic information.
@@ -197,11 +215,12 @@ module Google
197
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
198
216
  end
199
217
 
200
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#mutate_deployed_index IndexEndpointService.MutateDeployedIndex}.
218
+ # Request message for
219
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#mutate_deployed_index IndexEndpointService.MutateDeployedIndex}.
201
220
  # @!attribute [rw] index_endpoint
202
221
  # @return [::String]
203
- # Required. The name of the IndexEndpoint resource into which to deploy an Index.
204
- # Format:
222
+ # Required. The name of the IndexEndpoint resource into which to deploy an
223
+ # Index. Format:
205
224
  # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
206
225
  # @!attribute [rw] deployed_index
207
226
  # @return [::Google::Cloud::AIPlatform::V1::DeployedIndex]
@@ -213,7 +232,8 @@ module Google
213
232
  extend ::Google::Protobuf::MessageExts::ClassMethods
214
233
  end
215
234
 
216
- # Response message for {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#mutate_deployed_index IndexEndpointService.MutateDeployedIndex}.
235
+ # Response message for
236
+ # {::Google::Cloud::AIPlatform::V1::IndexEndpointService::Client#mutate_deployed_index IndexEndpointService.MutateDeployedIndex}.
217
237
  # @!attribute [rw] deployed_index
218
238
  # @return [::Google::Cloud::AIPlatform::V1::DeployedIndex]
219
239
  # The DeployedIndex that had been updated in the IndexEndpoint.
@@ -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::IndexService::Client#create_index IndexService.CreateIndex}.
24
+ # Request message for
25
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#create_index IndexService.CreateIndex}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The resource name of the Location to create the Index in.
@@ -34,7 +35,8 @@ module Google
34
35
  extend ::Google::Protobuf::MessageExts::ClassMethods
35
36
  end
36
37
 
37
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::IndexService::Client#create_index IndexService.CreateIndex}.
38
+ # Runtime operation information for
39
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#create_index IndexService.CreateIndex}.
38
40
  # @!attribute [rw] generic_metadata
39
41
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
40
42
  # The operation generic information.
@@ -46,7 +48,8 @@ module Google
46
48
  extend ::Google::Protobuf::MessageExts::ClassMethods
47
49
  end
48
50
 
49
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#get_index IndexService.GetIndex}
51
+ # Request message for
52
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#get_index IndexService.GetIndex}
50
53
  # @!attribute [rw] name
51
54
  # @return [::String]
52
55
  # Required. The name of the Index resource.
@@ -57,7 +60,8 @@ module Google
57
60
  extend ::Google::Protobuf::MessageExts::ClassMethods
58
61
  end
59
62
 
60
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#list_indexes IndexService.ListIndexes}.
63
+ # Request message for
64
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#list_indexes IndexService.ListIndexes}.
61
65
  # @!attribute [rw] parent
62
66
  # @return [::String]
63
67
  # Required. The resource name of the Location from which to list the Indexes.
@@ -72,8 +76,10 @@ module Google
72
76
  # @return [::String]
73
77
  # The standard list page token.
74
78
  # Typically obtained via
75
- # {::Google::Cloud::AIPlatform::V1::ListIndexesResponse#next_page_token ListIndexesResponse.next_page_token} of the previous
76
- # {::Google::Cloud::AIPlatform::V1::IndexService::Client#list_indexes IndexService.ListIndexes} call.
79
+ # {::Google::Cloud::AIPlatform::V1::ListIndexesResponse#next_page_token ListIndexesResponse.next_page_token}
80
+ # of the previous
81
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#list_indexes IndexService.ListIndexes}
82
+ # call.
77
83
  # @!attribute [rw] read_mask
78
84
  # @return [::Google::Protobuf::FieldMask]
79
85
  # Mask specifying which fields to read.
@@ -82,33 +88,39 @@ module Google
82
88
  extend ::Google::Protobuf::MessageExts::ClassMethods
83
89
  end
84
90
 
85
- # Response message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#list_indexes IndexService.ListIndexes}.
91
+ # Response message for
92
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#list_indexes IndexService.ListIndexes}.
86
93
  # @!attribute [rw] indexes
87
94
  # @return [::Array<::Google::Cloud::AIPlatform::V1::Index>]
88
95
  # List of indexes in the requested page.
89
96
  # @!attribute [rw] next_page_token
90
97
  # @return [::String]
91
98
  # A token to retrieve next page of results.
92
- # Pass to {::Google::Cloud::AIPlatform::V1::ListIndexesRequest#page_token ListIndexesRequest.page_token} to obtain that page.
99
+ # Pass to
100
+ # {::Google::Cloud::AIPlatform::V1::ListIndexesRequest#page_token ListIndexesRequest.page_token}
101
+ # to obtain that page.
93
102
  class ListIndexesResponse
94
103
  include ::Google::Protobuf::MessageExts
95
104
  extend ::Google::Protobuf::MessageExts::ClassMethods
96
105
  end
97
106
 
98
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#update_index IndexService.UpdateIndex}.
107
+ # Request message for
108
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#update_index IndexService.UpdateIndex}.
99
109
  # @!attribute [rw] index
100
110
  # @return [::Google::Cloud::AIPlatform::V1::Index]
101
111
  # Required. The Index which updates the resource on the server.
102
112
  # @!attribute [rw] update_mask
103
113
  # @return [::Google::Protobuf::FieldMask]
104
114
  # The update mask applies to the resource.
105
- # For the `FieldMask` definition, see {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
115
+ # For the `FieldMask` definition, see
116
+ # {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
106
117
  class UpdateIndexRequest
107
118
  include ::Google::Protobuf::MessageExts
108
119
  extend ::Google::Protobuf::MessageExts::ClassMethods
109
120
  end
110
121
 
111
- # Runtime operation information for {::Google::Cloud::AIPlatform::V1::IndexService::Client#update_index IndexService.UpdateIndex}.
122
+ # Runtime operation information for
123
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#update_index IndexService.UpdateIndex}.
112
124
  # @!attribute [rw] generic_metadata
113
125
  # @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
114
126
  # The operation generic information.
@@ -120,7 +132,8 @@ module Google
120
132
  extend ::Google::Protobuf::MessageExts::ClassMethods
121
133
  end
122
134
 
123
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#delete_index IndexService.DeleteIndex}.
135
+ # Request message for
136
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#delete_index IndexService.DeleteIndex}.
124
137
  # @!attribute [rw] name
125
138
  # @return [::String]
126
139
  # Required. The name of the Index resource to be deleted.
@@ -131,7 +144,8 @@ module Google
131
144
  extend ::Google::Protobuf::MessageExts::ClassMethods
132
145
  end
133
146
 
134
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#upsert_datapoints IndexService.UpsertDatapoints}
147
+ # Request message for
148
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#upsert_datapoints IndexService.UpsertDatapoints}
135
149
  # @!attribute [rw] index
136
150
  # @return [::String]
137
151
  # Required. The name of the Index resource to be updated.
@@ -145,13 +159,15 @@ module Google
145
159
  extend ::Google::Protobuf::MessageExts::ClassMethods
146
160
  end
147
161
 
148
- # Response message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#upsert_datapoints IndexService.UpsertDatapoints}
162
+ # Response message for
163
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#upsert_datapoints IndexService.UpsertDatapoints}
149
164
  class UpsertDatapointsResponse
150
165
  include ::Google::Protobuf::MessageExts
151
166
  extend ::Google::Protobuf::MessageExts::ClassMethods
152
167
  end
153
168
 
154
- # Request message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#remove_datapoints IndexService.RemoveDatapoints}
169
+ # Request message for
170
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#remove_datapoints IndexService.RemoveDatapoints}
155
171
  # @!attribute [rw] index
156
172
  # @return [::String]
157
173
  # Required. The name of the Index resource to be updated.
@@ -165,7 +181,8 @@ module Google
165
181
  extend ::Google::Protobuf::MessageExts::ClassMethods
166
182
  end
167
183
 
168
- # Response message for {::Google::Cloud::AIPlatform::V1::IndexService::Client#remove_datapoints IndexService.RemoveDatapoints}
184
+ # Response message for
185
+ # {::Google::Cloud::AIPlatform::V1::IndexService::Client#remove_datapoints IndexService.RemoveDatapoints}
169
186
  class RemoveDatapointsResponse
170
187
  include ::Google::Protobuf::MessageExts
171
188
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -176,7 +193,8 @@ module Google
176
193
  # @return [::Array<::Google::Cloud::AIPlatform::V1::NearestNeighborSearchOperationMetadata::ContentValidationStats>]
177
194
  # The validation stats of the content (per file) to be inserted or
178
195
  # updated on the Matching Engine Index resource. Populated if
179
- # contentsDeltaUri is provided as part of {::Google::Cloud::AIPlatform::V1::Index#metadata Index.metadata}. Please note
196
+ # contentsDeltaUri is provided as part of
197
+ # {::Google::Cloud::AIPlatform::V1::Index#metadata Index.metadata}. Please note
180
198
  # that, currently for those files that are broken or has unsupported file
181
199
  # format, we will not have the stats for those files.
182
200
  # @!attribute [rw] data_bytes_count
@@ -53,7 +53,8 @@ module Google
53
53
  # The Google Cloud Storage location where the output is to be written to.
54
54
  # @!attribute [rw] output_uri_prefix
55
55
  # @return [::String]
56
- # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with
56
+ # Required. Google Cloud Storage URI to output directory. If the uri doesn't
57
+ # end with
57
58
  # '/', a '/' will be automatically appended. The directory is created if it
58
59
  # doesn't exist.
59
60
  class GcsDestination