feat: Chrome OS Moblab API: add a new build label field to the Build resource proto

Google APIs · copybara-github · commit 53d620a8e243 · 2023-03-30T18:05:16.000-07:00
PiperOrigin-RevId: 520792552
diff --git a/google/chromeos/moblab/v1beta1/build_service.proto b/google/chromeos/moblab/v1beta1/build_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -38,7 +38,8 @@ service BuildService {
       "https://www.googleapis.com/auth/moblabapi";
 
   // Lists all build targets that a user has access to.
-  rpc ListBuildTargets(ListBuildTargetsRequest) returns (ListBuildTargetsResponse) {
+  rpc ListBuildTargets(ListBuildTargetsRequest)
+      returns (ListBuildTargetsResponse) {
     option (google.api.http) = {
       get: "/v1beta1/buildTargets"
     };
@@ -63,18 +64,21 @@ service BuildService {
 
   // Checks the stage status for a given build artifact in a partner Google
   // Cloud Storage bucket.
-  rpc CheckBuildStageStatus(CheckBuildStageStatusRequest) returns (CheckBuildStageStatusResponse) {
+  rpc CheckBuildStageStatus(CheckBuildStageStatusRequest)
+      returns (CheckBuildStageStatusResponse) {
     option (google.api.http) = {
       get: "/v1beta1/{name=buildTargets/*/models/*/builds/*/artifacts/*}:check"
     };
     option (google.api.method_signature) = "name";
   }
 
   // Stages a given build artifact from a internal Google Cloud Storage bucket
-  // to a partner Google Cloud Storage bucket. If any of objects has already
-  // been copied, it will overwrite the previous objects. Operation <response:
-  // [StageBuildResponse][google.chromeos.moblab.v1beta1.StageBuildResponse],
-  //            metadata: [StageBuildMetadata][google.chromeos.moblab.v1beta1.StageBuildMetadata]>
+  // to a partner Google Cloud Storage bucket. The stage will be skipped if all
+  // the objects in the partner bucket are the same as in the internal bucket.
+  // Operation
+  // <response:[StageBuildResponse][google.chromeos.moblab.v1beta1.StageBuildResponse],
+  //            metadata:
+  //           [StageBuildMetadata][google.chromeos.moblab.v1beta1.StageBuildMetadata]>
   rpc StageBuild(StageBuildRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v1beta1/{name=buildTargets/*/models/*/builds/*/artifacts/*}:stage"
@@ -88,7 +92,7 @@ service BuildService {
   }
 
   // Finds the most stable build for the given build target. The definition of
-  // the most stable build is determined by evaluating the following rules in
+  // the most stable build is determined by evaluating the following rule in
   // order until one is true. If none are true, then there is no stable build
   // and it will return an empty response.
   //
@@ -99,7 +103,8 @@ service BuildService {
   //   4. Most recent stable channel build with build status Pass
   //   5. Most recent beta channel build with build status Pass
   //   6. Most recent dev channel build with build status Pass
-  rpc FindMostStableBuild(FindMostStableBuildRequest) returns (FindMostStableBuildResponse) {
+  rpc FindMostStableBuild(FindMostStableBuildRequest)
+      returns (FindMostStableBuildResponse) {
     option (google.api.http) = {
       get: "/v1beta1/{build_target=buildTargets/*}:findMostStableBuild"
     };
@@ -108,6 +113,7 @@ service BuildService {
 }
 
 // Request message for finding the most stable build.
+// -- NEXT_TAG: 2 --
 message FindMostStableBuildRequest {
   // Required. The full resource name of the build target.
   // For example,
@@ -121,22 +127,25 @@ message FindMostStableBuildRequest {
 }
 
 // Response message for finding the most stable build.
+// -- NEXT_TAG: 2 --
 message FindMostStableBuildResponse {
   // The most stable build.
   Build build = 1;
 }
 
 // Request message for listing build targets.
+// -- NEXT_TAG: 3 --
 message ListBuildTargetsRequest {
   // Optional. The number of build targets to return in a page.
   int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. A page token, received from a previous `ListBuildTargets` call. Provide
-  // this to retrieve the subsequent page.
+  // Optional. A page token, received from a previous `ListBuildTargets` call.
+  // Provide this to retrieve the subsequent page.
   string page_token = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for listing build targets.
+// -- NEXT_TAG: 4 --
 message ListBuildTargetsResponse {
   // The list of build targets.
   repeated BuildTarget build_targets = 1;
@@ -150,6 +159,7 @@ message ListBuildTargetsResponse {
 }
 
 // Request message for listing models.
+// -- NEXT_TAG: 4 --
 message ListModelsRequest {
   // Required. The full resource name of build target.
   string parent = 1 [
@@ -168,6 +178,7 @@ message ListModelsRequest {
 }
 
 // Response message for listing models.
+// -- NEXT_TAG: 4 --
 message ListModelsResponse {
   // The list of models.
   repeated Model models = 1;
@@ -181,6 +192,7 @@ message ListModelsResponse {
 }
 
 // Request message for listing builds.
+// -- NEXT_TAG: 7 --
 message ListBuildsRequest {
   // Required. The full resource name of the model. The model id is the same as
   // the build target id for non-unified builds.
@@ -196,30 +208,32 @@ message ListBuildsRequest {
   // Optional. The number of builds to return in a page.
   int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. A page token, received from a previous `ListBuilds` call. Provide this to
-  // retrieve the subsequent page.
+  // Optional. A page token, received from a previous `ListBuilds` call. Provide
+  // this to retrieve the subsequent page.
   string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. Filter that specifies value constraints of fields. For example, the
-  // filter can be set as "filter='milestone=milestones/80'" to only select
+  // Optional. Filter that specifies value constraints of fields. For example,
+  // the filter can be set as "filter='milestone=milestones/80'" to only select
   // builds in milestone 80.
   string filter = 4 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. Read mask that specifies which Build fields to return. If empty, all Build
-  // fields will be returned.
-  // Valid fields: name, milestone, build_version.
-  // For example, if the read_mask is set as "read_mask='milestone'", the
-  // ListBuilds will return a list of Builds object with only the milestone
-  // field.
-  google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL];
-
-  // Optional. The operation that groups by all the Build fields specified in the read
-  // mask. The group_by field should be the same as the read_mask field in
-  // convention of SQL.
-  google.protobuf.FieldMask group_by = 6 [(google.api.field_behavior) = OPTIONAL];
+  // Optional. Read mask that specifies which Build fields to return. If empty,
+  // all Build fields will be returned. Valid fields: name, milestone,
+  // build_version. For example, if the read_mask is set as
+  // "read_mask='milestone'", the ListBuilds will return a list of Builds object
+  // with only the milestone field.
+  google.protobuf.FieldMask read_mask = 5
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The operation that groups by all the Build fields specified in
+  // the read mask. The group_by field should be the same as the read_mask field
+  // in convention of SQL.
+  google.protobuf.FieldMask group_by = 6
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for listing builds.
+// -- NEXT_TAG: 4 --
 message ListBuildsResponse {
   // The list of builds.
   repeated Build builds = 1;
@@ -233,6 +247,7 @@ message ListBuildsResponse {
 }
 
 // Request message for checking if the build artifact is staged.
+// -- NEXT_TAG: 3 --
 message CheckBuildStageStatusRequest {
   // Required. The full resource name of the build artifact.
   // For example,
@@ -244,13 +259,14 @@ message CheckBuildStageStatusRequest {
     }
   ];
 
-  // Optional. Filter that specifies value constraints of fields. For example, the
-  // filter can be set as "filter='type=release'" to only check the release
+  // Optional. Filter that specifies value constraints of fields. For example,
+  // the filter can be set as "filter='type=release'" to only check the release
   // builds.
   string filter = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for checking the stage status of a build artifact.
+// -- NEXT_TAG: 4 --
 message CheckBuildStageStatusResponse {
   // The status to represent if the build is staged or not.
   bool is_build_staged = 1;
@@ -263,6 +279,7 @@ message CheckBuildStageStatusResponse {
 }
 
 // Request message for staging a build artifact.
+// -- NEXT_TAG: 3 --
 message StageBuildRequest {
   // Required. The full resource name of the build artifact.
   // For example,
@@ -274,19 +291,21 @@ message StageBuildRequest {
     }
   ];
 
-  // Optional. Filter that specifies value constraints of fields. For example, the
-  // filter can be set as "filter='type=release'" to only check the release
+  // Optional. Filter that specifies value constraints of fields. For example,
+  // the filter can be set as "filter='type=release'" to only check the release
   // builds.
   string filter = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for staging a build artifact.
+// -- NEXT_TAG: 2 --
 message StageBuildResponse {
   // The staged build in the destination bucket.
   BuildArtifact staged_build_artifact = 1;
 }
 
 // Metadata message for staging a build artifact.
+// -- NEXT_TAG: 4 --
 message StageBuildMetadata {
   // Approximate percentage of progress, e.g. "50" means 50%.
   float progress_percent = 1;
diff --git a/google/chromeos/moblab/v1beta1/chromeosmoblab_v1beta1.yaml b/google/chromeos/moblab/v1beta1/chromeosmoblab_v1beta1.yaml
@@ -12,7 +12,7 @@ apis:
 backend:
   rules:
   - selector: 'google.chromeos.moblab.v1beta1.BuildService.*'
-    deadline: 10.0
+    deadline: 30.0
 
 documentation:
   summary: |-
diff --git a/google/chromeos/moblab/v1beta1/resources.proto b/google/chromeos/moblab/v1beta1/resources.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@ option java_package = "com.google.chromeos.moblab.v1beta1";
 option optimize_for = SPEED;
 
 // Resource that represents a build target.
+// -- NEXT_TAG: 2 --
 message BuildTarget {
   option (google.api.resource) = {
     type: "chromeosmoblab.googleapis.com/BuildTarget"
@@ -38,6 +39,7 @@ message BuildTarget {
 
 // Resource that represents a model. Each model belongs to a build target. For
 // non-unified build, the model name is the same as its build target name.
+// -- NEXT_TAG: 2 --
 message Model {
   option (google.api.resource) = {
     type: "chromeosmoblab.googleapis.com/Model"
@@ -50,6 +52,7 @@ message Model {
 }
 
 // Resource that represents a chrome OS milestone.
+// -- NEXT_TAG: 2 --
 message Milestone {
   option (google.api.resource) = {
     type: "chromeosmoblab.googleapis.com/Milestone"
@@ -63,6 +66,7 @@ message Milestone {
 
 // Resource that represents a build for the given build target, model, milestone
 // and build version.
+// -- NEXT_TAG: 9 --
 message Build {
   option (google.api.resource) = {
     type: "chromeosmoblab.googleapis.com/Build"
@@ -122,13 +126,17 @@ message Build {
   // The branch of the build.
   string branch = 6;
 
-  // The read write firmware version of the software that is flashed to the chip
-  // on the Chrome OS device.
+  // The firmware version of the software that is flashed to the chip on the
+  // Chrome OS device.
   string rw_firmware_version = 7;
+
+  // The labels of the build.
+  repeated string labels = 8;
 }
 
 // Resource that represents a build artifact stored in Google Cloud Storage for
 // the given build target, model, build version and bucket.
+// -- NEXT_TAG: 6 --
 message BuildArtifact {
   option (google.api.resource) = {
     type: "chromeosmoblab.googleapis.com/BuildArtifact"
