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 = "ArtifactProto";
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 artifact.
33message Artifact {
34  option (google.api.resource) = {
35    type: "aiplatform.googleapis.com/Artifact"
36    pattern: "projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}"
37  };
38
39  // Describes the state of the Artifact.
40  enum State {
41    // Unspecified state for the Artifact.
42    STATE_UNSPECIFIED = 0;
43
44    // A state used by systems like Vertex AI Pipelines to indicate that the
45    // underlying data item represented by this Artifact is being created.
46    PENDING = 1;
47
48    // A state indicating that the Artifact should exist, unless something
49    // external to the system deletes it.
50    LIVE = 2;
51  }
52
53  // Output only. The resource name of the Artifact.
54  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
55
56  // User provided display name of the Artifact.
57  // May be up to 128 Unicode characters.
58  string display_name = 2;
59
60  // The uniform resource identifier of the artifact file.
61  // May be empty if there is no actual artifact file.
62  string uri = 6;
63
64  // An eTag used to perform consistent read-modify-write updates. If not set, a
65  // blind "overwrite" update happens.
66  string etag = 9;
67
68  // The labels with user-defined metadata to organize your Artifacts.
69  //
70  // Label keys and values can be no longer than 64 characters
71  // (Unicode codepoints), can only contain lowercase letters, numeric
72  // characters, underscores and dashes. International characters are allowed.
73  // No more than 64 user labels can be associated with one Artifact (System
74  // labels are excluded).
75  map<string, string> labels = 10;
76
77  // Output only. Timestamp when this Artifact was created.
78  google.protobuf.Timestamp create_time = 11
79      [(google.api.field_behavior) = OUTPUT_ONLY];
80
81  // Output only. Timestamp when this Artifact was last updated.
82  google.protobuf.Timestamp update_time = 12
83      [(google.api.field_behavior) = OUTPUT_ONLY];
84
85  // The state of this Artifact. This is a property of the Artifact, and does
86  // not imply or capture any ongoing process. This property is managed by
87  // clients (such as Vertex AI Pipelines), and the system does not prescribe
88  // or check the validity of state transitions.
89  State state = 13;
90
91  // The title of the schema describing the metadata.
92  //
93  // Schema title and version is expected to be registered in earlier Create
94  // Schema calls. And both are used together as unique identifiers to identify
95  // schemas within the local metadata store.
96  string schema_title = 14;
97
98  // The version of the schema in schema_name to use.
99  //
100  // Schema title and version is expected to be registered in earlier Create
101  // Schema calls. And both are used together as unique identifiers to identify
102  // schemas within the local metadata store.
103  string schema_version = 15;
104
105  // Properties of the Artifact.
106  // Top level metadata keys' heading and trailing spaces will be trimmed.
107  // The size of this field should not exceed 200KB.
108  google.protobuf.Struct metadata = 16;
109
110  // Description of the Artifact
111  string description = 17;
112}
113