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.v1beta1;
18
19import "google/api/field_behavior.proto";
20import "google/api/resource.proto";
21import "google/protobuf/struct.proto";
22import "google/protobuf/timestamp.proto";
23
24option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
25option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
26option java_multiple_files = true;
27option java_outer_classname = "ContextProto";
28option java_package = "com.google.cloud.aiplatform.v1beta1";
29option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
30option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
31
32// Instance of a general context.
33message Context {
34  option (google.api.resource) = {
35    type: "aiplatform.googleapis.com/Context"
36    pattern: "projects/{project}/locations/{location}/metadataStores/{metadata_store}/contexts/{context}"
37  };
38
39  // Output only. The resource name of the Context.
40  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
41
42  // User provided display name of the Context.
43  // May be up to 128 Unicode characters.
44  string display_name = 2;
45
46  // An eTag used to perform consistent read-modify-write updates. If not set, a
47  // blind "overwrite" update happens.
48  string etag = 8;
49
50  // The labels with user-defined metadata to organize your Contexts.
51  //
52  // Label keys and values can be no longer than 64 characters
53  // (Unicode codepoints), can only contain lowercase letters, numeric
54  // characters, underscores and dashes. International characters are allowed.
55  // No more than 64 user labels can be associated with one Context (System
56  // labels are excluded).
57  map<string, string> labels = 9;
58
59  // Output only. Timestamp when this Context was created.
60  google.protobuf.Timestamp create_time = 10
61      [(google.api.field_behavior) = OUTPUT_ONLY];
62
63  // Output only. Timestamp when this Context was last updated.
64  google.protobuf.Timestamp update_time = 11
65      [(google.api.field_behavior) = OUTPUT_ONLY];
66
67  // Output only. A list of resource names of Contexts that are parents of this
68  // Context. A Context may have at most 10 parent_contexts.
69  repeated string parent_contexts = 12 [
70    (google.api.field_behavior) = OUTPUT_ONLY,
71    (google.api.resource_reference) = {
72      type: "aiplatform.googleapis.com/Context"
73    }
74  ];
75
76  // The title of the schema describing the metadata.
77  //
78  // Schema title and version is expected to be registered in earlier Create
79  // Schema calls. And both are used together as unique identifiers to identify
80  // schemas within the local metadata store.
81  string schema_title = 13;
82
83  // The version of the schema in schema_name to use.
84  //
85  // Schema title and version is expected to be registered in earlier Create
86  // Schema calls. And both are used together as unique identifiers to identify
87  // schemas within the local metadata store.
88  string schema_version = 14;
89
90  // Properties of the Context.
91  // Top level metadata keys' heading and trailing spaces will be trimmed.
92  // The size of this field should not exceed 200KB.
93  google.protobuf.Struct metadata = 15;
94
95  // Description of the Context
96  string description = 16;
97}
98