Skip to content

Commit e468628

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

File tree

3 files changed

+71
-3
lines changed

3 files changed

+71
-3
lines changed

google/cloud/aiplatform/v1beta1/BUILD.bazel

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ proto_library(
5252
"deployed_model_ref.proto",
5353
"deployment_resource_pool.proto",
5454
"deployment_resource_pool_service.proto",
55+
"deployment_stage.proto",
5556
"encryption_spec.proto",
5657
"endpoint.proto",
5758
"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.v1beta1;
18+
19+
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
20+
option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
21+
option java_multiple_files = true;
22+
option java_outer_classname = "DeploymentStageProto";
23+
option java_package = "com.google.cloud.aiplatform.v1beta1";
24+
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
25+
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
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/v1beta1/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/v1beta1/deployment_stage.proto";
2324
import "google/cloud/aiplatform/v1beta1/endpoint.proto";
2425
import "google/cloud/aiplatform/v1beta1/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) = {
@@ -217,6 +218,11 @@ message CreateEndpointRequest {
217218
message CreateEndpointOperationMetadata {
218219
// The operation generic information.
219220
GenericOperationMetadata generic_metadata = 1;
221+
222+
// Output only. The deployment stage of the model. Only populated if this
223+
// CreateEndpoint request deploys a model at the same time.
224+
DeploymentStage deployment_stage = 2
225+
[(google.api.field_behavior) = OUTPUT_ONLY];
220226
}
221227

222228
// Request message for
@@ -385,6 +391,10 @@ message DeployModelResponse {
385391
message DeployModelOperationMetadata {
386392
// The operation generic information.
387393
GenericOperationMetadata generic_metadata = 1;
394+
395+
// Output only. The deployment stage of the model.
396+
DeploymentStage deployment_stage = 2
397+
[(google.api.field_behavior) = OUTPUT_ONLY];
388398
}
389399

390400
// Request message for
@@ -483,6 +493,8 @@ message MutateDeployedModelRequest {
483493
// * `max_replica_count` in either
484494
// [DedicatedResources][google.cloud.aiplatform.v1beta1.DedicatedResources] or
485495
// [AutomaticResources][google.cloud.aiplatform.v1beta1.AutomaticResources]
496+
// * `required_replica_count` in
497+
// [DedicatedResources][google.cloud.aiplatform.v1beta1.DedicatedResources]
486498
// * [autoscaling_metric_specs][google.cloud.aiplatform.v1beta1.DedicatedResources.autoscaling_metric_specs]
487499
// * `disable_container_logging` (v1 only)
488500
// * `enable_container_logging` (v1beta1 only)

0 commit comments

Comments
 (0)