Skip to content

Commit 0e31cfe

Browse files
Google APIscopybara-github
authored andcommitted
feat: add DeploymentStage for CreateEndpointOperationMetadata and DeployModelOperationMetadata
docs: update MutateDeployedModel documentation PiperOrigin-RevId: 789150946
1 parent abf48aa commit 0e31cfe

File tree

3 files changed

+71
-3
lines changed

3 files changed

+71
-3
lines changed

google/cloud/aiplatform/v1/BUILD.bazel

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ proto_library(
4949
"deployed_model_ref.proto",
5050
"deployment_resource_pool.proto",
5151
"deployment_resource_pool_service.proto",
52+
"deployment_stage.proto",
5253
"encryption_spec.proto",
5354
"endpoint.proto",
5455
"endpoint_service.proto",
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Copyright 2025 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+
15+
syntax = "proto3";
16+
17+
package google.cloud.aiplatform.v1;
18+
19+
option csharp_namespace = "Google.Cloud.AIPlatform.V1";
20+
option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
21+
option java_multiple_files = true;
22+
option java_outer_classname = "DeploymentStageProto";
23+
option java_package = "com.google.cloud.aiplatform.v1";
24+
option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
25+
option ruby_package = "Google::Cloud::AIPlatform::V1";
26+
27+
// Stage field indicating the current progress of a deployment.
28+
enum DeploymentStage {
29+
// Default value. This value is unused.
30+
DEPLOYMENT_STAGE_UNSPECIFIED = 0;
31+
32+
// The deployment is initializing and setting up the environment.
33+
STARTING_DEPLOYMENT = 5;
34+
35+
// The deployment is preparing the model assets.
36+
PREPARING_MODEL = 6;
37+
38+
// The deployment is creating the underlying serving cluster.
39+
CREATING_SERVING_CLUSTER = 7;
40+
41+
// The deployment is adding nodes to the serving cluster.
42+
ADDING_NODES_TO_CLUSTER = 8;
43+
44+
// The deployment is getting the container image for the model server.
45+
GETTING_CONTAINER_IMAGE = 9;
46+
47+
// The deployment is starting the model server.
48+
STARTING_MODEL_SERVER = 3;
49+
50+
// The deployment is performing finalization steps.
51+
FINISHING_UP = 4;
52+
53+
// The deployment has terminated.
54+
DEPLOYMENT_TERMINATED = 10;
55+
}

google/cloud/aiplatform/v1/endpoint_service.proto

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import "google/api/annotations.proto";
2020
import "google/api/client.proto";
2121
import "google/api/field_behavior.proto";
2222
import "google/api/resource.proto";
23+
import "google/cloud/aiplatform/v1/deployment_stage.proto";
2324
import "google/cloud/aiplatform/v1/endpoint.proto";
2425
import "google/cloud/aiplatform/v1/operation.proto";
2526
import "google/longrunning/operations.proto";
@@ -138,9 +139,9 @@ service EndpointService {
138139
}
139140

140141
// Updates an existing deployed model. Updatable fields include
141-
// `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`,
142-
// `disable_container_logging` (v1 only), and `enable_container_logging`
143-
// (v1beta1 only).
142+
// `min_replica_count`, `max_replica_count`, `required_replica_count`,
143+
// `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and
144+
// `enable_container_logging` (v1beta1 only).
144145
rpc MutateDeployedModel(MutateDeployedModelRequest)
145146
returns (google.longrunning.Operation) {
146147
option (google.api.http) = {
@@ -193,6 +194,11 @@ message CreateEndpointRequest {
193194
message CreateEndpointOperationMetadata {
194195
// The operation generic information.
195196
GenericOperationMetadata generic_metadata = 1;
197+
198+
// Output only. The deployment stage of the model. Only populated if this
199+
// CreateEndpoint request deploys a model at the same time.
200+
DeploymentStage deployment_stage = 2
201+
[(google.api.field_behavior) = OUTPUT_ONLY];
196202
}
197203

198204
// Request message for
@@ -372,6 +378,10 @@ message DeployModelResponse {
372378
message DeployModelOperationMetadata {
373379
// The operation generic information.
374380
GenericOperationMetadata generic_metadata = 1;
381+
382+
// Output only. The deployment stage of the model.
383+
DeploymentStage deployment_stage = 2
384+
[(google.api.field_behavior) = OUTPUT_ONLY];
375385
}
376386

377387
// Request message for
@@ -433,6 +443,8 @@ message MutateDeployedModelRequest {
433443
// * `max_replica_count` in either
434444
// [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources] or
435445
// [AutomaticResources][google.cloud.aiplatform.v1.AutomaticResources]
446+
// * `required_replica_count` in
447+
// [DedicatedResources][google.cloud.aiplatform.v1.DedicatedResources]
436448
// * [autoscaling_metric_specs][google.cloud.aiplatform.v1.DedicatedResources.autoscaling_metric_specs]
437449
// * `disable_container_logging` (v1 only)
438450
// * `enable_container_logging` (v1beta1 only)

0 commit comments

Comments
 (0)