1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.aiplatform.v1; 18 19import "google/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21import "google/protobuf/timestamp.proto"; 22 23option csharp_namespace = "Google.Cloud.AIPlatform.V1"; 24option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb"; 25option java_multiple_files = true; 26option java_outer_classname = "MetadataSchemaProto"; 27option java_package = "com.google.cloud.aiplatform.v1"; 28option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; 29option ruby_package = "Google::Cloud::AIPlatform::V1"; 30 31// Instance of a general MetadataSchema. 32message MetadataSchema { 33 option (google.api.resource) = { 34 type: "aiplatform.googleapis.com/MetadataSchema" 35 pattern: "projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}" 36 }; 37 38 // Describes the type of the MetadataSchema. 39 enum MetadataSchemaType { 40 // Unspecified type for the MetadataSchema. 41 METADATA_SCHEMA_TYPE_UNSPECIFIED = 0; 42 43 // A type indicating that the MetadataSchema will be used by Artifacts. 44 ARTIFACT_TYPE = 1; 45 46 // A typee indicating that the MetadataSchema will be used by Executions. 47 EXECUTION_TYPE = 2; 48 49 // A state indicating that the MetadataSchema will be used by Contexts. 50 CONTEXT_TYPE = 3; 51 } 52 53 // Output only. The resource name of the MetadataSchema. 54 string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 55 56 // The version of the MetadataSchema. The version's format must match 57 // the following regular expression: `^[0-9]+[.][0-9]+[.][0-9]+$`, which would 58 // allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc. 59 string schema_version = 2; 60 61 // Required. The raw YAML string representation of the MetadataSchema. The 62 // combination of [MetadataSchema.version] and the schema name given by 63 // `title` in [MetadataSchema.schema] must be unique within a MetadataStore. 64 // 65 // The schema is defined as an OpenAPI 3.0.2 66 // [MetadataSchema 67 // Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) 68 string schema = 3 [(google.api.field_behavior) = REQUIRED]; 69 70 // The type of the MetadataSchema. This is a property that identifies which 71 // metadata types will use the MetadataSchema. 72 MetadataSchemaType schema_type = 4; 73 74 // Output only. Timestamp when this MetadataSchema was created. 75 google.protobuf.Timestamp create_time = 5 76 [(google.api.field_behavior) = OUTPUT_ONLY]; 77 78 // Description of the Metadata Schema 79 string description = 6; 80} 81