src/policy_manager/imgstatus/reporter.go

// Copyright 2021 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.

// Package imgstatus implements the library for Spiny to report the status for
// the image it's running on.
package imgstatus

import "policy_manager/policymanagerproto"

// Reporter is the generic interface for getting the current status.
type Reporter interface {
	// GetStatus returns the current status encoded in a protobuf.
	GetStatus() (status *policymanagerproto.InstanceStatus, err error)

	// GetOSVersion returns the currently running OS Version.
	GetOSVersion() (version *policymanagerproto.OSVersion, err error)
}