feat: add new ReportVmInventory endpoint along with new request and response messages

Google APIs · copybara-github · commit 46c183b2652a · 2026-01-29T01:25:11.000-08:00
docs: A comment for message `Inventory` is changed
docs: A comment for field `enforce` in message `.google.cloud.osconfig.agentendpoint.v1.OSPolicy` is changed
docs: A comment for service `AgentEndpointService` is changed
docs: A comment for message `OSPolicyResourceConfigStep` is changed
docs: A comment for message `OSPolicy` is changed
docs: A comment for message `PatchConfig` is changed
docs: A comment for enum `TaskDirective` is changed
docs: A comment for message `ExecResource` in message `.google.cloud.osconfig.agentendpoint.v1.OSPolicy` is changed
docs: A comment for field `DEFINITION` in enum `Classification` is changed
docs: A comment for field `DESIRED_STATE_ENFORCEMENT` in enum `Type` is changed
docs: A comment for field `DESIRED_STATE_CHECK_POST_ENFORCEMENT` in enum `Type` is changed

PiperOrigin-RevId: 862617642
diff --git a/google/cloud/osconfig/agentendpoint/v1/BUILD.bazel b/google/cloud/osconfig/agentendpoint/v1/BUILD.bazel
@@ -9,14 +9,17 @@
 #    * extra_protoc_file_parameters
 # The complete list of preserved parameters can be found in the source code.
 
+# buildifier: disable=load-on-top
+
 # This is an API workspace, having public visibility by default makes perfect sense.
 package(default_visibility = ["//visibility:public"])
 
 ##############################################################################
 # Common
 ##############################################################################
-load("@rules_proto//proto:defs.bzl", "proto_library")
+# buildifier: disable=same-origin-load
 load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
+load("@rules_proto//proto:defs.bzl", "proto_library")
 
 proto_library(
     name = "agentendpoint_proto",
@@ -27,13 +30,16 @@ proto_library(
         "os_policy.proto",
         "patch_jobs.proto",
         "tasks.proto",
+        "vm_inventory.proto",
     ],
     deps = [
         "//google/api:annotations_proto",
         "//google/api:client_proto",
         "//google/api:field_behavior_proto",
         "//google/api:resource_proto",
+        "//google/longrunning:operations_proto",
         "//google/type:date_proto",
+        "@com_google_protobuf//:struct_proto",
         "@com_google_protobuf//:timestamp_proto",
     ],
 )
@@ -49,6 +55,7 @@ proto_library_with_info(
 ##############################################################################
 # Java
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "java_gapic_assembly_gradle_pkg",
@@ -72,6 +79,7 @@ java_grpc_library(
 java_gapic_library(
     name = "agentendpoint_java_gapic",
     srcs = [":agentendpoint_proto_with_info"],
+    gapic_yaml = None,
     grpc_service_config = "agentendpoint_grpc_service_config.json",
     rest_numeric_enums = True,
     service_yaml = "osconfig_v1.yaml",
@@ -109,6 +117,7 @@ java_gapic_assembly_gradle_pkg(
 ##############################################################################
 # Go
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "go_gapic_assembly_pkg",
@@ -122,6 +131,7 @@ go_grpc_library(
     protos = [":agentendpoint_proto"],
     deps = [
         "//google/api:annotations_go_proto",
+        "//google/longrunning:longrunning_go_proto",
         "//google/type:date_go_proto",
     ],
 )
@@ -138,6 +148,10 @@ go_gapic_library(
     transport = "grpc+rest",
     deps = [
         ":agentendpoint_go_proto",
+        "//google/longrunning:longrunning_go_proto",
+        "@com_google_cloud_go_longrunning//:go_default_library",
+        "@com_google_cloud_go_longrunning//autogen:go_default_library",
+        "@io_bazel_rules_go//proto/wkt:struct_go_proto",
     ],
 )
 
@@ -156,6 +170,7 @@ go_gapic_assembly_pkg(
 ##############################################################################
 # Python
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "py_gapic_assembly_pkg",
@@ -170,6 +185,8 @@ py_gapic_library(
     rest_numeric_enums = True,
     service_yaml = "osconfig_v1.yaml",
     transport = "grpc",
+    deps = [
+    ],
 )
 
 py_test(
@@ -193,6 +210,7 @@ py_gapic_assembly_pkg(
 ##############################################################################
 # PHP
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "php_gapic_assembly_pkg",
@@ -209,10 +227,13 @@ php_gapic_library(
     name = "agentendpoint_php_gapic",
     srcs = [":agentendpoint_proto_with_info"],
     grpc_service_config = "agentendpoint_grpc_service_config.json",
+    migration_mode = "PRE_MIGRATION_SURFACE_ONLY",
     rest_numeric_enums = True,
     service_yaml = "osconfig_v1.yaml",
     transport = "grpc+rest",
-    deps = [":agentendpoint_php_proto"],
+    deps = [
+        ":agentendpoint_php_proto",
+    ],
 )
 
 # Open Source Packages
@@ -227,6 +248,7 @@ php_gapic_assembly_pkg(
 ##############################################################################
 # Node.js
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "nodejs_gapic_assembly_pkg",
@@ -257,6 +279,7 @@ nodejs_gapic_assembly_pkg(
 ##############################################################################
 # Ruby
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "ruby_cloud_gapic_library",
@@ -303,6 +326,7 @@ ruby_gapic_assembly_pkg(
 ##############################################################################
 # C#
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "csharp_gapic_assembly_pkg",
@@ -313,6 +337,7 @@ load(
 
 csharp_proto_library(
     name = "agentendpoint_csharp_proto",
+    extra_opts = [],
     deps = [":agentendpoint_proto"],
 )
 
@@ -349,6 +374,7 @@ csharp_gapic_assembly_pkg(
 ##############################################################################
 # C++
 ##############################################################################
+# buildifier: disable=same-origin-load
 load(
     "@com_google_googleapis_imports//:imports.bzl",
     "cc_grpc_library",
diff --git a/google/cloud/osconfig/agentendpoint/v1/agentendpoint.proto b/google/cloud/osconfig/agentendpoint/v1/agentendpoint.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@ import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/cloud/osconfig/agentendpoint/v1/inventory.proto";
 import "google/cloud/osconfig/agentendpoint/v1/tasks.proto";
+import "google/cloud/osconfig/agentendpoint/v1/vm_inventory.proto";
 
 option go_package = "cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb;agentendpointpb";
 option java_multiple_files = true;
@@ -69,6 +70,13 @@ service AgentEndpointService {
     option (google.api.method_signature) =
         "instance_id_token,inventory_checksum,inventory";
   }
+
+  // Reports the VMs current inventory.
+  rpc ReportVmInventory(ReportVmInventoryRequest)
+      returns (ReportVmInventoryResponse) {
+    option (google.api.method_signature) =
+        "instance_id_token,inventory_checksum,vm_inventory";
+  }
 }
 
 // A request message to receive task notifications.
@@ -236,3 +244,27 @@ message ReportInventoryResponse {
   // If true, the full inventory should be reported back to the server.
   bool report_full_inventory = 1;
 }
+
+// The request message for reporting the agent's VM inventory.
+message ReportVmInventoryRequest {
+  // Required. This is the Compute Engine instance identity token described in
+  // https://cloud.google.com/compute/docs/instances/verifying-instance-identity
+  // where the audience is 'osconfig.googleapis.com' and the format is 'full'.
+  string instance_id_token = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. This is a client created checksum that should be generated based
+  // on the contents of the reported inventory. This will be used by the service
+  // to determine if it has the latest version of inventory.
+  string inventory_checksum = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. This is the details of the VM inventory. Should only be provided
+  // if the inventory has changed since the last report, or if instructed by the
+  // service to provide full inventory.
+  VmInventory vm_inventory = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// The response message after the agent has reported VM inventory.
+message ReportVmInventoryResponse {
+  // If true, the full inventory should be reported back to the server.
+  bool report_full_inventory = 1;
+}
diff --git a/google/cloud/osconfig/agentendpoint/v1/config_common.proto b/google/cloud/osconfig/agentendpoint/v1/config_common.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -35,10 +35,10 @@ message OSPolicyResourceConfigStep {
     // Check the current desired state status of the resource.
     DESIRED_STATE_CHECK = 2;
 
-    // Enforce the desired state for a resource that is not in desired state.
+    // Apply the desired state for a resource that is not in desired state.
     DESIRED_STATE_ENFORCEMENT = 3;
 
-    // Re-check desired state status for a resource after enforcement of all
+    // Re-check desired state status for a resource after applying all
     // resources in the current configuration run.
     //
     // This step is used to determine the final desired state status for the
diff --git a/google/cloud/osconfig/agentendpoint/v1/inventory.proto b/google/cloud/osconfig/agentendpoint/v1/inventory.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -111,7 +111,7 @@ message Inventory {
   // Information related to the a standard versioned package.  This includes
   // package info for APT, Yum, Zypper, and Googet package managers.
   message VersionedPackage {
-    // Information related to the actuall source of the versioned package. This
+    // Information related to the actual source of the versioned package. This
     // includes source package name and version if available.
     message Source {
       // Required. The name of the source package.
diff --git a/google/cloud/osconfig/agentendpoint/v1/os_policy.proto b/google/cloud/osconfig/agentendpoint/v1/os_policy.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -307,7 +307,7 @@ message OSPolicy {
       }
     }
 
-    // A resource that contains custom validation and enforcement steps.
+    // A resource that contains custom validation and execution steps.
     message ExecResource {
       // A file or script to execute.
       message Exec {
@@ -362,7 +362,7 @@ message OSPolicy {
       Exec validate = 1 [(google.api.field_behavior) = REQUIRED];
 
       // What to run to bring this resource into the desired state.
-      // A exit code of 100 indicates "success", any other exit code idicates a
+      // A exit code of 100 indicates "success", any other exit code indicates a
       // failure running enforce.
       Exec enforce = 2;
     }
diff --git a/google/cloud/osconfig/agentendpoint/v1/patch_jobs.proto b/google/cloud/osconfig/agentendpoint/v1/patch_jobs.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -176,7 +176,7 @@ message WindowsUpdateSettings {
 
     // "A widely released and frequent software update that contains additions
     // to a product’s definition database. Definition databases are often used
-    // to detect objects that have specific attributes, such as malicious code,
+    // to detect objects that have specific attributes, such as harmful code,
     // phishing websites, or junk mail." [1]
     DEFINITION = 3;
 
diff --git a/google/cloud/osconfig/agentendpoint/v1/tasks.proto b/google/cloud/osconfig/agentendpoint/v1/tasks.proto
@@ -1,4 +1,4 @@
-// Copyright 2025 Google LLC
+// Copyright 2026 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/cloud/osconfig/agentendpoint/v1/vm_inventory.proto b/google/cloud/osconfig/agentendpoint/v1/vm_inventory.proto
@@ -0,0 +1,95 @@
+// Copyright 2026 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.osconfig.agentendpoint.v1;
+
+import "google/api/field_behavior.proto";
+import "google/protobuf/struct.proto";
+
+option go_package = "cloud.google.com/go/osconfig/agentendpoint/apiv1/agentendpointpb;agentendpointpb";
+option java_multiple_files = true;
+option java_outer_classname = "VmInventoryProto";
+option java_package = "com.google.cloud.osconfig.agentendpoint.v1";
+
+// OS Config VM Inventory is a service for collecting and reporting operating
+// system and package information on VM instances.
+
+// The inventory details of a VM.
+message VmInventory {
+  // Operating system information for the VM.
+  message OsInfo {
+    // Required. The VM hostname.
+    string host_name = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. The operating system long name.
+    // For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019
+    // Datacenter'.
+    string long_name = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Required. The operating system short name.
+    // For example, 'windows' or 'debian'.
+    string short_name = 3 [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. The version of the operating system.
+    string version = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Required. The system architecture of the operating system.
+    string architecture = 5 [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. The kernel version of the operating system.
+    string kernel_version = 6 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The kernel release of the operating system.
+    string kernel_release = 7 [(google.api.field_behavior) = OPTIONAL];
+
+    // Required. The current version of the OS Config agent running on the VM.
+    string osconfig_agent_version = 8 [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // A VM package representation.
+  message InventoryItem {
+    // Required. Human-readable name of the software, to show to the user.
+    string name = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. Package type, e.g. "java/maven", "javascript/npm", "os/dpkg"
+    string type = 2 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. Version of the package.
+    string version = 3 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. Purl is a package identifier.
+    string purl = 4 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. Path or source of files related to the package.
+    repeated string location = 5 [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. Metadata of the package extracted by extractor.
+    google.protobuf.Struct metadata = 6
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Required. Base level operating system information for the VM.
+  OsInfo os_info = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. A list of installed packages currently on the VM.
+  repeated InventoryItem installed_packages = 2
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Required. A list of software updates available for the VM as reported by
+  // the update managers.
+  repeated InventoryItem available_packages = 3
+      [(google.api.field_behavior) = REQUIRED];
+}
diff --git a/google/cloud/osconfig/agentendpoint/v1beta/BUILD.bazel b/google/cloud/osconfig/agentendpoint/v1beta/BUILD.bazel
diff --git a/google/cloud/osconfig/v1/BUILD.bazel b/google/cloud/osconfig/v1/BUILD.bazel
diff --git a/google/cloud/osconfig/v1alpha/BUILD.bazel b/google/cloud/osconfig/v1alpha/BUILD.bazel
diff --git a/google/cloud/osconfig/v1beta/BUILD.bazel b/google/cloud/osconfig/v1beta/BUILD.bazel

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright 2025 Google LLC`
	`1`	`+// Copyright 2026 Google LLC`
`2`	`2`	`//`
`3`	`3`	`// Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`// you may not use this file except in compliance with the License.`