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/struct.proto"; 22import "google/protobuf/timestamp.proto"; 23 24option csharp_namespace = "Google.Cloud.AIPlatform.V1"; 25option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb"; 26option java_multiple_files = true; 27option java_outer_classname = "ExecutionProto"; 28option java_package = "com.google.cloud.aiplatform.v1"; 29option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; 30option ruby_package = "Google::Cloud::AIPlatform::V1"; 31 32// Instance of a general execution. 33message Execution { 34 option (google.api.resource) = { 35 type: "aiplatform.googleapis.com/Execution" 36 pattern: "projects/{project}/locations/{location}/metadataStores/{metadata_store}/executions/{execution}" 37 }; 38 39 // Describes the state of the Execution. 40 enum State { 41 // Unspecified Execution state 42 STATE_UNSPECIFIED = 0; 43 44 // The Execution is new 45 NEW = 1; 46 47 // The Execution is running 48 RUNNING = 2; 49 50 // The Execution has finished running 51 COMPLETE = 3; 52 53 // The Execution has failed 54 FAILED = 4; 55 56 // The Execution completed through Cache hit. 57 CACHED = 5; 58 59 // The Execution was cancelled. 60 CANCELLED = 6; 61 } 62 63 // Output only. The resource name of the Execution. 64 string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 65 66 // User provided display name of the Execution. 67 // May be up to 128 Unicode characters. 68 string display_name = 2; 69 70 // The state of this Execution. This is a property of the Execution, and does 71 // not imply or capture any ongoing process. This property is managed by 72 // clients (such as Vertex AI Pipelines) and the system does not prescribe 73 // or check the validity of state transitions. 74 State state = 6; 75 76 // An eTag used to perform consistent read-modify-write updates. If not set, a 77 // blind "overwrite" update happens. 78 string etag = 9; 79 80 // The labels with user-defined metadata to organize your Executions. 81 // 82 // Label keys and values can be no longer than 64 characters 83 // (Unicode codepoints), can only contain lowercase letters, numeric 84 // characters, underscores and dashes. International characters are allowed. 85 // No more than 64 user labels can be associated with one Execution (System 86 // labels are excluded). 87 map<string, string> labels = 10; 88 89 // Output only. Timestamp when this Execution was created. 90 google.protobuf.Timestamp create_time = 11 91 [(google.api.field_behavior) = OUTPUT_ONLY]; 92 93 // Output only. Timestamp when this Execution was last updated. 94 google.protobuf.Timestamp update_time = 12 95 [(google.api.field_behavior) = OUTPUT_ONLY]; 96 97 // The title of the schema describing the metadata. 98 // 99 // Schema title and version is expected to be registered in earlier Create 100 // Schema calls. And both are used together as unique identifiers to identify 101 // schemas within the local metadata store. 102 string schema_title = 13; 103 104 // The version of the schema in `schema_title` to use. 105 // 106 // Schema title and version is expected to be registered in earlier Create 107 // Schema calls. And both are used together as unique identifiers to identify 108 // schemas within the local metadata store. 109 string schema_version = 14; 110 111 // Properties of the Execution. 112 // Top level metadata keys' heading and trailing spaces will be trimmed. 113 // The size of this field should not exceed 200KB. 114 google.protobuf.Struct metadata = 15; 115 116 // Description of the Execution 117 string description = 16; 118} 119