googleapis/google/cloud/run/v2/execution_template.proto
2025-05-13 14:44:04 -07:00

73 lines
3.3 KiB
Protocol Buffer

// Copyright 2025 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.run.v2;
import "google/api/field_behavior.proto";
import "google/cloud/run/v2/task_template.proto";
option go_package = "cloud.google.com/go/run/apiv2/runpb;runpb";
option java_multiple_files = true;
option java_outer_classname = "ExecutionTemplateProto";
option java_package = "com.google.cloud.run.v2";
// ExecutionTemplate describes the data an execution should have when created
// from a template.
message ExecutionTemplate {
// Unstructured key value map that can be used to organize and categorize
// objects.
// User-provided labels are shared with Google's billing system, so they can
// be used to filter, or break down billing charges by team, component,
// environment, state, etc. For more information, visit
// https://cloud.google.com/resource-manager/docs/creating-managing-labels or
// https://cloud.google.com/run/docs/configuring/labels.
//
// <p>Cloud Run API v2 does not support labels with `run.googleapis.com`,
// `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
// namespaces, and they will be rejected. All system labels in v1 now have a
// corresponding field in v2 ExecutionTemplate.
map<string, string> labels = 1;
// Unstructured key value map that may be set by external tools to store and
// arbitrary metadata. They are not queryable and should be preserved
// when modifying objects.
//
// <p>Cloud Run API v2 does not support annotations with `run.googleapis.com`,
// `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev`
// namespaces, and they will be rejected. All system annotations in v1 now
// have a corresponding field in v2 ExecutionTemplate.
//
// <p>This field follows Kubernetes annotations' namespacing, limits, and
// rules.
map<string, string> annotations = 2;
// Optional. Specifies the maximum desired number of tasks the execution
// should run at given time. When the job is run, if this field is 0 or unset,
// the maximum possible value will be used for that execution. The actual
// number of tasks running in steady state will be less than this number when
// there are fewer tasks waiting to be completed remaining, i.e. when the work
// left to do is less than max parallelism.
int32 parallelism = 3 [(google.api.field_behavior) = OPTIONAL];
// Specifies the desired number of tasks the execution should run.
// Setting to 1 means that parallelism is limited to 1 and the success of
// that task signals the success of the execution. Defaults to 1.
int32 task_count = 4;
// Required. Describes the task(s) that will be created when executing an
// execution.
TaskTemplate template = 5 [(google.api.field_behavior) = REQUIRED];
}