You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
97 lines
4.4 KiB
97 lines
4.4 KiB
// Copyright 2021 Google LLC |
|
// |
|
// Licensed under the Apache License, Version 2.0 (the "License"); |
|
// you may not use this file except in compliance with the License. |
|
// You may obtain a copy of the License at |
|
// |
|
// http://www.apache.org/licenses/LICENSE-2.0 |
|
// |
|
// Unless required by applicable law or agreed to in writing, software |
|
// distributed under the License is distributed on an "AS IS" BASIS, |
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
// See the License for the specific language governing permissions and |
|
// limitations under the License. |
|
|
|
syntax = "proto3"; |
|
|
|
package google.cloud.aiplatform.v1beta1; |
|
|
|
import "google/api/field_behavior.proto"; |
|
import "google/api/resource.proto"; |
|
import "google/cloud/aiplatform/v1beta1/deployed_index_ref.proto"; |
|
import "google/protobuf/struct.proto"; |
|
import "google/protobuf/timestamp.proto"; |
|
import "google/api/annotations.proto"; |
|
|
|
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1"; |
|
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform"; |
|
option java_multiple_files = true; |
|
option java_outer_classname = "IndexProto"; |
|
option java_package = "com.google.cloud.aiplatform.v1beta1"; |
|
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1"; |
|
option ruby_package = "Google::Cloud::AIPlatform::V1beta1"; |
|
|
|
// A representation of a collection of database items organized in a way that |
|
// allows for approximate nearest neighbor (a.k.a ANN) algorithms search. |
|
message Index { |
|
option (google.api.resource) = { |
|
type: "aiplatform.googleapis.com/Index" |
|
pattern: "projects/{project}/locations/{location}/indexes/{index}" |
|
}; |
|
|
|
// Output only. The resource name of the Index. |
|
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
// Required. The display name of the Index. |
|
// The name can be up to 128 characters long and can be consist of any UTF-8 |
|
// characters. |
|
string display_name = 2 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
// The description of the Index. |
|
string description = 3; |
|
|
|
// Immutable. Points to a YAML file stored on Google Cloud Storage describing additional |
|
// information about the Index, that is specific to it. Unset if the Index |
|
// does not have any additional information. |
|
// The schema is defined as an OpenAPI 3.0.2 [Schema |
|
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). |
|
// Note: The URI given on output will be immutable and probably different, |
|
// including the URI scheme, than the one given on input. The output URI will |
|
// point to a location where the user only has a read access. |
|
string metadata_schema_uri = 4 [(google.api.field_behavior) = IMMUTABLE]; |
|
|
|
// An additional information about the Index; the schema of the metadata can |
|
// be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri]. |
|
google.protobuf.Value metadata = 6; |
|
|
|
// Output only. The pointers to DeployedIndexes created from this Index. |
|
// An Index can be only deleted if all its DeployedIndexes had been undeployed |
|
// first. |
|
repeated DeployedIndexRef deployed_indexes = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
// Used to perform consistent read-modify-write updates. If not set, a blind |
|
// "overwrite" update happens. |
|
string etag = 8; |
|
|
|
// The labels with user-defined metadata to organize your Indexes. |
|
// |
|
// Label keys and values can be no longer than 64 characters |
|
// (Unicode codepoints), can only contain lowercase letters, numeric |
|
// characters, underscores and dashes. International characters are allowed. |
|
// |
|
// See https://goo.gl/xmQnxf for more information and examples of labels. |
|
map<string, string> labels = 9; |
|
|
|
// Output only. Timestamp when this Index was created. |
|
google.protobuf.Timestamp create_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
// Output only. Timestamp when this Index was most recently updated. |
|
// This also includes any update to the contents of the Index. |
|
// Note that Operations working on this Index may have their |
|
// [Operations.metadata.generic_metadata.update_time] |
|
// [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time] a little after the value of this |
|
// timestamp, yet that does not mean their results are not already reflected |
|
// in the Index. Result of any successfully completed Operation on the Index |
|
// is reflected in it. |
|
google.protobuf.Timestamp update_time = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
}
|
|
|